Skip to main content

Global flags

Available on every abc command.

FlagEnv varDefaultDescription
--addressABC_API_ADDRESShttps://api.abc-cluster.ioabc-cluster API endpoint
--access-tokenABC_API_TOKEN(unset)abc-cluster access token
--workspaceABC_WORKSPACE(user default)Workspace ID
--regionABC_REGION(unset)Sovereignty region (ZA / KE / MZ / …)
--namespaceABC_NAMESPACE(unset)Logical namespace within workspace
--orgABC_ORG(unset)Organization ID (multi-org)
--clusterABC_CLUSTER(unset)Target named cluster
--outputABC_CLI_OUTPUT_FORMATtableOutput format: table / json / yaml
-q / --quietABC_CLI_QUIETfalseSuppress informational stderr
--debug[=N]ABC_CLI_DEBUG0Write structured JSON debug log
--sudoABC_CLI_SUDOfalseCluster-admin elevation
--cloudABC_CLI_CLOUD_MODEfalseInfrastructure elevation
--expABC_CLI_EXP_MODEfalseEnable experimental features
--user <email>ABC_API_AS_USER(unset)Act on behalf of user (admin only)
(env only)ABC_CLI_CONTEXT(unset)One-shot override of active context
(env only)ABC_CLI_CONFIG_FILE~/.abc/config.yamlOverride config-file location
(env only)ABC_CLI_DISABLE_UPDATE_CHECK(unset)Silence update notifications
(env only)ABC_CLI_AUTOMATION(unset)=1 signals non-interactive automation context

The full env-var surface (~76 entries across ABC_API_*, ABC_CLI_*, ABC_<RESOURCE>, component overrides, debug/test namespace, vendor fallback, and subprocess injection) lives in Environment variables — that page is generated directly from the CLI's registry, so it cannot drift from the implementation.

Resolution precedence

For every variable the CLI consults, the resolver walks:

flag > ABC env > vendor env > active context config > default
  • flag — explicit --<name> on the command line
  • ABC env — the canonical ABC_* name in your shell (uses os.LookupEnv, so an explicit empty ABC_API_ADDRESS= overrides the context config)
  • vendor env — last-resort fallback for a handful of ABC vars with a vendor namesake (e.g. ABC_REGION falls back to NOMAD_REGION). Emits a one-time warning when no ABC context is configured.
  • active context — the value persisted under contexts.<name>.<key> in ~/.abc/config.yaml
  • default — registry-declared default (or empty)

Use abc admin env show <NAME> to see which source won for any variable in your current shell.

Elevation tiers

TierFlagScope
Standard(none)Researcher operations
Sudo--sudoCluster-admin write ops, node management
Cloud--cloudInfrastructure, accounting, compliance

Debug logging

--debug (or ABC_CLI_DEBUG=1) writes a structured JSON log to stderr. --debug=2 adds verbose HTTP request/response traces.

Active context

abc resolves the active context from, in order:

  1. ABC_CLI_CONTEXT env var
  2. active_context key in ~/.abc/config.yaml
  3. The default context (fallback)

Env-var introspection

Three operator commands surface the env-var surface live against your current shell + active context:

abc admin env list # group every canonical env var by bucket
abc admin env show ABC_API_TOKEN # full precedence walk for one variable
abc admin env validate # detect forbidden patterns, vendor leaks,
# and shadowed values

See admin env for details.