entire-cli

name: entire-cli description: Use when you need to capture AI coding sessions with Entire.io, manage checkpoints, rewind to previous states, explain commits, or troubleshoot Entire CLI issues. Covers all Entire CLI commands, configuration, and agent integrations (Claude Code, Gemini CLI, OpenCode, Cursor, Factory Droid).

Entire CLI — AI Session Capture for Git

Entire hooks into your Git workflow to capture AI agent sessions as checkpoints — snapshots of prompts, responses, file changes, and token usage stored on a dedicated Git branch (entire/checkpoints/v1).

Important: All entire commands must be run inside a Git repository. The CLI modifies Git hooks and branches — never run in repos you don't control without understanding the implications.

Quick Start

# Install
brew install entireio/tap/entire          # macOS
curl -fsSL https://entire.io/install.sh | bash  # Linux

# Enable in a project
cd my-project
entire enable --agent opencode   # or: claude-code, gemini, cursor, factoryai-droid

# Work normally with your AI agent — Entire captures sessions automatically

# Check status
entire status --detailed

# Rewind to a previous checkpoint
entire rewind

# Explain what happened in a commit
entire explain --commit HEAD

# Push to share sessions on entire.io
git push

Core Concepts

Session: A complete interaction with an AI agent (ID format: YYYY-MM-DD-<UUID>)
Checkpoint: A save point within a session you can rewind to (12-char hex ID like a3b2c4d5e6f7)
Shadow Branch: Temporary branch (entire/<sessionID>-<worktreeID>) storing checkpoints during active sessions — auto-cleaned
Checkpoints Branch: Permanent branch entire/checkpoints/v1 storing all finalized session metadata — pushed to remote
Line Attribution: Tracks agent vs human contribution per commit (e.g. Entire-Attribution: 73% agent (146/200 lines))
Strategy: manual-commit — only your commits appear in history, no auto-generated noise

Command Quick Reference

Command	Purpose	Key Flags
`entire enable`	Initialize Entire in repo	`--agent <name>`, `--force`, `--local`
`entire disable`	Remove hooks	`--uninstall`, `--force`
`entire status`	Show current state	`--detailed`
`entire rewind`	Roll back to checkpoint	`--to <commit>`, `--list`
`entire resume <branch>`	Resume session on branch	`--force`
`entire explain`	AI-powered commit explanation	`--commit <sha>`, `--full`, `--generate`, `--short`
`entire doctor`	Fix stuck sessions	`--force`
`entire clean`	Remove orphaned data	`--dry-run`
`entire reset`	Delete shadow branch & state	`--force`
`entire version`	Show build info	—

For full command details with all flags and examples: references/commands.md

Configuration

Layered config system (highest priority first):

.entire/settings.local.json — personal overrides (gitignored)
.entire/settings.json — project settings (committed)
~/.config/entire/settings.json — global defaults

{
  "enabled": true,
  "log_level": "info",
  "telemetry": true,
  "strategy_options": {
    "push_sessions": true,
    "summarize": { "enabled": false }
  }
}

Environment variables: ENTIRE_ENABLED, ENTIRE_LOG_LEVEL, ENTIRE_TELEMETRY, ACCESSIBLE=1

For full configuration reference: references/configuration.md

Agent Integrations

Agent	Enable Command	Hook Location	Status
Claude Code	`entire enable --agent claude-code`	`.claude/settings.json`	Stable
Gemini CLI	`entire enable --agent gemini`	`.gemini/settings.json`	Preview
OpenCode	`entire enable --agent opencode`	`.opencode/plugins/entire.ts`	Preview
Factory Droid	`entire enable --agent factoryai-droid`	`.factory/settings.json`	Preview
Cursor	`entire enable --agent cursor`	`.cursor/hooks.json`	Preview

Multiple agents can be enabled simultaneously — hooks are independent per agent.

For integration details: references/integrations.md

Common Workflows

Enable & Capture Sessions

entire enable --agent opencode
# Work with your agent... sessions are captured automatically
entire status --detailed    # Check what's being tracked

Rewind a Mistake

entire rewind --list        # See available checkpoints
entire rewind --to a3b2c4d  # Roll back to specific checkpoint
# Or just: entire rewind    # Interactive selection

Understand What Happened

entire explain --commit HEAD           # Explain last commit
entire explain --commit HEAD --full    # Full transcript
entire explain --checkpoint a3b2c4d --generate  # Generate AI summary

Fix Stuck Sessions

entire doctor          # Interactive: condense, discard, or skip each
entire doctor -f       # Auto-fix all (condense if possible, else discard)

Clean Up

entire clean --dry-run   # Preview what would be removed
entire clean             # Remove orphaned data
entire reset --force     # Nuclear option: reset current shadow branch

Resume Work on a Branch

entire resume feature/auth   # Switch to branch and restore session context

Troubleshooting

Problem	Solution
"Not a git repository"	Navigate to a Git repo first
"Entire is disabled"	Run `entire enable`
"No rewind points"	Make commits with a configured agent first
Shadow branch conflict	`entire reset --force`
SSH auth errors	`ssh-keyscan -t rsa github.com >> ~/.ssh/known_hosts`
Agent not capturing	Verify hook file exists at the expected location (see integrations table)

For detailed troubleshooting: references/troubleshooting.md

Security Notes

Session transcripts live on the entire/checkpoints/v1 branch in your repo
If the repo is public, this data is visible to everyone
Entire auto-redacts detected secrets (API keys, tokens) on write — but redaction is best-effort
Shadow branches may contain unredacted data — they are not pushed to remote
Review entire/checkpoints/v1 before pushing if your repo is public