Docs/CLI/Commands

Commands reference

Every command, grouped by subject. --help is always available on each.

Every command supports --help, --env, and --output json|yaml|table. Commands that write also accept --idempotency-key.

Auth

CommandPurpose
wordcab loginBrowser or API-key login.
wordcab logoutDrop cached credentials.
wordcab whoamiIdentity + current environment.
wordcab pingEnd-to-end connectivity + auth test.
wordcab env list|set|show|configManage named environments.

Keys

bash
wordcab keys list
wordcab keys create --name transcription-worker --scope transcripts:write --expires 2026-12-31
wordcab keys revoke key_01HZ...

Transcribe

bash
wordcab transcribe call.wav --model qwen3-asr --diarize --out transcript.json
wordcab transcribe ./calls/ --concurrency 8 --format srt    # batch a directory
wordcab transcribe --url https://example.com/call.wav --language en
wordcab transcribe stream --device default --model voxtral-realtime   # live mic

Flags

  • --model · --language · --diarize · --word-timestamps · --redact pii,phi
  • --out PATH · --format json|srt|vtt|txt · --concurrency N
  • --webhook URL — fire transcript.completed to a URL for this job

Speech

bash
wordcab speech "Welcome to Contoso." --voice ember --out welcome.mp3
wordcab speech -f prompts.txt --voice slate --format wav --out-dir audio/
wordcab voices list --language en

Chat

bash
# One-shot
wordcab chat --model qwen3.5-4b "Summarize: $(cat transcript.txt)"

# Streaming (default)
wordcab chat --model qwen3.5-4b --system "Summarize calls in two sentences." < transcript.txt

# JSON output for scripts
wordcab chat --model qwen3.5-4b --messages-file conv.jsonl --output json

Agents

bash
wordcab agents list
wordcab agents create -f agent.yml
wordcab agents get agent_abc
wordcab agents update agent_abc --set llm_model=deepseek-v3.2
wordcab agents delete agent_abc

# agent.yml
# name: Support Agent
# system_prompt: |
#   You are a support agent for Contoso.
# voice_id: ember
# llm_model: qwen3.5-4b
# tools: [ ... ]

Calls

bash
wordcab calls list --agent agent_abc --status completed --since 24h
wordcab calls create --agent agent_abc --to +14155551234 --record
wordcab calls get call_abc123
wordcab calls end call_abc123
wordcab calls transcript call_abc123 --format srt

Gym (test suites & experiments)

bash
wordcab test-suites list
wordcab test-suites run --suite refunds --agent agent_abc --wait --fail-on-red
wordcab test-suites new --from-calls "status=completed,limit=50" --out suite.yml

wordcab experiments list
wordcab experiments create -f experiment.yml
wordcab experiments stop exp_01HZ...

Deploy (self-hosted)

bash
wordcab deploy plan   -f values.yml      # dry-run against the current cluster (kubectl context)
wordcab deploy apply  -f values.yml      # install or update
wordcab deploy status                    # pool health summary
wordcab deploy rollback --to rev 14      # rollback to a previous chart revision
wordcab deploy preflight                 # runs the preflight check suite
wordcab deploy bundle offline            # package an offline install tarball for airgap transfer
wordcab deploy support-bundle            # collect logs + config for a support ticket

Logs

bash
wordcab logs follow --agent agent_abc
wordcab logs follow --call call_abc123          # join deployment + call scope
wordcab logs query --since 1h --level error --service stt    # structured query

Webhooks

bash
wordcab webhooks list
wordcab webhooks create --url https://example.com/hooks --event call.completed --event transcript.completed
wordcab webhooks test wh_01HZ...          # send a signed test event
wordcab webhooks delete wh_01HZ...

Usage

bash
wordcab usage                                 # current month
wordcab usage --start 2026-04-01 --end 2026-04-15 --group-by day
wordcab usage --group-by key --output json

Misc

wordcab models listAvailable models in the current environment.
wordcab voices listVoices available to this key.
wordcab self-updateReplace the binary with the latest signed release.
wordcab completion bash|zsh|fishEmit shell completion scripts.
wordcab version --output jsonBinary version, commit, and server version (if reachable).