Skip to main content
This quickstart walks you from installing Entire to creating your first checkpoint: a record of the prompts, transcript, tool calls, and file changes behind an AI-assisted commit.

​
Prerequisites

  • Git installed and configured
  • An AI coding agent installed, 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 and the Linux install script. Scoop currently supports stable only.
Verify the installation:

​
2. Create a Demo Project

Already in a Git repository? Skip this step and run the remaining commands from the repository root.

​
3. Enable Entire

Choose the agent you already use, then run its setup command.
This installs Git hooks that capture checkpoints when you commit and installs hook configuration for your selected agent. It also creates a .entire/ directory for project and local settings. For shared projects, commit .entire/settings.json and .entire/.gitignore. Keep .entire/settings.local.json local for personal overrides.
Because this starts in a new folder, entire enable -y initializes Git and creates an initial commit. If gh is installed and authenticated, Entire can also create a private GitHub repository and push the initial commit.

​
4. Start an Agent Session

Start the same agent you enabled:
Prompt it to make a small change:
When the agent finishes, exit the agent session if needed.

​
5. Commit the Change

Check what changed:
Then commit it:
Because Entire detected recent agent work, it may ask whether to link this commit to the session context. The agent name will match the integration you enabled:
Press Enter or type y to link the commit. After the commit succeeds, you have created your first checkpoint.
If you choose always, Entire remembers that preference and links future matching commits automatically.

​
6. View Your First Checkpoint

You should see the checkpoint linked to your commit. Entire stores permanent checkpoint data on a Git branch named:
Your working branch stays clean. Entire does not add extra commits to it.

​
7. Optional: Push Your Code and Checkpoint

If your repository has a remote, push your code:
Entire’s pre-push hook also syncs checkpoint data to entire/checkpoints/v1.
Checkpoint data can include session context. If your repository is public, pushed checkpoint history is public too. See Security & Privacy and Checkpoint Remote.

​
What’s Next?

Glossary

Learn the terms used across Entire

CLI Commands

Explore all available CLI commands

Checkpoints

Learn how Entire captures your sessions

Agents

Set up your AI coding agent