shiplog
Review evidence loop for people who need receipts, not review prose.
shiplog turns work evidence into a review-readiness loop: diagnose setup, inspect status, collect receipts, repair gaps, rerun, compare, and share safely.
Install
With optional LLM-assisted workstream clustering:
Prerequisites: Rust 1.95+. Token-backed sources use environment variables such
as GITHUB_TOKEN, GITLAB_TOKEN, JIRA_TOKEN, or LINEAR_API_KEY; local git,
JSON, and manual evidence can run without provider tokens.
What you get
| Surface | Command |
|---|---|
| Setup preflight | shiplog doctor --setup |
| Agent setup state | shiplog doctor --setup --json |
| Review-loop status | shiplog status --latest |
| Agent review state | shiplog status --latest --json |
| Evidence intake | shiplog intake --last-6-months --explain |
| Repair queue | shiplog repair plan --latest |
| Local journal repair | shiplog journal add --from-repair <repair_id> |
| Repair movement | shiplog repair diff --latest |
| Packet movement | shiplog runs diff --latest |
| Share posture | shiplog share explain manager --latest |
| Full GitHub history | shiplog github activity plan |
First useful loop
Start with setup and status:
Collect the first packet:
Repair and compare when status says the packet needs evidence:
Read vs write
Read-only commands:
shiplog doctor --setupshiplog sources statusshiplog doctor --setup --jsonshiplog status --latestshiplog status --latest --jsonshiplog repair plan --latestshiplog repair diff --latestshiplog runs diff --latestshiplog share explain manager --latestshiplog github activity status --out ./out/github-full
Write-producing commands:
shiplog init --guidedshiplog intake --last-6-months --explainshiplog journal add --from-repair <repair_id>shiplog github activity report --out ./out/github-fullshiplog github activity merge --out ./out/github-full- explicit
shiplog share manager|publicrendering commands
doctor, status, and share explain do not render profile artifacts. Use
explicit share commands only after share explanation or verification says the
profile is ready.
Agent-readable surfaces
shiplog doctor --setup --jsonexposes setup readiness without provider probing, writes, or secret values.shiplog status --latest --jsonexposes the review-loop state, blockers, next actions, write posture, and receipt references without scraping terminal prose.shiplog report export-agent-pack --latestexports report receipts for support and automation workflows.
Agents should consume JSON receipts, not packet.md or terminal prose.
Read next
| Need | Doc |
|---|---|
| First run | Rapid first-intake guide |
| Setup | Guided setup and doctor guide |
| Recurring use | Recurring review-loop guide |
| Full GitHub history | GitHub activity harvest guide |
| Repair | Evidence repair loop guide |
| Review-ready packet and share posture | Review-ready packet guide |
| Configuration | Config reference |
| Status JSON contract | Review-loop status schema |
| Release history | CHANGELOG |
What shiplog does not do
- Does not write performance-review prose.
- Does not score employees.
- Does not mutate provider records.
- Does not query providers from
doctororstatus. - Does not render manager/public packets from
statusorshare explain. - Does not enable optional LLM clustering unless built with
--features llmand configured explicitly.
License
Dual licensed under MIT OR Apache-2.0, at your option.