Install

The shortest path. If you have a Rust toolchain, this is one command from your shell.

Install heddle-cli from crates.io

bash$ cargo install heddle-cli --version "^0.2" --features git-overlay,semantic,zstd

Cargo will resolve heddle-cli and its workspace siblings from crates.io, compile them, and place the heddle binary under ~/.cargo/bin.

The git-overlay feature wires Heddle on top of an existing Git repository (the recommended on-ramp). native is the other primary mode (content-addressed storage with no Git underneath); both can be on at once. See Git-overlay mode for the distinction.

For contributors. Clone the OSS workspace and install from a local path; useful when you're hacking on the CLI itself.

Install from a local clone

bash$ git clone https://github.com/HeddleCo/heddle.git$ cd heddle$ cargo install --path crates/cli --locked

Cargo will compile the full OSS workspace and drop the heddle binary into ~/.cargo/bin.

The Homebrew formula is being prepared for the public release. Once published, this is a single tap.

Once the formula lands

bash$ brew install heddleco/heddle/heddle

Prebuilt artefacts for macOS (arm64, x86_64), Linux (x86_64, arm64), and Windows ship with each tagged release. Until the first tagged release, this path is empty.

Verify the install

Whichever path you took, the same one-liner confirms Heddle is reachable.

Sanity check

bash$ heddle --versionheddle 0.2.0$ heddle helpheddle <command> [args...]Try: heddle init  ·  heddle capture  ·  heddle thread show

If heddle --version errors with "command not found", your $PATH doesn't yet include ~/.cargo/bin (cargo) or the brew prefix (Homebrew). Open a fresh shell or add the relevant directory to $PATH.

Next

Move on to the Quickstart — five minutes from a clean repo to a signed thread bridged back to Git.