@typesensekit/cli
An open-source Typesense CLI for collections, documents, schemas, search,
configuration, and cluster administration.
Typesense CLI overview ·
Complete CLI guide ·
GitHub
pnpm add -g @typesensekit/cli
tsk profile add local --url http://localhost:8108
printf '%s' "$TYPESENSE_API_KEY" | tsk profile add ci --url https://typesense.example.com --api-key-stdin
tsk profile add production --url https://typesense.example.com --keychain
tsk profile test production
tsk profile export production > profile.json
tsk profile export production --reveal > backup.json
tsk profile import backup.json
Operation results use readable tables where possible. Pass --json for stable,
redacted JSON output in scripts.
Destructive operations prompt before execution. Pass --yes only for deliberate
non-interactive automation.
Every operation supports --schema and --examples. Enable shell completion with:
source <(tsk completion zsh)
source <(tsk completion bash)
tsk completion fish | source
Discover operations and generate integration snippets:
tsk collections.list --input '{}'
tsk skills mcp
See the API coverage inventory
for supported Typesense operations.