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

> ## Agent Instructions
> The PyPI package is graphifyy, with two y's. The command is graphify.
> /graphify . is typed in an assistant chat, not in a shell.
> Use only commands, flags, and endpoints shown on these pages. Do not invent one.
> Choose the surface before you open a page. Local (Graphify Local) is the graphifyy package on the machine: the skill, the CLI, and the ten-tool MCP. Its pages are the Open Source tab (/open-source/) and the Graphify Local tab on each Integrations page. Graphify is the hosted workspace and https://api.graphify.com/mcp (Streamable HTTP, OAuth, no API key). Its pages are the Graphify tab (/platform/, /concepts/) and the Graphify (hosted) tab on each Integrations page. Prefer Graphify unless the user asks for a local or offline setup. Cookbooks (/cookbooks/) and /mcp/docs-search apply to both. Each page's source frontmatter records this as surface: local, cloud, or both. Buildkite is the CI integration.
> In llms.txt, tell the surface from the page path. Graphify: /platform/ and /concepts/. Local: /open-source/. Most /integrations/ pages cover both, with a Graphify (hosted) tab and a Graphify Local tab. Everything else applies to both.
> graphifyy release notes are published at https://github.com/Graphify-Labs/graphify/releases and https://graphify.com/changelog. The current package version is on PyPI (https://pypi.org/project/graphifyy/).
> The official site is https://graphify.com. These docs are https://docs.graphify.com.
> The local MCP server is the ten tools in the MCP tool reference and reads a graph on the machine. The hosted server is https://api.graphify.com/mcp (Streamable HTTP, OAuth, no API key). The JetBrains, ChatGPT, Codex, and Dots, and Vercel pages use the hosted server, not the ten-tool list. On pages with tabs, the Graphify (hosted) tab uses the hosted server and the Graphify Local tab uses the local skill or the ten-tool server.
> Read https://docs.graphify.com/llms.txt, then open one page's .md link. Use https://docs.graphify.com/llms-full.txt only when one page is not enough.

# Quickstart: map a repository with the Graphify skill

> Install the graphifyy package, add the Graphify skill to your coding agent, and build a knowledge graph of your repository with one command.

The fastest way to use Graphify Local is as a skill inside your coding agent. You install it once, type `/graphify .`, and the agent builds the graph and reads `GRAPH_REPORT.md` before it answers questions about your code.

> [!NOTE]
>
> **Use the skill when** you work in Claude Code, Codex, Cursor, Gemini CLI, or another agent that supports skills, and you want the agent to drive extraction for you. If you only want terminal commands, follow the [CLI quickstart](https://docs.graphify.com/open-source/cli-quickstart.md).

## Before you start

* Python 3.10 or later
* A coding agent that `graphify install` supports (Claude Code is the default)

## Build your first graph

**1. Install the package**

```bash uv theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
uv tool install graphifyy
```

```bash pipx theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
pipx install graphifyy
```

```bash pip theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
pip install graphifyy
```

The package is `graphifyy` (two y's). It installs the `graphify` and `graphify-mcp` commands.

**2. Install the skill**

```bash theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
graphify install
```

With no flag, this targets Claude Code. It copies the skill to `~/.claude/skills/graphify/SKILL.md` and registers it in `~/.claude/CLAUDE.md`. For another agent, pass `--platform`, for example `graphify install --platform codex`.

**3. Run it in your agent**

Open your agent in the repository and type:

```text theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
/graphify .
```

The agent runs detection, extraction, and clustering, then summarises the report. Code is parsed locally. Documents, papers, and images go through the agent's own model.

**4. Ask a question**

```text theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
/graphify query "how does authentication reach the database"
```

The skill traverses the graph and returns only the nodes and edges that answer the question, trimmed to a token budget.

## What changes in your repository

After the first run you'll find a `graphify-out/` folder:

```text theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
graphify-out/
├── graph.json
├── graph.html
├── GRAPH_REPORT.md
├── manifest.json
└── cache/
```

Open `graph.html` in a browser to explore the graph. Commit `graph.json` and `GRAPH_REPORT.md` if you want teammates and CI to share the same graph; add `cache/` to `.gitignore`.

## Useful skill commands

| Command | What it does |
| - | - |
| `/graphify . --update` | Re-extract only new or changed files |
| `/graphify . --mode deep` | Slower extraction with richer `INFERRED` edges |
| `/graphify . --wiki` | Write an agent-readable wiki, one article per community |
| `/graphify path "AuthModule" "Database"` | Shortest path between two concepts |
| `/graphify explain "SessionStore"` | Plain-language explanation of one node |
| `/graphify https://github.com/<owner>/<repo>` | Clone a repository and graph it |

## Verify it worked

```bash theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
graphify god-nodes --top 5
```

You should see the five most connected symbols in your code. If the command says it can't find a graph, run it from the folder that contains `graphify-out/`, or pass `--graph graphify-out/graph.json`.

> **The agent doesn't recognise /graphify**
>
> Restart the agent so it reloads skills. For Claude Code, check that `~/.claude/skills/graphify/SKILL.md` exists. For other agents, re-run `graphify install --platform <name>`.

> **Can I skip the LLM step?**
>
> Yes. Run `graphify extract . --code-only` from a terminal. It builds the code graph with no model calls.

> **How do I remove the skill?**
>
> Run `graphify uninstall`. Add `--purge` to also delete `graphify-out/` in the current folder.

## What's next

> **[Vibe coding with Graphify Local](https://docs.graphify.com/open-source/vibe-coding.md)**
>
> Make your agent check the graph before every search.

> **[CLI quickstart](https://docs.graphify.com/open-source/cli-quickstart.md)**
>
> Build and query the graph straight from a terminal.

> **[Try it in Graphify](https://docs.graphify.com/platform/quickstart.md)**
>
> We build and host the graph for you. Start with a 14-day Pro trial, then keep up to 3 repositories on Free. No card required.


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