Ship Receipts

Getting started · Runway · Game mode · Concepts · Docs index

CLI and JSON schema for recording work you actually shipped.

Why it exists

Receipts over vibes: a receipt says what shipped, where it lives, who claims it, and how someone else can check it.

Features

• 🧾 Local receipts — create small, machine-readable claims for shipped work.
• ✅ Validation — check schema shape and optional content hashes.
• 📈 Scoring — track local state, streaks, goals, and daily progress.
• 🛫 Runway export — build a static timeline from receipts or recent git history.
• ⏱️ OpenTimestamps — anchor receipt digests with scoped timestamp proofs.
• 🎮 Optional game layer — reward better proof, not more busywork.

It is not a social network, badge farm, or global reputation service. This repo is the local evidence layer; the separate proofofship verifier is the global verification layer.

Quickstart

Run the CLI:

npx ship-receipts --help

Develop locally:

npm install
npm run build
npm test

Example workflow

Create a receipt:

ship-receipts create \
  --name "ship-receipts" \
  --kind repo \
  --url "https://github.com/Spitfire-Cowboy/ship-receipts" \
  --subject "Example Builder" \
  --output receipt.json \
  --hash

Validate it:

ship-receipts validate receipt.json

Score it into local state:

ship-receipts score receipt.json
ship-receipts streak

Build a static runway from recent git history:

ship-receipts runway build --from-git --days 30 --output-dir .runway

Preview

More information

• Getting started
• Runway guide
• Game mode guide
• Concepts
• OpenTimestamps setup
• Local/global trust boundary
• Repo map
• Release checklist
• Docs index

License

Apache 2.0. See LICENSE.