Skip to content

docs(book): add installation instructions for tco #2072

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 27, 2025
Merged

docs(book): add installation instructions for tco #2072

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
db2b351
docs(book): add installation instructions for tco
jonathanpwang Aug 26, 2025
98ca755
chore: rewordings
jonathanpwang Aug 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 56 additions & 2 deletions docs/vocs/docs/pages/book/getting-started/install.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,13 +91,12 @@ svm use 0.8.19

:::

## Installation with Nvidia GPU support
## Installation with Nvidia GPU Support

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))

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.


### Option 1: Install Via Git URL (Recommended)

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

You are now ready to [install](#install-with-nvidia-gpu-support) the OpenVM CLI.

## Installation with Experimental Features

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.

This installation requires a nightly Rust toolchain. To install the nightly toolchain, run:

```bash
rustup install nightly-2025-08-19
```

### Option 1: Install Via Git URL (Recommended)

Begin the installation:

:::code-group
```bash [Without GPU]
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
```
```bash [Nvidia GPU]
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
```
:::

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

```bash
cargo openvm --version
```

### Option 2: Build from source

To build from source, first clone the repository.

```bash
git clone --branch v1.4.0-rc.9 --single-branch https://github.com/openvm-org/openvm.git
cd openvm
```

Then begin the installation:

:::code-group
```bash [Without GPU]
cargo +nightly-2025-08-19 install --locked --force --path crates/cli --features tco
```
```bash [Nvidia GPU]
cargo +nightly-2025-08-19 install --locked --force --path crates/cli --features tco,cuda
```
:::

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

```bash
cargo openvm --version
```
Loading