OverviewAndroidiOSUnityReact NativeFlutter (BETA)CLIAPIMCPDemandAd FormatsDashboardChangelog

Overview

Public reference for the CloudX CLI, including authentication, auction inspection, configuration, reporting, exports, and usage requirements.

CloudX CLI

The cloudx CLI provides command-line access to CloudX authentication, auction inspection, configuration, reporting, activity exports, and documentation 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.

Activity Exports

Create and download impression, request, and bid exports.

Auction Inspection

Auction, round, bid, and ILRD inspection commands.

Configuration

Inspect, validate, edit, and publish configs.

Examples

Copy-paste CLI examples.

Root Usage

cloudx [--timeout <duration>] [command]
cloudx --version
cloudx --help

Root Flags

FlagShortDescription
--timeout <duration>API request timeout. Defaults to 1m; maximum 2m. Examples: 30s, 90s, 2m.
--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.
  • API requests default to a 60 second timeout. Put --timeout before the command when you need a shorter or longer request budget.
  • Aggregate reporting and auction inspection commands support either human-readable table output or structured JSON with --json. Activity export commands download gzip-compressed CSV files instead.
  • Configuration commands print YAML by default and support JSON output with --json.
  • Period parsing is UTC-based.