Skip to main content

​
Before You Start

Make sure you have:
  • Entire CLI installed and updated 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
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.

​
1. Install entire-graph

Install entire-graph on your machine with the Entire CLI:
Verify the installation with entire graph version:
If the command prints a version number, entire-graph is installed. See entire 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:
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.
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:
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:
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.

​
Continue With

Use entire-graph with Your Coding Agent

Learn what to ask and what happens after you prompt your agent.

How entire-graph Works

Learn how entire-graph maps your code and guides your agent.

entire-graph CLI Reference

Review entire-graph commands and options.

entire-graph Troubleshooting

Fix installation, agent adoption, and cache problems.