Skip to main content

​
CloudX CLI

The cloudx CLI provides command-line access to CloudX authentication and reporting workflows. Install instructions are available on the Installation page. CLI dashboard report

Installation

Install the CLI on macOS with Homebrew.

Authentication

Sign in and manage sessions.

Reporting

Reporting commands and flags.

Examples

Copy-paste CLI examples.

​
Root Usage

cloudx [command]
cloudx --version
cloudx --help

​
Root Flags

FlagShortDescription
--version-vPrint the CloudX CLI version and exit.
--helpShow command help.

​
Exit Behavior

The CLI uses standard exit codes:
  • 0 for success, help output, and --version
  • 1 for invalid usage, missing configuration, authentication issues, and request errors
One notable exception is cloudx auth status:
  • It exits 0 when logged in
  • It exits 1 when logged out or when the current sign-in session can’t be used

​
Notes

  • The CLI is currently installed on macOS through Homebrew.
  • Reporting commands support either human-readable table output or structured JSON with --json.
  • Period parsing is UTC-based.