> ## 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 CLI Reference

> A map of the Auryn command line: set up, ingest, keep fresh, manage, use the graph, and hooks. Every command explains itself with its own --help flag.

You rarely need it — your agent does most of this. Every command explains itself with `auryn <command> --help`. Leave out `--host` and `--port` and it uses the backend you chose at install.

| Group | Commands |
| :- | :- |
| Set up | `install` · `uninstall` · `serve` · `stop` |
| Ingest | `ingest dir` · `ingest repo` · `quickstart` · `run <ingestor>` · `git-sync` · `enrich` |
| Keep fresh | `sync` · `watch` |
| Manage | `list` · `forget` · `stats` |
| Use the graph | `view` · `mcp` · `embed` · `impact` |
| Hooks | `hooks list` · `hooks new` · `hooks enable` · `hooks disable` |

## Common commands

```bash theme={null}
auryn ingest dir . --project-name MyApp                        # every language under a folder
auryn ingest repo https://github.com/you/repo.git --ref main
auryn ingest dir . --deep background                           # query the fast graph right away
auryn run sql --dsn postgresql+psycopg2://u:p@host/db --database-name shop
auryn stats --since 24h                                        # how your agent used the graph
auryn forget . --dry-run                                       # preview removing a repo
```

Every flag for every command is in `docs/cli.md` in the [Auryn repository](https://github.com/FalkorDB/Auryn).


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