Docs/CLI

CLI

The wordcab CLI: scriptable access to every API surface, plus operator commands for self-hosted deployments.

The wordcab CLI is a single static binary that talks to the same API as the SDKs, plus operator commands for driving self-hosted deployments. It is the right tool for scripts, CI, and the "just run it against the cluster" kind of work.

Physical deployment: the CLI ships with every install — cloud, VPC, on-prem, and airgap. In airgap environments it is bundled inside the signed offline tarball alongside the Helm chart. Use wordcab login --base-url https://wordcab.apps.example.com to point it at any self-hosted control plane.

Install

See installation for all options. Quickest:

bash
brew install wordcab/tap/wordcab        # macOS / Linux
npm install -g @wordcab/cli             # cross-platform via Node 18+
# or download the signed static binary from github.com/wordcab/cli/releases

First run

bash
wordcab login                         # opens a browser; caches credentials under ~/.wordcab/
wordcab ping                          # verifies auth and network path
wordcab transcribe call.wav --model qwen3-asr --diarize --out transcript.json

What it's good at

Voice

Transcription

Batch or stream a local file, a URL, or a directory. Outputs JSON, SRT, VTT, or plain text.

 Voice

Speech

Synthesize prompts, generate test audio for Gym suites, build IVR sound packs.

 Agents

Agents & calls

Create agents from YAML, place outbound calls, end live calls, stream logs.

 Operate

wordcab deploy

Install, upgrade, roll back, and inspect self-hosted deployments against any cluster your kubeconfig can reach.

 Observe

Logs & tail

Follow live logs from a deployment, a specific agent, or a single call id.

 Auth

Keys

Create, list, and revoke API keys. Rotate secrets without leaving the terminal.

Scripting friendly

Every command supports --output json and exits non-zero on error. Commands that produce structured data also support --output yaml and --output table. Use --quiet in CI to drop human-readable framing.

bash
agent_id=$(wordcab agents create -f agent.yml --output json | jq -r .id)
wordcab test-suites run --suite refunds --agent "$agent_id" --wait --fail-on-red