1
1
# Install
2
2
3
- To use OpenVM for generating proofs, you must install the OpenVM command line tool ` cargo-openvm ` .
4
-
5
- ` cargo-openvm ` can be installed in two different ways. You can either install via git URL or build from source .
3
+ To use OpenVM for generating proofs, you must install the OpenVM command line tool ` cargo-openvm `
4
+ either via Git URL or by cloning the repo and building from source manually. Prior to either
5
+ approach, you should make sure you have installed the necessary [ Prerequisites ] ( #installation-prerequisites ) .
6
6
7
7
## Option 1: Install Via Git URL (Recommended)
8
8
9
9
Begin the installation:
10
10
11
11
``` bash
12
- cargo +1.86 install --locked --git http ://github.com/openvm-org/openvm.git --tag v1.4.0-rc.4 cargo-openvm
12
+ cargo +1.86 install --locked --git https ://github.com/openvm-org/openvm.git --tag v1.4.0-rc.4 cargo-openvm
13
13
```
14
14
15
15
This will globally install ` cargo-openvm ` . You can validate a successful installation with:
@@ -34,11 +34,36 @@ This will globally install `cargo-openvm`. You can validate a successful install
34
34
cargo openvm --version
35
35
```
36
36
37
- ## Install Rust Toolchain
37
+ ## Installation Prerequisites
38
38
39
- In order for the ` cargo-openvm ` build command to work, you must install certain Rust nightly components :
39
+ Prior to installing ` cargo-openvm ` , make sure you have the following packages installed :
40
40
41
- ``` bash
41
+ :::code-group
42
+
43
+ ``` bash [Ubuntu]
44
+ # install Rust
45
+ curl --proto ' =https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
46
+ . " $HOME /.cargo/env"
47
+
48
+ # install nightly Rust toolchain for binary builds
42
49
rustup install nightly-2025-02-14
43
50
rustup component add rust-src --toolchain nightly-2025-02-14
51
+
52
+ # install build tools for Ubuntu
53
+ sudo apt update
54
+ sudo apt install -y build-essential # gcc, g++, make, libc headers
44
55
```
56
+
57
+ ``` bash [macOS]
58
+ # install Rust
59
+ curl --proto ' =https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
60
+ . " $HOME /.cargo/env"
61
+
62
+ # install nightly Rust toolchain for binary builds
63
+ rustup install nightly-2025-02-14
64
+ rustup component add rust-src --toolchain nightly-2025-02-14
65
+
66
+ # install build tools for macOS
67
+ xcode-select --install
68
+ brew install cmake git curl
69
+ ```
0 commit comments