Quickstart

This quickstart will help you get started with Entire. You will learn how to create a checkpoint that links an agent session to a Git commit and how to mirror a GitHub repository on Entire. A checkpoint stores the session context behind a change, such as the prompt, agent transcript, tool calls, and changed files. A mirror keeps GitHub as your source of truth while Entire serves the repository from a region you choose.

Before You Start

You need:

Git installed and configured
A GitHub account and a repository you can access
An AI coding agent, such as Claude Code, Codex, Copilot CLI, Cursor, Factory, Gemini CLI, OpenCode, or Pi
macOS, Linux, or Windows
Optional: GitHub CLI (gh) installed and authenticated, if you want Entire to create and push a private GitHub repository during setup

1. Install Entire

Entire ships two release channels:

stable: recommended for most users.
nightly: prerelease builds with newer changes.

Nightly is available through Homebrew, the Linux install script, and the Windows PowerShell installer. Scoop currently supports stable only.

macOS (Homebrew)
Linux
Windows
From Source

# Stable
brew install --cask entireio/tap/entire

# Nightly
brew install --cask entireio/tap/entire@nightly

# Stable
curl -fsSL https://entire.io/install.sh | bash

# Nightly
curl -fsSL https://entire.io/install.sh | bash -s -- --channel nightly

# Stable
irm https://entire.io/install.ps1 | iex

# Nightly
iex "& {$(irm https://entire.io/install.ps1)} -Channel nightly"

The script uses Scoop for stable installs when Scoop is available. See Installation for the Scoop commands and the script’s options.

go install github.com/entireio/cli/cmd/entire@latest
go install github.com/entireio/cli/cmd/git-remote-entire@latest

Check that Entire is installed:

entire version

For other installation options, see Installation.

2. Open a Repository and Enable Entire

Use an existing GitHub repository, or create a new folder for a demo.

Existing repository
New demo repository

Clone the repository, then enter it:

git clone [email protected]:OWNER/REPOSITORY.git
cd REPOSITORY

Create and enter a folder:

mkdir entire-demo
cd entire-demo

When you enable Entire in the next step, it initializes Git and creates an initial commit. If you have GitHub CLI installed and signed in, it also creates and pushes a private GitHub repository.

Choose the agent you use and run its setup command:

Claude Code

entire enable -y --agent claude-code

Codex

entire enable -y --agent codex

Copilot CLI

entire enable -y --agent copilot-cli

Cursor

entire enable -y --agent cursor

Factory

entire enable -y --agent factoryai-droid

Gemini CLI

entire enable -y --agent gemini

OpenCode

entire enable -y --agent opencode

entire enable -y --agent pi

Entire installs hooks that capture your agent’s work and link it to Git commits.

entire enable creates .entire/settings.json and .entire/.gitignore so collaborators share project settings. Entire keeps .entire/settings.local.json local for personal overrides.

3. Create Your First Checkpoint

Start your agent from the repository root and give it a small task:

Create a file named hello-entire.md with a short note explaining that this is my first Entire checkpoint.

When the agent finishes, commit the change:

git add hello-entire.md
git commit -m "Add first Entire checkpoint"

Entire asks whether to link the commit to the agent session:

Entire: Active <agent> session detected

Link this commit to session context?
  [Y]es / [n]o / [a]lways (remember my choice):

Press Enter or type y. You have created a checkpoint. It links the commit to the prompt, transcript, tool calls, and files from the agent session. View it with:

entire checkpoint list

Choose always at the commit prompt if you want Entire to link future agent-assisted commits automatically.

Checkpoint storage depends on the repository configuration. See Session Storage for storage and push behavior.

4. Mirror Your Repository

A mirror lets agents clone and pull through Entire while GitHub remains the upstream repository. Before you begin, make sure the Entire GitHub App can access the repository. An organization admin may need to approve the app. Create a mirror:

entire repo mirror create

Choose your repository and the region where you want Entire to host it. Choose a region close to your agents or one that meets your organization’s data-residency requirements. Then configure this checkout to use the mirror:

entire repo mirror use

For this quickstart, choose to replace origin. Entire saves the GitHub remote as upstream when that name is available. Check the result:

git remote -v

origin should now use an entire:// URL. Continue using Git normally:

git fetch
git push

Entire sends pushes through the mirror to GitHub. Your existing GitHub access, branch protection, and review rules still apply.

To keep origin pointed at GitHub, add Entire as a separate remote instead:

entire repo mirror use --remote entire

Continue With

Inspect Checkpoints

Review the session and decisions behind a commit.

Search Past Work

Search code, commits, and agent sessions together.

Mirrors in the CLI

Learn more about mirror regions and Git remotes.

Set Up an Agent

Configure another supported coding agent.

Getting Started

Guides

Security

Resources

Before You Start

1. Install Entire

2. Open a Repository and Enable Entire

3. Create Your First Checkpoint

4. Mirror Your Repository

Continue With

Inspect Checkpoints

Search Past Work

Mirrors in the CLI

Set Up an Agent

​Before You Start

​1. Install Entire

​2. Open a Repository and Enable Entire

​3. Create Your First Checkpoint

​4. Mirror Your Repository

​Continue With

Inspect Checkpoints

Search Past Work

Mirrors in the CLI

Set Up an Agent

Before You Start

1. Install Entire

2. Open a Repository and Enable Entire

3. Create Your First Checkpoint

4. Mirror Your Repository

Continue With