Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.entire.io/llms.txt

Use this file to discover all available pages before exploring further.

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 Droid, 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. 
# Stable
brew tap entireio/tap
brew install --cask entire

# Nightly
brew tap entireio/tap
brew install --cask entire@nightly
Verify the installation: 
entire version

​
2. Create a Demo Project

mkdir entire-demo
cd entire-demo
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. This example uses Codex; replace codex with your agent from the table below. 
entire enable -y --agent codex
AgentSetup flagStart command
Claude Code--agent claude-codeclaude
Codex--agent codexcodex
Copilot CLI--agent copilot-clicopilot
Cursor--agent cursorcursor
Factory Droid--agent factoryai-droiddroid
Gemini CLI--agent geminigemini
OpenCode--agent opencodeopencode
Pi--agent pipi
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. See Project and local files for what can stay local.
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 agent you selected: 
# Example with Claude Code
claude

# Example with Codex
codex

# Example with Copilot CLI
copilot

# Example with Cursor
cursor

# Example with Factory Droid
droid

# Example with Gemini CLI
gemini

# Example with OpenCode
opencode

# Example with Pi
pi
Prompt it to make a small change: 
Create a file named hello-entire.md with a short note explaining that this repo is my first Entire checkpoint demo.
When the agent finishes, exit the agent session if needed.

​
5. Commit the Change

Check what changed: 
git status
Then commit it: 
git add hello-entire.md
git commit -m "Add first Entire demo file"
Because Entire detected recent agent work, it may ask whether to link this commit to the session context: 
Entire: Active Codex session detected
  Last prompt: Create a file named hello-entire.md with a short note...

Link this commit to session context?
  [Y]es / [n]o / [a]lways (remember my choice):
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

entire checkpoint list
You should see the checkpoint linked to your commit. Entire stores permanent checkpoint data on a Git branch named: 
entire/checkpoints/v1
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: 
git push
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