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.

You will need the nightly toolchain. You can install it with:

rustup toolchain install nightly

Then, begin the installation.

cargo +nightly install --git http://github.com/openvm-org/openvm.git 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, you will need the nightly toolchain. You can install it with:

rustup toolchain install nightly

Then, clone the repository and begin the installation.

git clone https://github.com/openvm-org/openvm.git
cd openvm
cargo +nightly install --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-2024-10-30
rustup component add rust-src --toolchain nightly-2024-10-30