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.

List all configuration values.

Shows the effective configuration after applying precedence rules.

bk config list [flags]

Flags

Flag Description
--debug Log HTTP API traffic to stderr; bodies may contain sensitive data
--global Only show global (user) configuration
--local Only show local configuration
--org=STRING Organization slug for this invocation (overrides environment and configuration)

Examples

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

Get config

Get a configuration value.

Returns the effective value after applying precedence rules:

Environment variable > Local config (.bk.yaml) > User config (~/.config/bk.yaml) > Default

Valid keys:

selected_org Organization slug to use output_format Default output format (json, yaml, text) no_pager Disable pager for text output (true, false) quiet Suppress progress output (true, false) no_input Disable interactive prompts (true, false) pager Custom pager command experiments Enabled experiment flags credential_store Default credential store for tokens (auto, keyring, shm)

bk config get <key>

Arguments

Argument Description
<key> Configuration key to get

Flags

Flag Description
--debug Log HTTP API traffic to stderr; bodies may contain sensitive data
--org=STRING Organization slug for this invocation (overrides environment and configuration)

Examples

bk config get output_format
bk config get pager
bk config get credential_store

Set config

Set a configuration value.

Valid keys:

selected_org Organization slug to use output_format Default output format (json, yaml, text) no_pager Disable pager for text output (true, false) quiet Suppress progress output (true, false) no_input Disable interactive prompts (true, false) [user config only] pager Custom pager command [user config only] telemetry Enable anonymous usage telemetry (true, false) [user config only] credential_store Default credential store for tokens (auto, keyring, shm) [user config only]

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

Arguments

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

Flags

Flag Description
--debug Log HTTP API traffic to stderr; bodies may contain sensitive data
--local Save to local (.bk.yaml) instead of user config
--org=STRING Organization slug for this invocation (overrides environment and configuration)

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"

Pin token storage to /dev/shm (recommended for headless Linux dev hosts):

bk config set credential_store shm

Unset config

Remove a configuration value.

Remove a configuration value, reverting to default.

bk config unset <key> [flags]

Arguments

Argument Description
<key> Configuration key to unset

Flags

Flag Description
--debug Log HTTP API traffic to stderr; bodies may contain sensitive data
--local Unset from local (.bk.yaml) instead of user config
--org=STRING Organization slug for this invocation (overrides environment and configuration)

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