Docs | Kash

The @kashdao/cli package ships the kash binary, a scripting-friendly client over the REST API. Use it for one-off queries, shell scripts, CI jobs, agent integrations and exploratory debugging. Trades placed with kash trade and kash redeem go through the public API, so they work on every market the API serves, including the Solana markets. The CLI is non-custodial: your funds stay in a self-custodial wallet you own, and ZeroID never holds custody of them.

npm install -g @kashdao/cli
# or: pnpm add -g @kashdao/cli

Requires Node.js 22 or later. Verify the install:

kash --version
kash --help

Configure

# Interactive setup: API key, verification, optional shell completion
kash setup

# Or non-interactively
kash setup --api-key kash_live_... --yes

# Or set fields one at a time
kash auth set-key kash_live_...
kash config set baseUrl https://api.kash.bot/v1

# Read it back
kash config show

Config lives at ~/.kash/config.json (written mode 0600) and supports named profiles (--profile <name>, kash config use <name>). For CI, use environment variables instead:

export KASH_API_KEY="kash_live_..."
export KASH_BASE_URL="https://api.kash.bot/v1"   # optional, this is the default

Variable	Overrides
`KASH_API_KEY`	the profile’s API key
`KASH_BASE_URL`	the API base URL
`KASH_API_VERSION`	the pinned API version (`YYYY-MM-DD`)
`KASH_PROFILE`	the active profile
`KASH_CONFIG`	the config file path

Environment variables override on-disk config; per-invocation flags (--base-url, --api-version, --profile, --config) override both.

Common commands

# Markets
kash markets list --status ACTIVE --limit 10
kash markets get <market-id>
kash markets predictions <market-id> --limit 20

# Quotes (requires the markets:quote scope)
kash quote buy <market-id> --outcome 0 --amount 10
kash quote sell <market-id> --outcome 0 --tokens 1.5

# Trades
kash trade buy <market-id> --outcome 0 --amount 10 --wait
kash trade sell <market-id> --outcome 0 --amount 5
kash trade confirm <trade-id> <confirmation-token>
kash trade list --status pending,executing --limit 25
kash trade status <trade-id> --poll     # poll until terminal state

# Redeem a resolved (or cancelled) market's position
kash redeem <market-id> --outcome 0

# Portfolio
kash portfolio show
kash portfolio positions

# Account telemetry
kash account usage

# Webhooks
kash webhooks list --status failed --limit 20
kash webhooks redeliver <event-id>
kash webhooks rotate-secret
kash webhooks verify --signature "t=…,v1=…" --body-file payload.json --secret-file secret.txt
kash webhooks replay payload.json --target http://localhost:3000/webhooks/kash --secret-env KASH_WEBHOOK_SECRET

# Tracing
kash trace <correlation-id>             # get it from: kash trade status <id> --json | jq -r .correlationId

# Errors (local lookup, works offline)
kash explain INSUFFICIENT_SCOPE
kash explain RATE_LIMITED --json

Every command supports --help for full usage and examples. The pages in this section are the structured reference for each command.

Output modes

Human (default): colored, tabular, designed for interactive reading.
JSON (--json): the API’s response body, designed for piping into jq, scripts or agents.

kash account usage --json | jq '.trades["24h"].successRate'
kash trade list --json --quiet | jq '.data[] | select(.status=="completed")'
kash markets list --ndjson               # stream every page, one record per line

Two global flags shape JSON output: --fields <list> projects dot-paths (e.g. id,status,outcomes.label) and --filter <expr> keeps matching entries (e.g. 'status==ACTIVE && outcomeCount>2'). On error, --json emits a stable envelope instead:

{
  "ok": false,
  "error": {
    "code": "AUTH_REQUIRED",
    "message": "No API key configured.",
    "recoverable": true,
    "suggestion": "First-time setup: run 'kash setup' (interactive wizard). Otherwise: 'kash auth set-key' or set KASH_API_KEY.",
    "actions": [
      { "type": "run_command", "command": "kash setup", "description": "..." },
      { "type": "set_env", "variable": "KASH_API_KEY", "description": "..." }
    ]
  }
}

suggestion, retryAfterMs, docsUrl and requestId appear when they apply. actions is the agent-friendly recovery path: each type is a stable value (run_command, set_env, wait_and_retry, open_url, check_input), so agents can branch on it without parsing prose.

Quiet mode

--quiet suppresses spinners, progress, informational logs and human-mode tables, and prints JSON compactly. Pair it with --json:

kash account usage --json --quiet | jq '.trades["7d"]'

A bare --quiet on a list or get command prints nothing to stdout, by design.

Exit codes

Code	Meaning
`0`	Success.
`1`	Generic error (validation, server, network, etc.).
`2`	Auth failure (missing or invalid key, missing scope).

Rate-limit errors exit 1. The recoverable flag and retryAfterMs field tell scripts and agents how to handle them, and kash with-retry re-runs a command on recoverable failures.

Retry behaviour

The CLI retries transient failures (network errors, 429, 5xx) with exponential backoff and jitter, the same as the TypeScript SDK. The global --max-retries <n> flag (0–10) overrides the retry budget for one invocation; --max-retries 0 disables retries.

Tab completion

kash completion install     # bash, zsh or fish, detected from your shell
kash completion uninstall

Config import and export

# API keys are redacted unless you pass --include-secrets
kash config export --out kash-config.json

# On another machine
kash config import kash-config.json

Source

npm: @kashdao/cli
GitHub: KashDAO/cli (issues and discussions)

TypeScript SDK

The library version of the same API, for in-process integration.

Endpoint Reference

Every REST endpoint the CLI calls.

Overview

REST API

Webhooks

REST API SDK (TypeScript)

CLI

Protocol SDK (TypeScript)

Protocol SDK (Python)

API Error Catalogue

Public Embed API

Embed — Thread Endpoints

Embed — Market Endpoints

Embed — Twitter Deep Links

Embed — Guides

Embed — Code Examples

CLI

Configure

Common commands

Output modes

Quiet mode

Exit codes

Retry behaviour

Tab completion

Config import and export

Source

Next

TypeScript SDK

Endpoint Reference

​Configure

​Common commands

​Output modes

​Quiet mode

​Exit codes

​Retry behaviour

​Tab completion

​Config import and export

​Source

​Next

TypeScript SDK

Endpoint Reference

Configure

Common commands

Output modes

Quiet mode

Exit codes

Retry behaviour

Tab completion

Config import and export

Source

Next