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

# Install and Enable entire-graph

> Install entire-graph on your machine, add its instructions to a repository, and verify your coding agent can use it.

## Before You Start

Make sure you have:

* [Entire CLI installed](/installation) and [updated](/installation#install-and-update-entire) to version 0.10.0 or later
* Git 2.36 or later on your `PATH`
* a local Git repository
* a coding agent that reads instructions from `AGENTS.md` or `CLAUDE.md`

> [!NOTE]
>
> entire-graph requires Git 2.36 or later because it uses the single-session
> object protocol that version added to check an object's type before reading
> its contents. Run `git --version` to check your version. If it is older,
> queries fail with a `git cat-file --batch-command` error; see [entire-graph
> Troubleshooting](/guides/graph/troubleshooting#install-and-setup).

## 1. Install entire-graph

Install entire-graph on your machine with the Entire CLI:

```bash theme={null}
entire plugin install graph
```

Verify the installation with [`entire graph version`](/cli-reference/graph#graph-version):

```bash theme={null}
entire graph version
```

If the command prints a version number, entire-graph is installed. See [`entire plugin`](/cli-reference/plugin) to install a specific version, upgrade entire-graph, or remove it from your machine.

## 2. Enable entire-graph in Your Repository

entire-graph needs to add instructions that tell your coding agent when and how to use it. From the root of your repository, run [`entire graph init-agents`](/cli-reference/graph#graph-init-agents):

```bash theme={null}
entire graph init-agents --repo .
```

This creates or updates three files, and it treats the guide differently from the two agent instruction files:

* `.entire/graph-agent.md` is the agent operating guide. entire-graph generates it in full and regenerates it in full on every successful rerun.
* `AGENTS.md` and `CLAUDE.md` are created if they do not exist. If either file is already present, entire-graph adds or replaces a single managed block between `<!-- entire-graph:begin -->` and `<!-- entire-graph:end -->` markers and preserves everything outside those markers.

> [!WARNING]
>
> Do not edit `.entire/graph-agent.md`. It is plugin-managed, so the next
> `entire graph init-agents` run overwrites it and your changes are lost. Put
> repository-specific instructions outside the `entire-graph` markers in
> `AGENTS.md` or `CLAUDE.md` instead, where reruns preserve them.

## 3. Commit the Instruction Files

Add the entire-graph instruction files to your repository:

```bash theme={null}
git add .entire/graph-agent.md AGENTS.md CLAUDE.md
git commit -m "Enable entire-graph"
```

Committing these files gives everyone working in the repository the same entire-graph instructions.

## 4. Start a New Coding Agent Session

Start a new session from your repository to load the entire-graph instructions.

## 5. Verify entire-graph Is Working

Ask your coding agent to find code or trace a relationship in the repository. For example:

```text theme={null}
Use entire-graph to find where route matching is implemented and trace what calls it.
```

Your agent should run a entire-graph command, inspect the relevant source files, and include specific file locations in its answer.

If your agent does not use entire-graph or the command fails, see [entire-graph Troubleshooting](/guides/graph/troubleshooting).

## Continue With

> **[Use entire-graph with Your Coding Agent](/guides/graph/use-graph)**
>
> Learn what to ask and what happens after you prompt your agent.

> **[How entire-graph Works](/guides/graph/how-graph-works)**
>
> Learn how entire-graph maps your code and guides your agent.

> **[entire-graph CLI Reference](/cli-reference/graph)**
>
> Review entire-graph commands and options.

> **[entire-graph Troubleshooting](/guides/graph/troubleshooting)**
>
> Fix installation, agent adoption, and cache problems.
