Dump Command

The dump command displays various configuration settings and information about godyl.

Syntax

godyl [flags] dump [auth|cache|config|defaults|env|platform|tools] [flags]

Description

The dump command provides a way to inspect godyl’s configuration, available tools, and system information. This can be helpful for debugging, understanding the current setup, or creating custom tool configurations.

Subcommands

Subcommand	Description
`defaults [default]...`	Display the default configuration settings
`env`	Display environment variables that affect the application
`platform`	Display information about the current platform
`tools [tools.yml\\|-]...`	Display information about available tools
`cache [name]`	Display information about the cache
`config [key]`	Display information about the configuration
`auth`	Display information about authentication tokens

Flags for `dump tools`

Examples

Display the default configuration embedded in the binary

Output the full embedded defaults:

godyl dump defaults

Select specific defaults:

godyl dump defaults linux default

Display environment variables

godyl dump env

Output will list all environment variables that affect godyl’s behavior.

Display a configuration setting

godyl dump config update.cleanup

Display platform information

godyl dump platform

Output will show details about your current platform, including OS, architecture, and other system information.

Display available tools embedded in the binary

godyl dump tools --embedded

Output will list the tools that are embedded in the godyl binary. This can be used as a starting point for creating custom tool configurations.

Display full tool information from the current `tools.yml` configuration

godyl dump tools --full

Output will show detailed information about each tool, including all available configuration options.

Display cache information

godyl dump cache

Display cache information for a specific item

godyl dump cache idelchi/envprof

Output will show details about the cache, including its location, size, and contents.

Practical Uses

Creating a Custom Tools Configuration

You can use the dump tools command to create a starting point for your own tools configuration:

godyl dump tools -e > my-tools.yml

This creates a YAML file containing all the embedded tools, which you can then modify according to your needs.

Installing Embedded Tools

You can use the dump tools command in combination with the install command to install all embedded tools:

godyl dump tools -e | godyl install - --output ~/.local/bin

or only specific tags:

godyl dump tools -e --tags docker | godyl install - --output ~/.local/bin

Generate a configuration file from the resolved configuration

godyl dump config > godyl.yml