Buildkite CLI config command

The bk config command allows you to manage Buildkite CLI configurations from the command line.

Commands

Command Description
bk config list List configuration values.
bk config get Get a configuration value.
bk config set Set a configuration value.
bk config unset Remove a configuration value.

List configs

List configuration values.

bk config list [flags]

Flags

Flag Description
--debug Enable debug output for REST API calls
--global Only show global (user) configuration
--local Only show local configuration

Examples

bk config list
bk config list --local
bk config list --global

Get config

Get a configuration value.

bk config get <key>

Arguments

Argument Description
<key> Configuration key to get

Flags

Flag Description
--debug Enable debug output for REST API calls

Examples

bk config get output_format
bk config get pager

Set config

Set a configuration value.

bk config set <key> <value> [flags]

Arguments

Argument Description
<key> Configuration key to set
<value> Value to set

Flags

Flag Description
--debug Enable debug output for REST API calls
--local Save to local (.bk.yaml) instead of user config

Examples

Set default output format to YAML:

bk config set output_format yaml

Disable pager globally:

bk config set no_pager true

Set repo-specific output format:

bk config set output_format text --local

Set a custom pager:

bk config set pager "less -RS"

Unset config

Remove a configuration value.

bk config unset <key> [flags]

Arguments

Argument Description
<key> Configuration key to unset

Flags

Flag Description
--debug Enable debug output for REST API calls
--local Unset from local (.bk.yaml) instead of user config

Examples

Reset output format to default (json):

bk config unset output_format

Remove repo-specific setting:

bk config unset output_format --local

Reset pager to default (less -R):

bk config unset pager