Compass
Install Compass

From terminal to code graph in two steps.

Install the local CLI first, then add Compass Codegraph to VS Code. Your source and graph stay on your machine.

Choose your platform

Step 1 · Compass CLI

Install the local engine.

Pick your operating system to get the right official command. The installer detects your CPU architecture and verifies the downloaded release.

Install on macOS

Open Terminal, then paste and run this command.

Official release installer
$curl --proto '=https' --tlsv1.2 -LsSf https://github.com/crabbuild/compass/releases/latest/download/install.sh | sh
1

Run the installer

Compass verifies the release checksum and installs the matching binary.

2

Confirm it works

Open a new terminal and run compass --version.

Step 2 · VS Code

Bring the graph into your editor.

Compass Codegraph connects to the CLI you just installed. Explore relationships, trace callers and callees, inspect change impact, and open exact source locations without leaving VS Code.

Install from Marketplace Read the setup guide
Install the VS Code extension
Install Compass Codegraph from the Visual Studio Marketplace. It requires Compass CLI 0.3.0 or newer.
  1. 1

    Install Compass Codegraph

    Open the Marketplace listing and select Install. VS Code handles the download and future updates.

  2. 2

    Open a trusted repository

    Use a local folder or connect through a supported VS Code remote environment.

  3. 3

    Initialize your first graph

    Select Compass in the activity bar, then choose Initialize repository.

Prefer the terminal? Install with the extension ID:

>code --install-extension crabbuild.crabbuild-compass-vscode

The extension auto-detects Compass on PATH and in common user-local install locations.

Other install paths

Need a manual route?

Offline release install

Download the matching archive and checksum from the latest release, verify it, and add Compass to your PATH.

View releases
Build from source
cargo install --locked --path crates/compass-cli --bin compassUse the pinned Rust 1.97.1+ toolchain documented by the repository.Read getting started