shipbrief

name	shipbrief
description	Generate readable daily follow-ups from local git commits using compact AXI/TOON output.

Shipbrief

Use shipbrief when the user wants a daily commit follow-up, Telegram digest, or agent-readable summary of local git work.

Commands

npx -y shipbrief run --today

This prints compact TOON:

• shipbrief summary
• quality commit metadata counts
• projects[]
• commits[]
• notes[]
• descriptions[]

Write the final human report yourself before sending it anywhere. Do not send raw output unless the user asks.

Save the final report as HTML, then delegate validation/chunking/sending to Shipbrief:

npx -y shipbrief check --html report.html
npx -y shipbrief deliver --provider telegram --html report.html

Use full JSON only when needed:

npx -y shipbrief run --today --format json --full

Check setup:

npx -y shipbrief doctor

Safety

shipbrief is read-only for repositories. Do not run git fetch, git pull, git push, git checkout, or git reset as part of a follow-up report.

Keep reports grouped by project. Mention quality issues such as commits without bodies when quality.without_body is high.

Do not call Telegram, email, Slack, or webhook APIs directly when a Shipbrief delivery provider exists. Use shipbrief deliver --provider ....