Can I use Typesense as a CLI?

Yes. KosmoKrator exposes a Typesense CLI through kosmo integrations:call and the provider shortcut command. Commands can return JSON for scripts, CI, and coding agents.

Can I expose Typesense through MCP?

Yes. The KosmoKrator MCP gateway can expose selected Typesense tools to clients such as Claude Code, Cursor, Codex, and other MCP-compatible tools.

Where are Typesense credentials stored?

Typesense credentials are configured in KosmoKrator's local integration settings and reused by CLI, Lua, and MCP gateway surfaces.

Can I deny write access for Typesense MCP tools?

Yes. Start the gateway with --write=deny for read-only clients, or use ask/allow only for trusted workspaces.

data

Typesense CLI for Shell Scripts

Use the Typesense CLI for shell scripts with headless JSON commands, schema discovery, credentials, and permission controls.

7 functions 5 read 2 write API key auth

Submit Typesense feedback View package source

Typesense CLI for Shell Scripts

Call integration functions from shell scripts with stable JSON input and output.

Use shell scripts for small local automations that need one or more integration calls. The Typesense CLI uses the same integration registry as the TUI, Lua runtime, and MCP gateway, but returns predictable command output for automation.

Command Shape

# Typesense CLI for Shell Scripts
kosmokrator integrations:configure typesense --set api_key="$TYPESENSE_API_KEY" --enable --read allow --write ask --json
kosmo integrations:call typesense.typesense_list_collections '{}' --json

Discovery Before Execution

Agents and scripts can inspect Typesense docs and schemas before choosing a function.

kosmo integrations:docs typesense --json
kosmo integrations:docs typesense.typesense_list_collections --json
kosmo integrations:schema typesense.typesense_list_collections --json
kosmo integrations:search "Typesense" --json
kosmo integrations:list --json

Useful Typesense CLI Functions

Function	Type	Parameters	Description
`typesense.typesense_list_collections`	Read	none	List all collections in the Typesense search instance. Returns collection names, document counts, and schema details.
`typesense.typesense_get_collection`	Read	name	Get details of a specific Typesense collection by name, including its schema, field definitions, and document count.
`typesense.typesense_create_collection`	Write	name, fields, default_sorting_field	Create a new collection in Typesense with a specified schema including field definitions and optional default sorting field.
`typesense.typesense_search_documents`	Read	collection, q, query_by, filter_by, sort_by, per_page, page	Search for documents in a Typesense collection. Supports full-text search, filtering, sorting, and pagination.
`typesense.typesense_index_document`	Write	collection, document	Index (create or update) a document in a Typesense collection. The document must conform to the collection's schema.
`typesense.typesense_get_document`	Read	collection, id	Retrieve a single document from a Typesense collection by its ID.
`typesense.typesense_get_health`	Read	none	Check the health status of the Typesense search instance. Returns whether the service is reachable and healthy.

Automation Notes

Use --json for machine-readable output.
Keep credentials out of argv by using environment variables or stored KosmoKrator configuration.
Configure read/write policy before unattended runs; use --force only for trusted automation.
Use the MCP gateway instead when the agent needs dynamic tool discovery inside a conversation.

Related Typesense CLI Pages

CI Typesense CLI for CI. Cron Jobs Typesense CLI for cron jobs. Headless Automation Typesense CLI for headless automation. Coding Agents Typesense CLI for coding agents.