@umarise/cli
v1.3.1
Published
Anchor files to Bitcoin from the command line. Generate .proof bundles for offline verification.
Downloads
1,114
Maintainers
Readme
@umarise/cli
Anchor files to Bitcoin. Verify proofs offline.
npm install -g @umarise/cliUsage
# Full lifecycle — one command, run twice
export UMARISE_API_KEY=um_your_key
umarise proof document.pdf
# First run:
# ✓ hash: sha256:a1b2c3...
# ✓ anchored: origin_id f47ac10b-58cc-4372-a567-0e02b2c3d479
# ⏳ proof pending — run again later
# Second run (after ~2 hours):
# ✓ hash: sha256:a1b2c3... (already anchored)
# ✓ origin_id: f47ac10b-58cc-4372-a567-0e02b2c3d479
# ✓ anchored in Bitcoin block 935037
# ✓ no later than: 2026-03-04
# ✓ saved: document.pdf.proof
# ✓ proof valid — independent of UmariseSame command, always does the right thing. No daemon. No state files.
Commands
umarise proof <file> — recommended
Full proof lifecycle in one command:
- Hash the file locally (SHA-256)
- Anchor the hash (or detect it's already anchored)
- Check if Bitcoin proof is ready
- If ready: download
.ots, build.proofZIP, verify locally
Idempotent — run it as many times as you want on the same file.
umarise anchor <file> — plumbing
Hash and anchor only. Creates a .proof ZIP immediately (proof may still be pending).
umarise anchor document.pdfumarise verify <file> [proof] — plumbing
Verify a file against its .proof bundle. Tries offline verification first (OpenTimestamps), falls back to online.
umarise verify document.pdf
# or explicitly:
umarise verify document.pdf document.pdf.proofOutput
Verify
✓ hash matches
✓ anchored in Bitcoin block 883421
✓ no later than: 2026-03-04
✓ proof valid — independent of UmariseProof bundle (self-proving artifact)
<file>.proof is a ZIP containing:
certificate.json— origin metadata (hash, timestamp, origin_id, block height)proof.ots— OpenTimestamps proof (Bitcoin anchor)artifact.{ext}— the original file (hash-verified before inclusion) (v1.3.0+)VERIFY.txt— human-readable verification instructions
The bundle is a self-proving artifact: everything needed to verify the proof is inside.
You can verify independently — no Umarise infrastructure needed:
unzip document.pdf.proof
sha256sum artifact.pdf # compare with certificate.json → hash
ots verify proof.ots # verify against BitcoinOr use the reference verifier: verify-anchoring.org
Changelog
- v1.3.0 — artifact inclusion: the original file is now bundled inside
.proofasartifact.{ext}, making each proof bundle a self-contained, independently verifiable evidence package.
No Umarise server needed for verification.
Configuration
| Variable | Required | Description |
|---|---|---|
| UMARISE_API_KEY | For proof and anchor | Partner API key (um_...) |
Or pass --api-key <key> to the command.
verify requires no API key — verification is a public utility.
What this CLI does NOT do
- Store files (hash-only, bytes never leave your system)
- Manage accounts or sessions
- Interpret content or meaning
- Replace legal processes
License
Unlicense (Public Domain)
