ibmcloud-config

Configure IBM Cloud CLI settings

TLDR

Set HTTP request timeout to 30 seconds

$ ibmcloud config --http-timeout 30

Enable trace output for HTTP requests

$ ibmcloud config --trace true

Trace HTTP requests to a specific file

$ ibmcloud config --trace [path/to/trace_file]

Disable color output

$ ibmcloud config --color false

Set the locale to a specific language

$ ibmcloud config --locale [zh_Hans]

Enable automatic SSO one-time passcode acceptance

$ ibmcloud config --sso-otp auto

PARAMETERS

--list
    Lists all current configuration settings and their values.

--check-version <true|false>
    Enables or disables automatic checking for new CLI versions upon command execution.

--usage-data <true|false>
    Controls whether anonymous usage data is sent to IBM Cloud for product improvement.

--color <true|false>
    Enables or disables colored output in the terminal for better readability.

--locale <locale>
    Sets the language for CLI output and messages (e.g., `en_US`, `zh_CN`).

--trace <true|false|path>
    Activates debug tracing. Set to `true` to print trace to console, `false` to disable, or a file path to log to a specific file.

--http-timeout <seconds>
    Sets the maximum HTTP request timeout in seconds for API calls made by the CLI.

--private-endpoint-only <true|false>
    Forces the CLI to use only private network endpoints for connecting to IBM Cloud services.

--no-autologin <true|false>
    Prevents the CLI from automatically attempting to re-authenticate when an access token expires.

--cloud-metadata <true|false>
    Enables or disables the retrieval of cloud metadata, which can influence login behavior in specific IaaS environments.

--set-option <KEY> <VALUE>
    Sets a specific configuration option identified by `KEY` to the provided `VALUE`.

--unset-option <KEY>
    Removes a specified configuration option from the CLI settings.

--help
    Displays help information and usage details for the `ibmcloud config` command.

DESCRIPTION

The `ibmcloud config` command is a crucial utility within the IBM Cloud Command Line Interface (CLI) that allows users to manage and customize various operational aspects of the CLI.

It provides granular control over settings such as automatic version checking, usage data collection, output coloration, and locale preferences. Users can also configure advanced network settings like HTTP timeouts, enforce private endpoint usage, and control automatic re-authentication behavior.

This command is essential for tailoring the CLI experience to specific user preferences, security requirements, and network environments, ensuring efficient and secure interaction with IBM Cloud resources. By listing current settings, modifying specific options, or resetting configurations, `ibmcloud config` empowers developers and administrators to optimize their daily workflows and maintain compliance with organizational policies. It acts as the central hub for personalized CLI management, impacting subsequent command executions and overall user experience.

CAVEATS

Changes made with `ibmcloud config` are persistent across CLI sessions until explicitly modified again.

Some configuration options, such as `private-endpoint-only`, require specific network configurations to be effective.

Modifying advanced settings like `trace` or `http-timeout` without understanding their impact can affect debugging capabilities or command stability.

While `ibmcloud config` is the recommended way to manage settings, some options can be temporarily overridden by environment variables for specific command executions.

CONFIGURATION FILE LOCATION

The IBM Cloud CLI stores its configuration settings in a file, typically located at ~/.ibmcloud/config.json. While this file can be viewed, direct manual editing is generally discouraged. Users should rely on the `ibmcloud config` command to ensure proper format and validation of settings.

ENVIRONMENT VARIABLE OVERRIDES

Many CLI configuration options can be temporarily overridden or set via environment variables. This provides flexibility for scripting or specific session requirements without altering the persistent configuration file. For instance, setting `IBMCLOUD_TRACE` can activate tracing for a single command execution.

HISTORY

The `ibmcloud` CLI, along with its `config` subcommand, represents an evolution from the earlier `bluemix` CLI. As IBM Cloud expanded its services and capabilities, the CLI was refactored to provide a more unified and extensible platform. The `config` command has consistently provided essential user-level customization, but its range of options has grown over time to include more sophisticated networking and security settings, reflecting the increasing complexity and diverse requirements of modern cloud environments.