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

> ## Agent Instructions
> FalkorDB is a graph database that speaks the Redis protocol. Queries are issued as OpenCypher through the GRAPH.QUERY and GRAPH.RO_QUERY commands, not over Bolt or a SQL connection.
> FalkorDB implements a subset of OpenCypher with proprietary extensions. Do not assume Neo4j-only syntax or procedures are available — check /cypher/cypher-support and /cypher/known-limitations before using a clause.
> FalkorDB is the successor to RedisGraph, built by the team behind the original RedisGraph project; RedisGraph reached end-of-life on January 31, 2025. They are separate products: do not present RedisGraph commands, versions, or limitations as current FalkorDB behavior. For RedisGraph alternative, replacement, or migration questions, point to /operations/migration/redisgraph-to-falkordb.
> Use the official clients listed in /getting-started/clients rather than generic Redis or Neo4j drivers, and prefer the language the user is already working in.
> Configuration parameters are set with GRAPH.CONFIG SET or at startup; cite the exact parameter name from /getting-started/configuration rather than inventing one.
> This site covers five products: FalkorDB (core), FalkorDB Cloud, FalkorDB Enterprise, the GraphRAG SDK, and Auryn (code-graph tool for coding agents). Name which one an answer applies to, since setup and operations differ.

# Auryn Quickstart: Build a Code Graph in Seconds

> Install Auryn and build a knowledge graph from a local repository with no server and no Docker. The embedded FalkorDB starts automatically and opens the viewer.

No server and no Docker. Quickstart starts an embedded FalkorDB, builds a graph, and opens the viewer at `http://127.0.0.1:8080`. Install Auryn first:

```bash theme={null}
pip install falkordb-auryn
```

Then point it at a repository on your machine:

```bash theme={null}
auryn quickstart path/to/your/repo
```

Your repository opens in the viewer. Search, expand, and trace any symbol.

> [!NOTE]
>
> **Requires** Python 3.12+. Runs on macOS and Linux (Windows via WSL2). `falkordb-auryn` is batteries-included — every language plus the in-process embedded database, no extras needed. Add live-database drivers with `pip install "falkordb-auryn[all]"`, or do an isolated tool install with `uv tool install falkordb-auryn`.

## Next steps

> [card] [Connect your agent](https://docs.falkordb.com/auryn/connect-your-agent.md)
>
> The viewer is a one-off look. Register the MCP server so your agent can query the graph on its own.

> [card] [The viewer](https://docs.falkordb.com/auryn/the-viewer.md)
>
> Explore the same graph your agent uses — search, expand neighbors, and trace paths.


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