Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Install

Prerequisites

Rust, via rustup. The repo’s rust-toolchain.toml pins the channel and components; rustup reads it on your first cargo command and installs what is missing.

A linker. Since Rust does not ship one:

PlatformInstall
Linux / WSLsudo apt install build-essential pkg-config
macOSxcode-select --install
WindowsVisual Studio Build Tools — the rustup installer offers these; accept

Close every terminal and editor after installing. Installers add ~/.cargo/bin to your PATH, but a running process keeps the environment it started with. A new tab in an app that was already open still will not see cargo.

$ cargo --version
cargo 1.8x.0

Build and install

$ git clone https://github.com/graze-ai/vidi.git
$ cd vidi
$ cargo install --path crates/vidi-cli

The first build compiles 21 tree-sitter grammars from C and takes a few minutes. Later builds are incremental.

cargo build is not enough. It leaves the binary in target/, where your shell will not find it. cargo install is what puts vidi on your PATH.

$ vidi --version
vidi 0.1.2

Editor extensions

Optional, as the CLI is complete without them.

VS Code

$ cd editors/vscode
$ npm ci
$ npm run build
$ npx vsce package
$ code --install-extension vidi-vscode-*.vsix

Requires Node 22.

On WSL, run code --install-extension from your WSL shell. Extensions install per-context; installing on the Windows side leaves the extension invisible to a WSL window.

JetBrains

$ cd editors/jetbrains
$ ./gradlew buildPlugin

Requires JDK 21. The wrapper fetches Gradle and the IDE SDK on first run.

Updating

$ git pull
$ cargo install --path crates/vidi-cli

Rebuild and reinstall the editor extension separately if editors/ changed.

Next

Your first vouch