Back to docs

CLI reference

The public proofofship CLI is the first shipped product surface in this repo.

Install

pip install -e '.[dev]'

Surface checks

proofofship validate --json
proofofship check-public-surface --json

proofofship weight <age_days>

Compute the recency weight for a receipt age.

proofofship weight 45 --json

proofofship score <receipts_file>

Compute a public score payload with lifetime reputation and recent activity.

proofofship score examples/score.sample.json --handle example-builder --json

proofofship receipts <handle> <receipts_file>

Emit a public receipts payload for a profile handle.

proofofship receipts example-builder examples/score.sample.json --json

proofofship badge <verified|receipts> <handle>

Emit badge URLs or Markdown for third-party repository embeds.

proofofship badge verified example-builder --markdown

proofofship urls <handle>

Print canonical public profile URLs.

proofofship urls example-builder --json