Documentation for RushDB, the database for AI: self-hosted RushDB, RushDB Cloud, SDKs, query languages and protocols. Published at docs.rushdb.com.
Quick start · Learn RushDB · Connect tools · Deploy · Engine manual
RushDB is a self-describing, graph-native database that helps AI agents reason over data with confidence: progressively introspect what's queryable—without guesswork.
This repository is the source of docs.rushdb.com. RushDB 3.x is served at the root; RushDB 2.x (legacy, Neo4j-based) is served at /2.x/ and receives security fixes only until 2027-10-28.
| Section | What you will find |
|---|---|
| Quick start | The shortest path from an API key to storing and querying data. |
| Learn | Records, relationships, SearchQuery, keyword, semantic and hybrid search, agent memory, SDK/MCP/REST references, and tutorials. |
| Connect | SDKs, SQL and Cypher, MCP, agent skills, and native OpenClaw and Hermes memory integrations. |
| Deploy | RushDB Cloud or self-hosted RushDB from a script, Homebrew, Docker, Cargo or a release archive, and taking it to production. |
| Engine manual | Install, data model, query languages, connectivity, indexes, operations, architecture and reference for self-hosted RushDB. |
| RushDB Cloud | What RushDB Cloud adds, API keys and projects. |
| Migrate from 2.x | Moving a RushDB 2.x (legacy) project to RushDB 3. |
The site includes local full-text search, responsive navigation, Mermaid diagrams, syntax-highlighted examples, reusable MDX components, raw page sources, and machine-readable documentation indexes for agents and LLM tooling.
Requirements:
- Node.js 20–26
- pnpm 10
Install the locked dependency graph and start the development server:
pnpm install --frozen-lockfile
pnpm startDocusaurus serves the site at http://localhost:3000 with live reload.
Before opening a pull request, run the high-signal checks for a production-ready site:
pnpm types:check
pnpm lint:design # design and content conventions (DESIGN.md, AGENTS.md)
pnpm buildFor changes to styles or components, also render the reference pages in both themes and both widths, with an accessibility check:
pnpm start # in one terminal
pnpm audit:ui # in another; screenshots land in .ui-audit/To inspect the production output locally:
pnpm servepnpm build validates document routes, fails on broken Docusaurus links, warns on broken Markdown links, builds the local search index, copies raw documentation sources, and generates the llms*.txt files under build/.
The repository serves both documentation generations at once. The default generation owns /; the other is available at /<version>/.
docs/andsidebars.v3.tscontain the 3.x documentation, served at/: RushDB on its own engine, used through RushDB Cloud or self-hosted.v2/andsidebars.tscontain the RushDB 2.x (legacy, Neo4j-based) documentation, served at/2.x/with a legacy banner on every page.sidebars.v2.tsprefixes its root-relative links with/2.x/.- docs-versioning.ts contains
DEFAULT_DOCS_VERSION('3.x'). The route base, sidebars, the version link in the sidebar footer, noindex rules and the generatedllms.txtfiles follow that one value. - The site has no redirects: every URL is a real page or a 404. 2.x pages and tag pages carry
noindex, followand are left out of the sitemap, so search engines and AI answers cite the current docs.
Path in docs/ |
Content | Source |
|---|---|---|
index.mdx, get-started/, deploy.mdx |
Overview, choosing Cloud or self-hosting, quick tutorial, distribution channels | This repository |
connect/ |
SDKs (Cloud and direct mode), MCP, skills, agent memory integrations | This repository |
learn/ |
Records, SearchQuery, relationships, keyword/semantic/hybrid search, agent memory, tutorials, SDK/MCP/REST references | This repository |
rushdb-cloud/ |
What RushDB Cloud adds, API keys, projects | This repository |
migration/ |
Moving from 2.x | This repository |
engine/ |
The engine manual: install, data model, query languages, connectivity, indexes, operations, architecture, reference | Generated from docs/manual in the engine repository |
Never edit docs/engine/ here. Edit the manual in the engine repository, then copy it in:
pnpm sync:engine-manual # reads ../rushdb by default; pass another path as an argument
pnpm check:engine-manual # fails if docs/engine is staleIn 3.x pages, link to other pages with relative file paths (../learn/semantic-search/hybrid-search.mdx), so links keep working whichever version owns /. Mark Cloud-only features as such, and say what a self-hosted engine offers instead.
Keep a 2.x page self-contained. When it uses a root-relative link inside a reusable MDX component, use docsPathForVersion('2.x', '/path') so the link remains inside /2.x/ after the default changes.
The portal follows the RushDB website's identity: Geist and Geist Mono, the website's colour tokens, square edges and mono uppercase labels.
- DESIGN.md is the visual system: tokens, type, layout and components.
- AGENTS.md is the doctrine: which component to use for what, styling and content rules, accessibility floor and definition of done.
- src/css/tokens.css holds the values, copied from the website. Change them there first.
- Add or update a
.mdor.mdxfile underdocs/for 3.x orv2/for 2.x (legacy). - Give the page concise
titleanddescriptionfront matter, in sentence case. - Register new navigation entries in
sidebars.v3.tsfor 3.x orsidebars.tsfor 2.x; both sidebars are intentionally curated rather than autogenerated. - Use root-relative links for documentation routes, such as
/learn/semantic-search, and/img/...paths for assets understatic/img/. - Avoid moving published pages: the site has no redirects, so an old URL becomes a 404. If a move is unavoidable, link the new page from wherever the old one was linked.
- Run
pnpm types:check,pnpm lint:designandpnpm buildbefore submitting the change. For 3.x, also runpnpm check:v3-content(rejects 2.x claims in 3.x pages) andpnpm verify:v3-quickstart(runs the Quick Tutorial against a local engine; setRUSHDB_BINto arushdbbinary).
Prefer a focused example that readers can run over an exhaustive abstract explanation. State prerequisites before commands, keep terminology consistent with the SDKs and REST API, and distinguish RushDB Cloud behavior from self-hosted behavior whenever they differ.
| Path | Purpose |
|---|---|
docs/ |
3.x documentation source pages; docs/engine/ is generated. |
v2/ |
2.x (legacy) documentation source pages, served under /2.x/. |
sidebars.ts |
Curated 2.x (legacy) navigation hierarchy. |
sidebars.v3.ts |
Curated 3.x navigation hierarchy. |
docs-versioning.ts |
Default version, per-version paths and sidebars, unpublished pages. |
scripts/ |
Engine-manual sync, content and design checks, UI audit, Quick Tutorial verification. |
static/ |
Images, favicons, social cards, and other directly served assets. |
src/components/ |
Reusable MDX and documentation UI components. |
src/theme/ |
Swizzled Docusaurus theme components and navigation behavior. |
src/css/tokens.css |
Design tokens copied from the RushDB website. |
src/css/custom.css |
Documentation theme built on the tokens (see DESIGN.md). |
DESIGN.md, AGENTS.md |
Visual system and doctrine for every docs change. |
plugins/ |
Local Docusaurus plugins for tutorials and Tailwind processing. |
docusaurus.config.ts |
Site metadata, structured data, sitemap, search, raw-source export. |
plugins/agent-readable.cjs |
Writes the .md page copies, llms.txt, llms-full.txt and the per-section files. |
Generated directories—build/ and .docusaurus/—are intentionally ignored and should not be edited or committed.
The site is configured for https://docs.rushdb.com at the root path. A production build writes the deployable static site to build/, including:
- HTML, assets, sitemap, and the local search index;
- a Markdown copy of every page (3.x and 2.x) at its URL with
.mdinstead of the trailing slash:/connect/mcp/→/connect/mcp.md, linked from the page as<link rel="alternate" type="text/markdown">(pnpm startserves them too); llms.txt(sections follow the sidebar's top-level categories) andllms-<section>.txt;llms-full.txtandllms-<section>-full.txt, every 3.x page as Markdown;robots.txt(fromstatic/) andsitemap.xmlwithlastmoddates from git.
Publish the contents of build/ with the static hosting platform used for docs.rushdb.com.
- RushDB — RushDB, the database for AI: the
rushdbserver and CLI, and its manual - RushDB JavaScript SDK —
@rushdb/javascript-sdk - RushDB Python — Python SDK
- RushDB MCP Server —
@rushdb/mcp-server - RushDB Skills — Agent Skills
- RushDB Agent Memory Contract — shared agent-memory protocol
- RushDB OpenClaw Memory — native OpenClaw memory integration
- RushDB Hermes Memory — native Hermes Agent memory provider
Apache-2.0. See LICENSE.