Skip the bullshit
// docs / Start

Install

Get the compiler onto your machine. Point of no return.

Download a release

Prebuilt binaries for Linux (x86_64), macOS (Apple silicon and Intel) and Windows (x64) are attached to each GitHub release. On Linux and macOS, this installs the right one to ~/.local/bin (set VCWL_INSTALL to pick another folder):

sh
curl -fsSL https://vcwl.chteau.bzh/install.sh | sh

On Windows, in PowerShell (installs to %LOCALAPPDATA%\vcwl\bin and adds it to your PATH):

sh
irm https://vcwl.chteau.bzh/install.ps1 | iex

Or build it from source

You need Rust (edition 2024) with the wasm32-unknown-unknown target, because the renderer is itself compiled to WebAssembly and embedded in the CLI.

sh
rustup target add wasm32-unknown-unknown
cargo install --git https://github.com/chteau/vcwl vcwl

Requirements

→

Node.js 20+ for vcwl run, vcwl test and build-time prerendering.

→

A browser with WebAssembly GC: Chrome or Edge 119+, Firefox 120+, Safari 18.2+.

→

git, if you want packages from a registry.

Staying up to date

When a newer release is out, every command prints a one-line notice. The check runs in the background at most once a day and never slows a command down; VCWL_NO_UPDATE_CHECK=1 turns it off (it is off in CI already). Your current version keeps working whether you upgrade or not.

sh
vcwl upgrade
# vcwl 0.3.0 is out (you have 0.2.0).
# Upgrades are free. Answer this first:
#
# f(x) = 2x³ + 3x². What is f'(2)?
#
# answer> 36
# Correct. Upgrading.