Installation¶

Requirements¶

Rust stable toolchain (1.91 or later)

If you don't have Rust installed, get it from rustup.rs.

Install from crates.io¶

cargo install graphcal --version '^0.0.1-alpha' --locked

The explicit version requirement is necessary while Graphcal is published as a pre-release. This downloads the latest compatible Graphcal release from crates.io, builds it, and installs the graphcal binary to ~/.cargo/bin/.

Build from a source checkout¶

Unlike a crates.io installation, building the CLI from a checkout also builds its embedded browser engine. Install these prerequisites first:

The Rust toolchain pinned in rust-toolchain.toml, managed by rustup.
Its wasm32-unknown-unknown target (rustup target add wasm32-unknown-unknown from the repository root).
wasm-bindgen-cli matching the resolved wasm-bindgen version in Cargo.lock: cargo install wasm-bindgen-cli --version <locked-version> --locked.
Binaryen's wasm-opt on PATH. CI uses Binaryen 117; prebuilt distributions are available from Binaryen releases.

Then run the usual command:

cargo build

The CLI automatically builds and embeds the browser engine. The first build can take longer because it compiles both native and Wasm code. cargo check, Clippy, and editor checks can also trigger this build.

For an offline source build, prefetch dependencies and set CARGO_NET_OFFLINE=true.

Published crate archives already contain the verified engine; crates.io users do not need these additional tools. Report artifacts remain self-contained and work without a network connection.

Verify Installation¶

graphcal --version
# graphcal <version> (commit: <sha>)

The commit suffix is shown when the build can determine the source commit.

Editor Setup¶

For the best experience, set up editor integration to get syntax highlighting, diagnostics, and inlay hints showing computed values. See Editor Setup for VS Code, Zed, Helix, and Neovim instructions.

Next Steps¶

Proceed to the Tutorial to write your first Graphcal file.