RWX CLI Reference

RWX runs are configured using a YAML syntax. The rwx CLI tool is used to launch and execute RWX runs.

Usage:

rwx <command> [OPTIONS]

Global options

--format <format>

Output format: text or json. Defaults to text.

--json

Output JSON data to stdout. Equivalent to --format json.

--access-token <token>

The access token for RWX. Defaults to the value of the $RWX_ACCESS_TOKEN environment variable.

Commands

Execution:
  cancel            Cancel a run
  debug             Debug a task
  image             Manage OCI images
  retry             Retry a run or task
  run               Launch a run from a local RWX definitions file
  runs              Create and inspect runs
  sandbox           Run commands in persistent sandboxes
  ssh               Attach and connect to a running task
  tasks             Manage tasks

Outputs:
  artifacts         Manage task artifacts
  logs              Download logs for a task
  results           Get results for a run

API:
  concurrency-pools Inspect concurrency pools
  crons             Manage crons
  dispatch          Launch a run from a pre-configured RWX workflow
  vaults            Manage vaults, secrets, and vars

Definitions:
  lint              Lint RWX configuration files
  packages          Manage RWX packages
  resolve           Resolve and add versions for base images and RWX packages
  update            Update versions for base layers and RWX packages

Setup:
  completion        Generate the autocompletion script for the specified shell
  docs              Search and read RWX documentation
  help              Help about any command
  login             Authorize subsequent commands on this device with RWX Cloud
  lsp               LSP (Language Server Protocol) related commands
  mcp               MCP (Model Context Protocol) related commands
  skill             Agent skill related commands
  whoami            Outputs details about the access token in use