CLI Installation

The Orchata CLI lets you manage Spaces, Documents, and Queries from the terminal.

Prerequisites

Node.js 18+ or Bun runtime
An Orchata account and API key (get one here)

Install

npm install -g @orchata-ai/cli

bun add -g @orchata-ai/cli

pnpm add -g @orchata-ai/cli

yarn global add @orchata-ai/cli

Verify the installation:

orchata --version

Quick Start

# 1. Set up your cloud configuration
orchata init

# 2. Authenticate with your API key
orchata login

# 3. List your spaces
orchata spaces list

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

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

Configuration

The CLI stores configuration in ~/.orchata/config.json. You can also set values via environment variables:

Environment Variable	Description
`ORCHATA_API_BASE`	Override API base URL
`ORCHATA_API_KEY`	Override API key
`ORCHATA_PROFILE`	Select a named profile

Global Options

These options can be used with any command:

Option	Description
`--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

Getting Started

MCP Server

AI Tool Setup

CLI

TypeScript SDK

CLI Installation

Prerequisites

Install

Quick Start

Configuration

Global Options

Next Steps

Command Reference

Authentication

​Prerequisites

​Install

​Quick Start

​Configuration

​Global Options

​Next Steps

Command Reference

Authentication

Prerequisites

Install

Quick Start

Configuration

Global Options

Next Steps