Skip to content

Installation

Jump to bottom
karurikwao edited this page Jul 5, 2026 · 1 revision

Installation

This page covers supported install paths and basic verification.

Release Binaries

Download the latest release from:

https://github.com/karurikwao/contextclean/releases

The V0.1 release line includes archives for:

  • Linux x64
  • macOS Intel
  • macOS Apple Silicon
  • Windows x64

After extracting the archive, put the binary directory on your PATH.

Verify:

ctxclean --version
ctxrun --help

Install From Git With Cargo

Requires Rust 1.85 or newer:

cargo install --git https://github.com/karurikwao/contextclean contextclean-cli

Verify:

ctxclean --help
ctxclean --format json --quiet README.md

Install From A Local Checkout

git clone https://github.com/karurikwao/contextclean.git
cd contextclean
cargo install --path crates/contextclean-cli

Docker Verification

If Rust is not installed locally but Docker is available:

docker run --rm -v "${PWD}:/work" -w /work -e CARGO_TARGET_DIR=/tmp/contextclean-target rust:1.85-bookworm sh -lc 'export PATH=/usr/local/cargo/bin:$PATH; cargo test --workspace --all-features --locked'

On Windows PowerShell, the repository also includes:

powershell -ExecutionPolicy Bypass -File .\scripts\check.ps1

Version Policy

The repository currently declares Rust 1.85 as the minimum supported Rust version. CI includes an MSRV job so dependency updates that require newer Rust should not be merged accidentally.

Install Notes

  • ctxclean is the main CLI.
  • ctxrun is the command wrapper for failed command output.
  • No API key is required.
  • No model provider setup is required.
  • The CLI is local-first and does not send input to a service.

Clone this wiki locally