> ## 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.

# Overview

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

# CloudX CLI

The `cloudx` CLI provides command-line access to CloudX authentication, auction inspection, configuration, reporting, and documentation workflows.

Install instructions are available on the [Installation](/en/cli/installation) page.

<img src="https://mintcdn.com/cloudx-928dcb24/lauTnLtSAc2kfy_H/images/cli-demo.png?fit=max&auto=format&n=lauTnLtSAc2kfy_H&q=85&s=7f70ec770c10a22f26cef9d781816fba" alt="CLI dashboard report" width="1750" height="1104" data-path="images/cli-demo.png" />

<CardGroup cols={2}>
  <Card title="Installation" href="/en/cli/installation">
    Install the CLI on macOS with Homebrew.
  </Card>

  <Card title="Authentication" href="/en/cli/authentication">
    Sign in and manage sessions.
  </Card>

  <Card title="Reporting" href="/en/cli/reporting">
    Reporting commands and flags.
  </Card>

  <Card title="Auction Inspection" href="/en/cli/auction-inspection">
    Auction, round, bid, and ILRD inspection commands.
  </Card>

  <Card title="Configuration" href="/en/cli/configuration">
    Inspect, validate, edit, and publish configs.
  </Card>

  <Card title="Examples" href="/en/cli/examples">
    Copy-paste CLI examples.
  </Card>
</CardGroup>

## Root Usage

```bash theme={null}
cloudx [--timeout <duration>] [command]
cloudx --version
cloudx --help
```

## Root Flags

| Flag                   | Short | Description                                                                        |
| ---------------------- | ----- | ---------------------------------------------------------------------------------- |
| `--timeout <duration>` |       | API request timeout. Defaults to `1m`; maximum `2m`. Examples: `30s`, `90s`, `2m`. |
| `--version`            | `-v`  | Print the CloudX CLI version and exit.                                             |
| `--help`               |       | Show 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`. Impression-level exports download a gzip-compressed CSV file instead.
* Configuration commands print YAML by default and support JSON output with `--json`.
* Period parsing is UTC-based.