Skip to content

Installation

Colin Vaughn edited this page Jun 15, 2026 · 1 revision

Installation

CodeGraph is a single static Rust binary named codegraph. There is no runtime or interpreter to install alongside it.

Requirements

  • A stable Rust toolchain. The repo pins Rust 1.95 via rust-toolchain.toml, so a rustup-managed environment will select it automatically.
  • Git, if you plan to use the PR dashboard, git hooks, or git-based workspace members.

Build from source

# Install the `codegraph` binary onto your PATH:
cargo install --path bin/codegraph

# ...or build it in-tree:
cargo build --release      # -> target/release/codegraph

Prebuilt binaries

Tagged releases attach prebuilt binaries for Linux (x86_64), macOS (x86_64 and aarch64), and Windows (x86_64) to the GitHub Releases page. Each archive bundles the codegraph binary plus the README, LICENSE, and CHANGELOG.

Optional features

Several integrations are gated behind Cargo features and are off by default, so the default build stays small and dependency-light. Enable the ones you need at build time:

Feature Enables
pg codegraph ingest pg (live Postgres schema introspection)
push codegraph export neo4j|falkordb --push <uri> (live database export)
office codegraph ingest office (spreadsheet ingest)
gws codegraph ingest gws (Google-Workspace ingest)
media codegraph ingest media (audio/video transcription, also YouTube URL ingest)
# Example: build with Postgres ingest and live database push:
cargo install --path bin/codegraph --features pg,push

If you run a feature-gated subcommand on a build that lacks the feature, CodeGraph prints a clear error telling you which feature to rebuild with. See Ingestion and Output Formats for what each feature unlocks.

Languages

All language extractors are compiled into the default build (38 lang-* features on by default). You do not need to enable anything per language to extract a mixed-language repo. See Languages for the full list and Development for building a single language in isolation.

Verify

codegraph --help
codegraph extract .

The first extract writes a codegraph-out/ directory next to your code. See Quickstart next.

Clone this wiki locally