Install

To use OpenVM for generating proofs, you must install the OpenVM command line tool cargo-openvm.

cargo-openvm can be installed in two different ways. You can either install via git URL or build from source.

Begin the installation:

cargo install --locked --git http://github.com/openvm-org/openvm.git --tag v1.0.0 cargo-openvm

This will globally install cargo-openvm. You can validate a successful installation with:

cargo openvm --version

Option 2: Build from source

To build from source, clone the repository and begin the installation.

git clone --branch v1.0.0 --single-branch https://github.com/openvm-org/openvm.git
cd openvm
cargo install --locked --force --path crates/cli

This will globally install cargo-openvm. You can validate a successful installation with:

cargo openvm --version

Install Rust Toolchain

In order for the cargo-openvm build command to work, you must install certain Rust nightly components:

rustup install nightly-2025-02-14
rustup component add rust-src --toolchain nightly-2025-02-14