shipnote logoshipnote

CLI reference

shipnote on your machine

The CLI downloads the nightly dataset and selects the commits worth a post. Drafting and review come later.

Requirements

Bun, git, and the GitHub CLI signed in with gh auth login.

fetch

Downloads the newest successful nightly run, or the run you name, into archive/<date>/. If that date is already archived, it does nothing.

bun cli/shipnote.ts fetch
bun cli/shipnote.ts fetch --date 2026-10-30 --run 41067258484

select

Reads the archive for a date and prints the commits ranked by score. Merges, lockfile-only changes, commits in ledger.json, and denylisted repos are skipped, and each skip reason is counted.

bun cli/shipnote.ts select
bun cli/shipnote.ts select --date 2026-10-30

Settings

VariableDefaultPurpose
SHIPNOTE_REPOabhiudayg/shipnoteThe repo whose artifacts fetch downloads. Set it to your fork.
SHIPNOTE_DENYLISTemptyComma-separated repos to exclude from selection.

Coming next

Drafting, review, and approval commands. The CLI does not read shipnote.toml yet.