aexaex
Reference

CLI

Generated aex command-line reference.

CLI

Generated from aex --help.

aex — unified CLI for the aex platform (a thin pass-through over the SDK)

Usage:
  aex run --config <run.json> --<provider>-api-key K --api-key T [flags]
  aex run --model M --prompt P [--system S] [--mcp name=url ...] --<provider>-api-key K --api-key T [flags]
  aex status <session-id> --api-key T
  aex deliveries <session-id> --api-key T
  aex wait <session-id> [--timeout 8m] [--interval 2s] --api-key T
  aex events <session-id> [--follow] [--timeout 8m] --api-key T
  aex tail <session-id> [--json] [--filter <type|source>] [--logs] [--settle] [--timeout 8m] --api-key T
  aex inspect <session-id> [--json] [--filter <type|source>] [--logs] [--timeout 8m] --api-key T
  aex outputs <session-id> --api-key T
  aex download <session-id> [--only outputs|events|metadata] [--out path] --api-key T
  aex cancel <session-id> --api-key T
  aex delete <session-id> --api-key T
  aex delete-asset <assetId|hash> --api-key T
  aex runs [--limit N] [--since ISO] --api-key T      List the workspace's runs (newest first, JSON)
  aex sessions [--limit N] --api-key T      List the workspace's sessions (newest first, JSON)
  aex whoami --api-key T
  aex billing [--json] --api-key T          Show prepaid balance, month spend, and spend cap
  aex billing ledger [--limit N] --api-key T   Recent credit-ledger entries (newest first, JSON)
  aex billing upgrade pro|team --api-key T   Create a hosted checkout session and print its URL
  aex billing portal --api-key T             Create a hosted billing portal session and print its URL
  aex webhooks secret --api-key T           Reveal (create on first use) the webhook signing secret
  aex login --api-key T [--aex-url U]      Persist token + url (then other verbs need no --api-key)
  aex logout                                 Clear the stored token
  aex auth status                            Show the resolved config (token never printed)
  aex models list [--json]                   List models + default provider (no token needed)
  aex providers list [--json]                List providers + their models (no token needed)
  aex tools list [--json]                    List builtin tools (all default; no token needed)
  aex runtime-sizes list [--json]            List managed runtime presets (no token needed)
  aex --help

Common flags on every host subcommand:
  --api-key <token>         REQUIRED — aex SDK API key (workspace is derived from it)
  --aex-url <url>         Optional; defaults to https://api.aex.dev (local/staging/hosted plane)
  --debug                     Optional; print a redacted per-request trace to stderr (uploads nothing)

aex run flags:
  --provider <name>           Optional; one of: anthropic, deepseek, openai, gemini, mistral, openrouter, doubao, doubao-cn (default anthropic)
  --anthropic-api-key <key>    REQUIRED when --provider anthropic; never stored
  --deepseek-api-key <key>     REQUIRED when --provider deepseek; never stored
  --openai-api-key <key>       REQUIRED when --provider openai; never stored
  --gemini-api-key <key>       REQUIRED when --provider gemini; never stored
  --mistral-api-key <key>      REQUIRED when --provider mistral; never stored
  --openrouter-api-key <key>   REQUIRED when --provider openrouter; never stored
  --doubao-api-key <key>       REQUIRED when --provider doubao; never stored
  --doubao-cn-api-key <key>    REQUIRED when --provider doubao-cn; never stored
  --config <path>             Run-request JSON (mutually exclusive with the flat --model/--prompt flags)
  --model <model-id>          Provider model id (required in flat mode)
  --system @file | <text>     System message; @-prefix reads from file
  --prompt @file | <text>     User message; @-prefix reads from file (repeatable)
  --mcp name=url              MCP server entry (repeatable)
  --mcp-auth name=Hdr:Val     Auth header on the matching --mcp; routed into vaulted secrets (repeatable)
  --metadata key=value        Submission metadata entry (repeatable)
  --runtime-size <size>       managed runtime preset
  --run-timeout <dur>         Server-side run deadline (e.g. 1h, max 8h); distinct from --timeout
  --idempotency-key <key>     Optional; defaults to a fresh UUID
  --webhook <url>             Optional per-run callback URL (https); receives the terminal run.finished event
  --follow                    Poll events to stdout until the run terminates
  --timeout <dur>             With --follow: give up after this long (e.g. 8m, 30s, 500ms); exit code 3

On this page