@assistableai/cli

Command-line interface for the Assistable AI v3 API. Every v3 operation is a command — manage assistants, contacts, calls, knowledge bases, and more from your terminal or scripts.

Generated from spec/openapi.json — one command per operation, built on @assistableai/sdk.

Install

npm install -g @assistableai/cli
# or run without installing:
npx @assistableai/cli --help

Authenticate

assistableai login --api-key ask_live_… --subaccount <subaccount-id>

Credentials are stored in ~/.assistableai/config.json (mode 0600). Precedence for every command is: explicit flag → environment (ASSISTABLE_API_KEY, ASSISTABLE_SUBACCOUNT_ID, ASSISTABLE_BASE_URL) → the stored config file.

assistableai whoami     # show the active credentials (API key masked)
assistableai logout     # delete stored credentials

Usage

Commands are grouped by resource topic. Run --help at any level:

assistableai --help                 # list topics
assistableai assistants --help      # list commands in a topic
assistableai assistants list --help # flags + args for one command

Examples:

# Read (table output by default, --json for scripting)
assistableai assistants list --limit 10
assistableai assistants get <assistant-id> --json

# Per-command subaccount override
assistableai contacts list -s <subaccount-id>

# Write operations take a JSON body via -d / --data (or --data-file, '-' = stdin)
assistableai contacts create -d '{"first_name":"Ada","email":"[email protected]"}'
echo '{"name":"Support bot"}' | assistableai assistants create --data-file -

Global flags

| Flag | Description | |---|---| | --json | Print the raw { data, error, request_id } response instead of a table | | -s, --subaccount <id> | Target subaccount (X-Subaccount-Id) for this call | | --api-key <key> | Override the stored/env API key for this call | | --base-url <url> | Override the API base URL | | -d, --data <json> | JSON request body for write operations | | --data-file <path> | Read the JSON request body from a file (- for stdin) |

On an API error the message (with request_id) is written to stderr and the process exits non-zero, so it composes in shell pipelines and CI.

Develop

pnpm -C packages/cli generate   # regenerate commands from spec/openapi.json
pnpm -C packages/cli build      # tsc → dist/
node bin/dev.js <command>       # run from TS source without building