Install
Install the Ratel SDK for TypeScript or Python, or run Ratel Local for MCP clients.
Ratel ships as two SDKs over one Rust core, plus Ratel Local for MCP clients such as Claude Code, Codex, and Cursor. No hosted Ratel service or API key is required.
SDK
npm install @ratel-ai/sdkESM, Node.js 20.6 or newer.
Full guide (native targets, optional packages, embedding model): TypeScript install. Then the TypeScript quickstart.
pip install ratel-ai
# extras:
pip install 'ratel-ai[mcp]' # register upstream MCP servers
pip install 'ratel-ai[otlp]' # OTLP telemetry exportPython 3.10 or newer for these guides; the base SDK supports 3.9, the mcp extra needs 3.10+.
Full guide (prebuilt wheels, extras, embedding model): Python install. Then the Python quickstart.
Requirements
- Prebuilt native targets: macOS (
darwin-arm64,darwin-x64), Linux glibc (linux-x64-gnu,linux-arm64-gnu), Windows (win32-x64-msvc). - On those targets nothing compiles at install time: no Rust toolchain.
- Semantic & hybrid search is opt-in and, by default, downloads a local embedding model on first use; BM25 needs nothing.
Ratel Local
For Claude Code or Codex, install the stable CLI and run the complete setup wizard:
npm install --global @ratel-ai/ratel-local
ratel-local setupThe binary is ratel-local and requires Node.js 20.6 or newer. Setup prepares the
persistent daemon, detects Claude Code and Codex, connects selected agents through the
plugin-first flow, and separately offers existing MCP servers and skills for import.
Follow the Ratel Local quickstart. Cursor uses
manual mcp.json setup.
The Rust crate ratel-ai-core underlies both SDKs; it is a reference, not an install target.