Skip to main content

CLI Reference

The wax CLI provides full control over your Waxell agents, governance, metrics, and configuration from the terminal.

Installation​

# Using pipx (recommended)
pipx install waxell-sdk

# Or using pip
pip install waxell-sdk

After installation, wax is available globally:

wax --version
wax --help

Commands Overview​

CommandDescription
wax loginAuthenticate with Waxell
wax pushDeploy an agent
wax agentsManage and monitor agents
wax runsView and manage execution runs
wax metricsView metrics with terminal charts
wax usageView usage and billing
wax policiesManage governance policies
wax kill-switchesManage emergency kill switches
wax budgetsManage resource budgets
wax configView and manage configuration
wax exportExport agent spec to JSON

Authentication​

wax login​

Authenticate with Waxell and save credentials.

# Production (default - waxell.dev)
wax login

# Local development server
wax login --local

# Custom API URL
wax login --url https://staging.waxell.dev

# Save to named profile
wax login --profile staging

Options:

  • --profile TEXT - Profile name to save credentials under
  • --local - Connect to local development server
  • --url TEXT - Custom API URL

Deployment​

wax push​

Deploy an agent to Waxell.

# Push by agent name (looks in ./app/)
wax push myagent

# Push by path
wax push ./app/myagent
wax push ./path/to/agent.py

# Dry run (preview without deploying)
wax push myagent --dry-run

Options:

  • --profile TEXT - Config profile to use
  • --dry-run - Show what would be pushed without actually pushing

Agent Management​

wax agents list​

List all agents in your tenant.

wax agents list
wax agents list --format json

wax agents logs​

View agent execution logs.

wax agents logs myagent
wax agents logs myagent --follow
wax agents logs myagent --tail 100

wax agents pause / wax agents resume​

Pause or resume agent execution.

wax agents pause myagent
wax agents resume myagent

Execution Runs​

wax runs list​

List execution runs.

wax runs list
wax runs list --agent myagent
wax runs list --status failed

wax runs inspect​

Inspect a specific run.

wax runs inspect run_abc123
wax runs inspect run_abc123 --format json

Metrics​

wax metrics​

View metrics with terminal charts.

# Default: 24 hours of data
wax metrics

# Specific time range
wax metrics --hours 168  # Last week

# Specific agent
wax metrics --agent myagent

Governance​

wax policies list​

List governance policies.

wax policies list
wax policies list --agent myagent

wax kill-switches list​

List kill switches.

wax kill-switches list

wax kill-switches activate​

Activate a kill switch (emergency stop).

wax kill-switches activate myagent --reason "Runaway costs"

Configuration​

wax config show​

Show current configuration.

wax config show
wax config show --profile staging

wax config set​

Set configuration values.

wax config set default_profile staging
wax config set api_url https://custom.waxell.dev

Export​

wax export​

Export agent specification to JSON.

wax export myagent
wax export myagent --output agent-spec.json

Environment Variables​

VariableDescription
WAX_API_KEYAPI key (overrides config)
WAX_API_URLAPI URL (overrides config)
WAX_PROFILEDefault profile name

Next Steps​