Skip to content

config

Configuration management commands for NDCLI. These commands help you view and modify NDCLI settings.

CommandDescription
config showDisplay current configuration
config set orgSet default organization
config set outputSet default output format
config set timezoneSet the timezone used for timestamps
config resetReset configuration to defaults

org, output and timezone are the only subcommands config set accepts. Every other setting — including auth.storage — is changed by editing config.yaml directly, or by setting the matching environment variable where one exists. See the Configuration Reference.


Display the current NDCLI configuration including all settings and their values.

Terminal window
ndcli config show

Shows:

  • Authentication settings (provider, domain, client ID)
  • Control plane host
  • Default organization
  • Output format preference
  • Auth storage settings
  • Config file location
Terminal window
ndcli config show

Set the default organization for all commands. This saves you from specifying --org on every command.

Terminal window
ndcli config set org [name]
ArgumentRequiredDescription
nameYesOrganization name to set as default
Terminal window
ndcli config set org my-company
ndcli config show
  • The organization must exist and you must have access to it
  • Use ndcli org list to see available organizations
  • Override per-command with the --org flag

Set the default output format for all commands.

Terminal window
ndcli config set output [format]
ArgumentRequiredDescription
formatYesOne of: table, simple, detailed, json
FormatDescription
tableTabular format, good for lists
simpleCompact bullet-point format
detailedRich Unicode box drawing (default)
jsonMachine-readable JSON
Terminal window
ndcli config set output json
ndcli config set output detailed

Set the timezone NDCLI uses when it renders timestamps and when it interprets timestamps you type without an explicit offset — such as the --at flag on ndcli run.

Terminal window
ndcli config set timezone [zone]
ArgumentRequiredDescription
zoneYesAn IANA timezone name, e.g. America/Sao_Paulo, Europe/Berlin, UTC

This writes the output.timezone key. With no timezone configured, NDCLI falls back to the system local timezone.

Terminal window
ndcli config set timezone America/Sao_Paulo
ndcli config set timezone UTC
  • Only display and input parsing are affected — the API always exchanges UTC.
  • A bare --at "2026-05-12 03:00" is read in this timezone; an RFC3339 value with an offset (2026-05-12T03:00:00Z) ignores it.

Reset the configuration file to default values. This removes custom settings.

Terminal window
ndcli config reset
Terminal window
ndcli config reset