Collections and schemas
Create, inspect, update, alias, and manage collection configuration with validated inputs.
Terminal-first operations
A Typesense CLI for search operations
Manage Typesense collections, documents, schemas, search, configuration, and cluster operations from one typed command line.
TypesenseKit turns the Typesense Admin API into discoverable commands with generated schemas, copy-ready examples, readable tables, stable JSON, and safer credential handling.
MIT licensedTyped inputsJSON output
Install and connect
pnpm add -g @typesensekit/cli
tsk profile add local --url http://localhost:8108
tsk profile use local
tsk collections.list --input '{}'The profile command prompts for your API key without placing it in shell history.
Operational coverage
Run Typesense work without one-off scripts
Inspect the input schema before every operation, run the command, and choose human-readable output or stable JSON for automation.
Documents and search
Import, export, retrieve, search, and delete documents from a consistent terminal interface.
Cluster administration
Work with keys, presets, analytics, health, metrics, snapshots, and other supported Typesense operations.
Humans and scripts
Discoverable at the prompt. Predictable in CI.
Every operation can show its generated schema and examples. Add --json when another program needs stable, redacted output.
tsk operations
tsk documents.search --schema
tsk documents.search --examples
tsk collections.list --input '{}' --jsonSecure profiles
Prompt for secrets, pipe them over stdin, use macOS Keychain, or stay environment-only.
Destructive confirmations
Interactive commands confirm destructive operations before sending them to Typesense.
Redacted JSON
Use structured output for scripts while keeping known secret fields out of results and errors.
Choose the right tool
CLI for operations, client library for your app
Official Typesense clients belong in application code. TypesenseKit is for terminal workflows shared by operators, shell automation, CI jobs, and AI agents.
Explore official Typesense clients →Common questions
Typesense CLI FAQ
Installation, cluster compatibility, credentials, and when to use a command-line tool.
What is a Typesense CLI?
A Typesense CLI lets operators manage and inspect a Typesense cluster from a terminal. TypesenseKit provides typed commands for collections, documents, search, schemas, configuration, and system operations.
How do I install the TypesenseKit CLI?
Install it globally with pnpm add -g @typesensekit/cli or npm install -g @typesensekit/cli. The command is tsk.
Does the CLI work with Typesense Cloud and self-hosted Typesense?
Yes. Point a profile or the TYPESENSE_URL environment variable at any reachable Typesense cluster and provide an API key with the permissions your commands require.
How is a Typesense CLI different from a client library?
Use an official Typesense client inside application code. Use TypesenseKit when a human, shell script, CI job, or AI agent needs a terminal-first operational interface with generated schemas, examples, JSON output, and safety controls.
How does TypesenseKit protect credentials?
Profiles can prompt securely, read an API key from stdin, or use macOS Keychain. Output and errors redact secrets, and environment-only operation is also supported.
Open source
Put Typesense operations in your terminal.
Install the CLI, inspect the commands, and star TypesenseKit if it improves your search workflow.