Skip to content

docs: Document --checkpoint-repo flag [doc-updater] #846

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jwbron merged 2 commits into from
Feb 21, 2026
Merged

docs: Document --checkpoint-repo flag [doc-updater] #846

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2f2b993
docs: Document --checkpoint-repo flag in checkpoint guide
jwbron Feb 21, 2026
69795aa
docs: Improve checkpoint-repo bullet formatting per review
egg-reviewer[bot] Feb 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/guides/checkpoint-access.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@

Checkpoints capture agent session context (transcripts, tool calls, files touched, token usage) as versioned JSON on the `egg/checkpoints/v2` git branch. In multi-agent pipelines, checkpoints enable agents to discover what other agents did, what files they touched, and how many tokens they used.

## Global Options

All `egg-checkpoint` commands support these top-level options:

- `--repo-path PATH` — Repository path (defaults to `EGG_REPO_PATH` or current directory)
- `--checkpoint-repo OWNER/REPO` — External checkpoint repository in `owner/repo` format. Overrides auto-detection from repository settings.
Use this when querying checkpoints from a different repository than the current one.

## When to Use Checkpoints

- **Reviewing another agent's work**: See what a coder agent did before writing tests
Expand Down
Loading