shiplog

Review evidence loop for people who need receipts, not review prose.

Current shipped release: v0.11.0.

shiplog turns work evidence into a review-readiness habit: capture context, refresh receipts, inspect gaps, and share safely.

Install

cargo install shiplog --locked

With optional LLM-assisted workstream clustering:

cargo install shiplog --locked --features llm

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
First packet	`shiplog intake`
Home screen	`shiplog`
Quick context	`shiplog add "what changed"`
Evidence refresh	`shiplog update`
Safe next action	`shiplog next`
Current packet	`shiplog open`
Manager/public share	`shiplog share manager` / `shiplog share public`
Review-loop status	`shiplog status --latest`
Full GitHub history	`shiplog github activity plan`

First useful loop

Start with the first packet. Setup files are created automatically when they are needed, and provider credentials are optional:

shiplog intake

Open the packet when you want to read it immediately:

shiplog open

Normal recurring use:

shiplog add "Resolved the customer import retry incident" \
  --impact "Protected the next import window"
shiplog update
shiplog open
shiplog

For setup troubleshooting or agent automation, use doctor --setup, sources status, and status --latest --json as read-only diagnostics.

Repair and compare when status says the packet needs evidence:

shiplog repair plan --latest
shiplog journal add --from-repair <repair_id>
shiplog intake --last-6-months --explain
shiplog repair diff --latest
shiplog runs diff --latest
shiplog share explain manager --latest

Read vs write

Read-only commands:

shiplog doctor --setup
shiplog sources status
shiplog doctor --setup --json
shiplog status --latest
shiplog status --latest --json
shiplog next / shiplog next --json
shiplog
shiplog repair plan --latest
shiplog repair diff --latest
shiplog runs diff --latest
shiplog share explain manager --latest
shiplog github activity status --out ./out/github-full

Write-producing commands:

shiplog init --guided
shiplog intake --last-6-months --explain
shiplog add "what changed"
shiplog update
shiplog journal add --from-repair <repair_id>
shiplog github activity report --out ./out/github-full
shiplog github activity merge --out ./out/github-full
explicit shiplog share manager|public rendering 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 --json exposes setup readiness without provider probing, writes, or secret values.
shiplog status --latest --json exposes the review-loop state, blockers, next actions, write posture, and receipt references without scraping terminal prose.
shiplog report export-agent-pack --latest exports report receipts for support and automation workflows.

Agents should consume JSON receipts, not packet.md or terminal prose.

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 doctor or status.
Does not render manager/public packets from status or share explain.
Does not enable optional LLM clustering unless built with --features llm and configured explicitly.

License

Dual licensed under MIT OR Apache-2.0, at your option.

shiplog 0.11.0