Documentation Index
Fetch the complete documentation index at: https://docs.cloudx.io/llms.txt
Use this file to discover all available pages before exploring further.
Configuration
The cloudx config commands inspect inventory configuration stored in CloudX.
Available commands:
cloudx config show for the live config, a published version, or a draft
cloudx config history for published config history and publish-time diff counts
cloudx config show
Shows a config as YAML by default.
Use this command when you need to review the exact inventory config that CloudX has stored for an account, compare a published version, or inspect a draft before publishing.
Usage
cloudx config show [flags]
Address Modes
By default, config show returns the live config.
Use only one address mode at a time:
| Mode | Description |
|---|
| No address flag | Show the live config. |
--id <config-id> | Show a specific config row by stable ID. Can address a published version or draft. |
--version <number> | Show a published version number within the account. |
--draft | Show the account draft. If multiple drafts exist, use --id instead. |
Flags
| Flag | Required | Default | Description |
|---|
--id | No | | Stable config row ID. |
--version | No | | Published config version number. Must be greater than 0. |
--draft | No | false | Show the current account draft. |
--with-metadata | No | false | Include config row metadata in the output. |
--json | No | false | Print structured JSON instead of the default YAML output. |
--scope | No | | Target scope. Supported value: account. |
--target | No | | Target account ID when --scope account is set. Available to internal CloudX accounts. |
Validation rules:
- Use only one of
--id, --version, or --draft.
--version must be greater than 0.
--scope must be account when set.
--target requires --scope account.
By default, the command prints the config YAML without row metadata:
Use --json to print only the raw config data as JSON:
cloudx config show --version 12 --json
Use --with-metadata when you need fields such as config ID, account ID, kind, version number, created time, creator metadata, YAML, and raw data:
cloudx config show --version 12 --with-metadata
cloudx config show --id cfg_123 --with-metadata --json
Examples
Show The Live Config
Show A Published Version
cloudx config show --version 12
Show A Config By ID
cloudx config show --id cfg_123
cloudx config show --draft --with-metadata
Show A Target Account Config
Internal CloudX accounts can target another account:
cloudx config show --scope account --target publisher-123 --version 12
cloudx config history
Lists config history rows as a table by default.
Use this command when you need to review recent config publishes, see who created each row, or check the precomputed publish-time diff counts for additions and deletions.
Usage
cloudx config history [flags]
Flags
| Flag | Required | Default | Description |
|---|
--since | No | | Only include configs created at or after this time. Supports RFC3339 timestamps or YYYY-MM-DD dates. |
--author | No | | Filter by creator user ID, email, or name substring. |
--include-drafts | No | false | Include config drafts. By default only published versions are returned. |
--json | No | false | Print structured JSON instead of the default table output. |
--scope | No | | Target scope. Supported value: account. |
--target | No | | Target account ID when --scope account is set. Available to internal CloudX accounts. |
Validation rules:
--since must be an RFC3339 timestamp or a YYYY-MM-DD date.
--scope must be account when set.
--target requires --scope account.
The default table includes the config ID, version number, kind, created time, author, diff summary, version label, and description.
Diff values are shown as +additions/-deletions, using the diff_additions and diff_deletions values computed when the config was published.
Use --json when scripts need the raw response fields:
cloudx config history --since 2026-05-01 --json
Examples
List Published Config History
List Recent Config Changes
cloudx config history --since 2026-05-01
Filter By Author
cloudx config history --author alice@example.com
Include Drafts
cloudx config history --include-drafts
List A Target Account’s Config History
Internal CloudX accounts can target another account:
cloudx config history --scope account --target publisher-123 --since 2026-05-01