> ## 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.

# Installation

> Install graphify with uv or pipx on macOS, Linux, or Windows, upgrade it, and register the Graphify skill with your coding assistant.

> [!TIP]
>
> Don't want to install anything? Graphify, the hosted product at app.graphify.com, indexes your GitHub repositories in the browser. We run it for you, so there's nothing to deploy. Start with the [Cloud quickstart](https://docs.graphify.com/platform/quickstart.md).

## Prerequisites

| Requirement | Check |
| - | - |
| Python 3.10 or later | uv installs this. With pip or a virtual environment, `python3 --version` |
| uv or pipx | `uv --version` or `pipx --version` |
| A coding assistant, for the skill workflow | [Choose an integration](https://docs.graphify.com/integrations/overview.md) |

The standalone CLI works without an assistant. Code-only extraction does not require an API key.

## Get uv

uv downloads Python 3.10 or later for Graphify. Install uv for your system, open a new terminal, and run `uv --version`.

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

```bash Linux theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
curl -LsSf https://astral.sh/uv/install.sh | sh
```

```powershell Windows theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
```

The macOS command is Homebrew. The Linux and Windows commands are uv's own installers. Other methods, including MacPorts, are in the [uv installation guide](https://docs.astral.sh/uv/getting-started/installation/).

## 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 Python environment theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
python3 -m venv .venv
.venv/bin/python -m pip install graphifyy
```

On Windows, a virtual environment’s executable is `.venv\Scripts\python.exe`. uv and pipx manage the environment for you.

> [!NOTE]
>
> The official PyPI package is `graphifyy`. Other similarly named packages are not the Graphify Labs package.

## Register the skill

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

The first command detects an assistant. The second targets one explicitly. Run the specific command for each assistant you use.

The package on PyPI is `graphifyy`. The command you run is `graphify`.

Open the assistant in a repository and send `/graphify .`. That message builds the graph for the folder. Follow [Your first knowledge graph](https://docs.graphify.com/open-source/quickstart.md) to read the output and ask a question.

Use `--project` when you want the registration committed with a repository:

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

Read the installer’s list of files before committing them. Project and user registrations live in different locations.

## Optional capabilities

Install only the extras your workflow needs. Quote bracketed names in zsh.

| Capability | uv installation |
| - | - |
| MCP server | `uv tool install "graphifyy[mcp]"` |
| File watching | `uv tool install "graphifyy[watch]"` |
| PDFs | `uv tool install "graphifyy[pdf]"` |
| SQL parsing | `uv tool install "graphifyy[sql]"` |
| Terraform | `uv tool install "graphifyy[terraform]"` |
| Office documents | `uv tool install "graphifyy[office]"` |
| Local Ollama backend | `uv tool install "graphifyy[ollama]"` |
| Leiden clustering | `uv tool install "graphifyy[leiden]"` |

Combine extras, for example `uv tool install "graphifyy[mcp,watch]"`. If uv reports an existing installation, use its `--reinstall` option to replace that tool environment with the requested extras.

## Upgrade

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

Re-run registration for the assistants you use so their skill files match the package. If you installed git hooks, run `graphify hook install` again after moving or reinstalling the Python environment.

## Command not found

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

Then open a new terminal. With pipx, run `pipx ensurepath`. If an MCP client cannot find Graphify, use an absolute executable path in its configuration.

## Remove a registration

```bash theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
graphify uninstall --project --platform codex
```

`graphify uninstall` removes user registrations across platforms. The optional `--purge` flag also deletes `graphify-out/`; omit it to preserve your graph.

> **[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.

[PreviousYour first knowledge graph](https://docs.graphify.com/open-source/quickstart.md)
[NextTroubleshooting](https://docs.graphify.com/open-source/troubleshooting.md)


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