Skip to content

Commit aa20a20

Browse files
docs(book): add installation instructions for tco (#2072)
closes INT-4890
1 parent f05d3aa commit aa20a20

File tree

1 file changed

+56
-2
lines changed

1 file changed

+56
-2
lines changed

docs/vocs/docs/pages/book/getting-started/install.mdx

Lines changed: 56 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,13 +91,12 @@ svm use 0.8.19
9191

9292
:::
9393

94-
## Installation with Nvidia GPU support
94+
## Installation with Nvidia GPU Support
9595

9696
It is possible to install the OpenVM CLI with support for Nvidia GPUs. This requires installation on a machine with an Nvidia GPU and associated drivers (see [Prerequisites (CUDA)](#installation-prerequisites-cuda))
9797

9898
With this version of the CLI, the `prove app` and `prove stark` commands will utilize the Nvidia GPU for hardware acceleration. Currently only single GPU support is available through the CLI.
9999

100-
101100
### Option 1: Install Via Git URL (Recommended)
102101

103102
Begin the installation:
@@ -170,3 +169,58 @@ export LD_LIBRARY_PATH=/usr/local/cuda/lib64${LD_LIBRARY_PATH:+:${LD_LIBRARY_PAT
170169
Note that `/usr/local/cuda` is a symlink for the latest version of CUDA installed.
171170

172171
You are now ready to [install](#install-with-nvidia-gpu-support) the OpenVM CLI.
172+
173+
## Installation with Experimental Features
174+
175+
For the best execution performance, the CLI may be installed with optimizations that utilize [experimental Rust features](https://github.com/rust-lang/rust/issues/112788). These optimizations may be enabled on top of the standard CPU installation as well as the Nvidia GPU installation. We provide installation instructions for both versions, assuming the prerequisites ([CPU](#installation-prerequisites), [GPU](#installation-prerequisites-cuda)) are already met.
176+
177+
This installation requires a nightly Rust toolchain. To install the nightly toolchain, run:
178+
179+
```bash
180+
rustup install nightly-2025-08-19
181+
```
182+
183+
### Option 1: Install Via Git URL (Recommended)
184+
185+
Begin the installation:
186+
187+
:::code-group
188+
```bash [Without GPU]
189+
cargo +nightly-2025-08-19 install --locked --git https://github.com/openvm-org/openvm.git --tag v1.4.0-rc.9 --features tco cargo-openvm
190+
```
191+
```bash [Nvidia GPU]
192+
cargo +nightly-2025-08-19 install --locked --git https://github.com/openvm-org/openvm.git --tag v1.4.0-rc.9 --features tco,cuda cargo-openvm
193+
```
194+
:::
195+
196+
This will globally install `cargo-openvm`. You can validate a successful installation with:
197+
198+
```bash
199+
cargo openvm --version
200+
```
201+
202+
### Option 2: Build from source
203+
204+
To build from source, first clone the repository.
205+
206+
```bash
207+
git clone --branch v1.4.0-rc.9 --single-branch https://github.com/openvm-org/openvm.git
208+
cd openvm
209+
```
210+
211+
Then begin the installation:
212+
213+
:::code-group
214+
```bash [Without GPU]
215+
cargo +nightly-2025-08-19 install --locked --force --path crates/cli --features tco
216+
```
217+
```bash [Nvidia GPU]
218+
cargo +nightly-2025-08-19 install --locked --force --path crates/cli --features tco,cuda
219+
```
220+
:::
221+
222+
This will globally install `cargo-openvm`. You can validate a successful installation with:
223+
224+
```bash
225+
cargo openvm --version
226+
```

0 commit comments

Comments
 (0)