Skip to Content

CLI

@clearproof/cli provides local proof generation, verification, the pilot commands and a synthetic demo. Published npm version: 0.7.2, checked October 7, 2026. It requires Node.js 22.12 or later.

Install

npm install -g @clearproof/cli clearproof --help

Installation from npm was verified on September 26, 2026. You can also build from a source checkout; see quickstart.

Proof workflows

With compatible artifacts and a complete input for that proof version:

clearproof prove --input inputs.json --artifacts ./artifacts --output proof.json clearproof verify --proof proof.json --artifacts ./artifacts

The current verifier reports cryptographic validity and interpreted circuit outputs. Its success exit code is not equivalent to on-chain registry acceptance or authorization to move funds.

Synthetic demo

clearproof demo --artifacts ./artifacts

The demo needs legacy development artifacts that match the current circuit. No npm package supplies them: generate them with scripts/test_development_circuits.py <new-directory> from a source checkout and pass --artifacts <new-directory>/legacy. (clearproof demo in CLI 0.5.0 tried the artifacts in @clearproof/circuits 0.3.0, which predate a circuit fix and fail witness generation; 0.6.0 fixes this.)

The demo uses synthetic, historical inputs and development artifacts. It demonstrates a local proof workflow; it does not establish fresh sanctions state, live credential authenticity, current policy acceptance or safe transfer execution. Artifact presence and compatibility must be checked first. No fixed completion-time claim is made.

Pilot commands

These commands are in 0.7.2 and the source checkout (report from 0.6.0). Most call the authenticated pilot API; verify-history and doctor run offline.

CommandPurpose
doctorInspect pinned local artifacts without downloading, proving or authorizing
inspect-currentInspect a pilot proof against current state; never consumes
authorize-currentConsume one local pilot authorization, or recover its receipt; no fund execution
observationCreate or read non-enforcing observations and cohort reports
policy diffCompare a proposed policy and write a tenant-private report
investigationRead tenant-private timelines and ageing queues
counterpartySimulate a local bilateral disposition
verify-historyReview an encrypted evidence export offline with a separately held reviewer key
reportPrint a pre-filled GitHub issue link with versions and platform; nothing is sent. See report an issue

Private inputs (proofs, requests, keys) are read from stdin rather than command-line arguments.

See quickstart and project status.

Last updated on