Skip to content

installation.md

Latest commit

 

History

History
104 lines (73 loc) · 2.51 KB

installation.md

File metadata and controls

104 lines (73 loc) · 2.51 KB
Raw

Installation

Code Context Engine is distributed as a standalone context executable and as source code. The basic local indexing workflow has no Node.js, Python, Java, or external service dependency.

Download a Release

  1. Open the repository's latest release.
  2. Download the Windows .zip archive or the Linux/macOS .tar.gz archive matching your operating system and architecture.
  3. Download the matching .sha256 file.
  4. Verify the checksum.
  5. Extract the archive and put the executable somewhere stable.

PowerShell checksum verification:

$archive = "code-context-engine-v0.1.0-windows-x64.zip"
$expected = (Get-Content "$archive.sha256").Split()[0]
$actual = (Get-FileHash $archive -Algorithm SHA256).Hash.ToLowerInvariant()
if ($actual -ne $expected) { throw "Checksum mismatch" }

Linux or macOS checksum verification:

shasum -a 256 -c code-context-engine-v0.1.0-linux-x64.tar.gz.sha256

The exact release filename includes the tag, operating system, and architecture.

Put the Binary on PATH

You may run the executable by absolute path or add its directory to PATH.

Windows PowerShell for the current terminal:

$env:PATH = "C:\tools\code-context-engine;$env:PATH"
context.exe --help

Linux or macOS:

chmod +x ./context
sudo install -m 0755 ./context /usr/local/bin/context
context --help

The downloaded macOS binary may require approval in System Settings if Gatekeeper blocks an unsigned community build.

Build from Source

Requirements:

  • Git
  • Stable Rust with Cargo
  • A C/C++ build toolchain supported by Rust on the current operating system

Build:

git clone https://github.com/acc-c/code-context-engine.git
cd code-context-engine
cargo build --locked --release -p context-cli

Install into Cargo's binary directory:

cargo install --locked --path crates/context-cli

Verify the Installation

context --help

Create a local index:

context index --repo /absolute/path/to/project --db /absolute/path/to/project/.context/code-index.sqlite

The database must be file-backed. Public CLI and MCP workflows reject :memory:.

Upgrade

For release archives, replace the executable with the version from the newer archive. Existing SQLite databases are opened and migrated by the application; keep a backup before upgrading important indexes.

For source installations:

git pull
cargo install --locked --path crates/context-cli --force