Skip to main content

​
Prerequisites

  • Git installed and configured
  • An AI coding assistant (Claude Code, Codex, Gemini CLI, OpenCode, or Factory Droid)
  • macOS, Linux, Windows

​
Installation

Entire currently ships two release channels:
  • stable: recommended for most users.
  • nightly: prerelease builds with newer changes.
Both Homebrew channels are distributed as casks. 
# Stable
brew tap entireio/tap
brew install --cask entire

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

​
Enable Entire in Your Repository

Navigate to any Git repository and enable Entire: 
cd your-project
entire enable
This installs Git hooks that automatically capture checkpoints as you work with AI agents.
Entire captures checkpoints when you make commits, without adding extra commits to your branch. See Checkpoints for details.

​
Start a Coding Session

Now, use your AI coding assistant as you normally would: 
# Example with Claude Code
claude

# Example with Codex
codex

# Example with Gemini CLI
gemini

# Example with OpenCode
opencode

# Example with Factory Droid
droid
At this point you have Entire enabled in your repo! From now on, when your agent makes changes and you commit them, your commit is automatically linked to a checkpoint containing the full session context. On your next push to remote, your checkpoints will be pushed as well.

​
What’s Next?

Core Concepts

Learn about sessions, checkpoints, and how Entire works

CLI Commands

Explore all available CLI commands

Checkpoints

Learn how Entire captures your sessions

Integrations

Set up your AI coding assistant