LinuxCommandLibrary

ibmcloud-config

Configure IBM Cloud CLI settings

TLDR

Set HTTP request timeout to 30 seconds

$ ibmcloud config --http-timeout 30
copy

Enable trace output for HTTP requests
$ ibmcloud config --trace true
copy

Trace HTTP requests to a specific file
$ ibmcloud config --trace [path/to/trace_file]
copy

Disable color output
$ ibmcloud config --color false
copy

Set the locale to a specific language
$ ibmcloud config --locale [zh_Hans]
copy

Enable automatic SSO one-time passcode acceptance
$ ibmcloud config --sso-otp auto
copy

SYNOPSIS

ibmcloud-config [--global] [--local] [--list] [--get <key>] [--set <key>=<value>] [--unset <key>...] [--clear]

PARAMETERS

--clear
    Clears all configuration values in the selected scope

--get <key>
    Retrieves the value of the specified config key

--global
    Uses the global config directory instead of local

--list
    Lists all current configuration key-value pairs

--local
    Uses the local config directory (default)

--set <key>=<value>
    Sets a config key to the given value (repeatable)

--unset <key>...
    Removes one or more config keys

DESCRIPTION

The ibmcloud-config command (also invoked as ibmcloud config) provides low-level management for the IBM Cloud Command Line Interface (CLI) configuration. It allows users to list, retrieve, set, unset, or clear configuration values stored in JSON files, typically in ~/.ibmcloud/config.json (local) or a global directory.

This is crucial for automating workflows, switching between accounts, regions, or API endpoints without re-logging in. For example, developers can script config changes for CI/CD pipelines or manage multiple profiles. By default, it operates on the local config, but flags enable global scope.

Configuration keys include account, api, region, resource_group, and login tokens. Changes take effect immediately for subsequent ibmcloud commands. It's part of the IBM Cloud CLI ecosystem, essential for hybrid cloud operations on Linux, macOS, and Windows.

CAVEATS

Changes only affect the chosen scope (global/local); some commands like ibmcloud login or ibmcloud target may override settings. Config files are JSON—manual edits risk corruption. Requires IBM Cloud CLI installed.

COMMON CONFIG KEYS

account: Current account ID
api: Cloud API endpoint
region: Default region (e.g., us-south)
resource_group: Default resource group
containerRegistry: Container registry URL

CONFIG LOCATIONS

Local: $HOME/.ibmcloud/config.json
Global: $XDG_CONFIG_HOME/ibmcloud/config.json or /etc/ibmcloud/config.json

HISTORY

Introduced in IBM Cloud CLI v0.11.0 (2018) as part of transition from Bluemix CLI (bx). Enhanced in v1.x for better multi-account support and OpenWhisk integration. Now at v3+ with Kubernetes and VPC focus.

SEE ALSO

Copied to clipboard