TypeScript SDK
Install
Install @ratel-ai/sdk: requirements, prebuilt native targets, optional packages, and the embedding model download.
One package, no service:
npm install @ratel-ai/sdk@0.4.0The docs pin the version they document; drop the pin to track the latest release. The package is ESM (type: module) and needs Node.js 20 or newer.
Prebuilt native targets
The SDK bundles Ratel's Rust core as a native module. Prebuilt bindings ship for:
- macOS:
darwin-arm64,darwin-x64 - Linux (glibc):
linux-x64-gnu,linux-arm64-gnu - Windows:
win32-x64-msvc
On these targets nothing compiles at install time and no Rust toolchain is needed.
What else you might install
- MCP ingestion —
registerMcpServerworks out of the box; the MCP client (@modelcontextprotocol/sdk) ships as a dependency. - Telemetry export —
@ratel-ai/telemetry-otlpis an optional peer; add it only to ship spans over OTLP. See Telemetry & OTel. - Semantic & hybrid retrieval — nothing to install. Opting in downloads the local embedding model on first use; see Build the embedding cache and Semantic & hybrid search.