@orchata-ai/cli

Command-line interface for managing Orchata Spaces, Documents, and Queries.

Installation

npm install -g @orchata-ai/cli
# or
bun add -g @orchata-ai/cli

Quick Start

# Set up your cloud configuration
orchata init

# Authenticate with your API key
orchata login

# List your spaces
orchata spaces list

# Upload a document to a space
orchata documents upload ./docs/handbook.md --space space_123

# Query a space
orchata query "How do I authenticate?" --space space_123

Commands

orchata init

Configure the CLI to connect to the Orchata cloud API.

orchata init
orchata init --api-base https://api.orchata.ai --app-base https://app.orchata.ai

orchata login

Opens the signup page (if needed) and stores your API key.

orchata login
orchata login --api-key oai_...
orchata login --profile production

Options:

• --api-key <key> — Provide API key non-interactively
• --profile <name> — Use a named profile
• --host <url> — Override API base URL
• --no-open — Don't open the signup page in browser

orchata configure

Update saved settings like profile, API base, and app base.

orchata configure --api-base https://api.orchata.ai
orchata configure --profile staging --set-default

orchata spaces

Manage spaces.

orchata spaces list
orchata spaces create --name "Docs" --description "Product docs" --icon book
orchata spaces get space_123
orchata spaces update space_123 --name "Updated"
orchata spaces delete space_123

orchata documents

Manage documents in a space.

orchata documents list --space space_123
orchata documents upload ./file.md --space space_123
orchata documents upload --space space_123 --content "# Title"
orchata documents get document_123 --space space_123
orchata documents content document_123 --space space_123
orchata documents append document_123 --space space_123 --content "- New item"
orchata documents batch ./docs/ --space space_123

orchata query

Query one or more spaces.

orchata query "authentication flow" --space space_123
orchata query smart "what is orchata"
orchata query "onboarding" --space space_123 --top-k 5

Global Options

These options can be used with any command:

• --profile <name> — Use a named profile
• --api-base <url> — Override API base URL
• --app-base <url> — Override app base URL
• --api-key <key> — Override API key for this run
• --json — Output raw JSON

Configuration

Config is stored in ~/.orchata/config.json with restricted permissions.

You can also set configuration via environment variables:

ORCHATA_API_BASE=https://api.orchata.ai
ORCHATA_API_KEY=oai_...
ORCHATA_PROFILE=cloud

License

MIT