Set Up an Agent

Entire installs repository-level hooks for each AI coding agent you use. Agent hooks capture session events, while Entire’s Git hooks connect the captured session to commits.

Before You Start

Install the Entire CLI and your preferred agent integration. Run these commands from a Git repository after you enable Entire.

Install Agent Hooks

Pass the integration’s agent name to entire agent add:

entire agent add AGENT_NAME

For example:

entire agent add codex

You can install hooks for more than one agent in the same repository. Each integration keeps its configuration in the agent’s project directory. During initial Entire setup, select an agent with:

entire enable --agent codex

Agent Integrations

An agent integration adds support for a coding agent through an executable named entire-agent-<name>. A CLI plugin uses entire-<name> and adds a command instead. Add the agent integration executable to your $PATH and enable discovery in .entire/settings.json:

.entire/settings.json

{
  "external_agents": true
}

Entire includes discovered integrations in entire agent list. During setup, pass the external agent’s name without the entire-agent- prefix:

entire enable --agent AGENT_NAME

See the Agent Integration Protocol for the protocol and its security considerations.

Install CLI-Managed Skills

entire agent add can also install two repository-level skills:

entire agent add codex --agent-help-skill --search-skill

Flag	Installs
`--agent-help-skill`	A skill that directs the agent to `entire agent-help` for usage that matches the installed CLI
`--search-skill`	A skill that helps the agent run `entire search --json`

These flags install the CLI-managed helpers. See Install Skills for the Entire Skills collection.

Hook Locations

Agent	Project Configuration
Claude Code	`.claude/settings.json`
Codex	`.codex/hooks.json`
Copilot CLI	`.github/hooks/entire.json`
Cursor	`.cursor/hooks.json`
Factory	`.factory/settings.json`
Gemini CLI	`.gemini/settings.json`
OpenCode	`.opencode/plugins/entire.ts`
Pi	`.pi/extensions/entire/index.ts`

Entire preserves unrelated configuration when it adds JSON hooks. OpenCode and Pi use generated TypeScript files that Entire can reinstall when their templates change.

Verify Capture

List the installed integrations and inspect the repository:

entire agent list
entire status --detailed

Start a new agent session from the repository after installing hooks. Existing agent processes do not load hooks added after they started. Commit a file change to create a checkpoint, then inspect it:

git add .
git commit -m "Describe the change"
entire checkpoint list

See Checkpoint Storage for where Entire writes checkpoint data.

Reinstall or Remove Hooks

Reinstall missing, stale, or modified hooks with:

entire agent add AGENT_NAME --force

Remove Entire’s hooks for one integration with:

entire agent remove AGENT_NAME

Removing one integration leaves other agent hooks and Entire’s Git hooks in place.

Troubleshoot Capture

Run entire doctor when entire status --detailed does not show a session you started. Confirm that the integration’s configuration file exists, restart the agent, and run it from inside the repository. Each agent page documents limitations on transcript capture, token usage, subagent capture, session resume, and transcript import. Use the capability matrix to find the relevant page.

​Before You Start

​Install Agent Hooks

​Agent Integrations

​Install CLI-Managed Skills

​Hook Locations

​Verify Capture

​Reinstall or Remove Hooks

​Troubleshoot Capture