> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cyborg.co/llms.txt
> Use this file to discover all available pages before exploring further.

# CyborgDB - JavaScript/TypeScript SDK Reference

> `v0.18.x`

The **CyborgDB** JavaScript/TypeScript SDK is a client for the CyborgDB service. It creates encrypted indexes, upserts and retrieves vectors, runs vector, hybrid (BM25 + vector), and metadata-only queries, and manages per-index users. It ships TypeScript types and runs on Node.js 18+, Bun, Deno, modern browsers, Vercel Edge Runtime, and Cloudflare Workers.

The package is available on [npm](https://www.npmjs.com/package/cyborgdb) and the source code is on [GitHub](https://github.com/cyborginc/cyborgdb-js).

## Installation

```bash theme={null}
npm install cyborgdb
```

The package has no runtime dependencies.

## LangChain

The LangChain vector store, `CyborgVectorStore`, is a separate entry point, so the main package doesn't require LangChain:

```bash theme={null}
npm install cyborgdb @langchain/core
```

```typescript theme={null}
import { CyborgVectorStore } from 'cyborgdb/integrations/langchain';
```

`@langchain/core` `^1.0.0` is an optional peer dependency. Since v0.18, `CyborgVectorStore` is no longer exported from `'cyborgdb'` itself.

## Prerequisites

The SDK needs a running CyborgDB service:

```bash theme={null}
# Install and start the service
pip install cyborgdb-service
cyborgdb-service

# Or run the Docker image
docker run -p 8000:8000 cyborginc/cyborgdb-service
```

See the quickstart guides for [Docker](../guides/intro/quickstart-docker) and [Python](../guides/intro/quickstart-python).

## Supported runtimes

The SDK ships as a single dependency-free bundle and imports on any JavaScript runtime with `fetch` and Web Crypto:

| Runtime | Supported | Notes |
| - | - | - |
| Node.js | >= 18 | Full functionality, including the on-disk sample-dataset cache. |
| Bun / Deno | Yes | Node-compatible; same functionality as Node. |
| Browsers | Yes (modern) | `verifySsl: false` has no effect. |
| Vercel Edge Runtime | Yes | — |
| Cloudflare Workers | Yes | — |

The main `cyborgdb` entry point does not import `@langchain/core` — install it (as an optional peer) and import from the `cyborgdb/integrations/langchain` subpath only if you use the LangChain integration.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.