Config Command

The botbox config command lets you view and manage both global and local (project) configuration settings.

Viewing Configuration

• Show local project config:

botbox config

• Show global CLI config:

botbox config -g

Additional flags for botbox config and botbox config display:

• -f, --format — Output format (default, json, yaml)
• -k, --keys-only — Show only configuration keys
• -l, --local — Explicitly show local project config (default behavior)

Listing All Keys and Values

• List local config:

botbox config list

• List global config:

botbox config list -g

Getting and Setting Values

• Get a value:

botbox config get bot.name
botbox config get -g user.default_user

• Get a value for a script:

botbox config get bot.name --raw

--raw prints only the value with no label or formatting, which is what you want inside a shell substitution.

BOT_NAME=$(botbox config get bot.name --raw)

• Set a value:

botbox config set bot.name "My Bot"
botbox config set -g user.default_user "myuser"

Syncing Configuration

• Sync your config with actual cogs:

botbox config sync
botbox config sync --headless

--headless prints a plain text report of what changed instead of rendering the TUI.

Machine Readable Output

--format json and --format yaml make botbox config printable and pipeable.

botbox config --format json
botbox config -g --format json
botbox config --format json -k

See Headless Mode for using these in scripts and CI.

Common Keys

Local (project) keys:

• bot.name
• bot.description
• bot.command_prefix
• bot.author

Global (CLI) keys:

• cli.check_updates
• cli.auto_update
• user.default_user
• user.github_username
• display.scroll_enabled
• display.color_scheme
• defaults.command_prefix
• defaults.auto_git_init
• dev.editor

Next Steps

• Headless Mode
• Custom Cogs
• Environment Variables
• Troubleshooting