-
Install the Axiom CLI:
cargo install --locked --git https://github.com/axiom-crypto/axiom-api-cli.git --tag v0.3.0 cargo-axiomOr from source:
git clone https://github.com/axiom-crypto/axiom-api-cli cd axiom-api-cli cargo install --locked --force --path .
-
Initialize with your API key:
cargo axiom init --api-key <API_KEY>
Alternatively, set the
AXIOM_API_KEYenvironment variable in a.envfile and then runcargo axiom initat the directory of the.envfile. See.env.examplefor an example.
-
Navigate to your program directory (containing a Rust workspace with an OpenVM guest program).
-
Build your program:
cargo axiom build
This uploads your code and triggers a reproducible build on Axiom's servers.
-
Check build status:
cargo axiom build status --program-id <PROGRAM_ID>
-
Request a proof for your program:
cargo axiom prove --program-id <PROGRAM_ID> --input <INPUT>
-
Check proof generation status:
cargo axiom prove status --proof-id <PROOF_ID>
-
Download proof logs if needed:
cargo axiom prove logs --proof-id <PROOF_ID>
-
Download proof artifacts:
cargo axiom prove download --proof-id <PROOF_ID> --type evm
-
Verify a proof:
cargo axiom verify --proof <PROOF_FILE>
-
Check verification status:
cargo axiom verify status --verify-id <VERIFY_ID>
For more details, see the Axiom API Documentation.