Docs · CLI

Install and run Ledgerful.

Install the ledgerful CLI from a pre-built v0.2.14 release binary or build from source using Cargo.

Prerequisites

The source install requires the Rust toolchain. Pre-built release binaries (v0.2.14) do not require Rust.

Rust toolchain required for source install: You need rustc and cargo. Install via rustup.rs (opens in new tab) — follow the platform instructions for your OS (Linux, macOS, or Windows). The stable toolchain is sufficient.

Release binaries: The v0.2.14 release is publicly available on GitHub with binary archives for 4 platforms, SHA-256 checksums for each, CycloneDX SBOM (engine + MCP), cosign keyless signing (Sigstore Fulcio), SLSA build-provenance attestation, SBOM attestation, and cargo-auditable dependency embedding. Homebrew tap and Scoop bucket remotes match GitHub Latest 0.2.14 (sidecar hashes). Community winget (winget install Ledgerful.Ledgerful) was measured on 0.2.13 (winget search 2026-09-18); do not claim 0.2.14 until search shows it. History: older 0.2.12 was microsoft/winget-pkgs#430322 merged 2026-09-06. History: older leftover 0.2.8 (#415913) merged; older leftover 0.2.9 (#416853) closed-superseded; older 0.2.11 was #423248. The community index can lag a merge by minutes–hours. The release verification page has checksums and provenance details.

Install

Prefer a package manager or prebuilt path when you want a release binary without a full workspace compile. Full options and platform notes live on the install guide. The canonical repository is publicly accessible at github.com/Ryan-AI-Studios/Ledgerful. Anonymous HTTPS, GitHub API, and raw-file access are all confirmed. Source-install commands are actionable.

Homebrew (prebuilt)

brew install Ryan-AI-Studios/tap/ledgerful

Official tap formula for macOS (Apple Silicon and Intel) and Linuxbrew. Installs the prebuilt release binary.

cargo binstall (prebuilt)

cargo binstall --git https://github.com/Ryan-AI-Studios/Ledgerful

Uses [package.metadata.binstall] to resolve the matching GitHub release archive when one exists. Requires cargo-binstall. May fall back to compiling from source if no prebuilt asset matches. No crates.io publish is used for distribution.

Scoop (Windows, prebuilt)

scoop bucket add ledgerful https://github.com/Ryan-AI-Studios/scoop-bucket
scoop install ledgerful

Official Scoop bucket for the portable Windows x86_64 zip. Manifest version/hash track published GitHub release sidecars.

winget (Windows, community)

winget install Ledgerful.Ledgerful

Package id Ledgerful.Ledgerful on microsoft/winget-pkgs (first package accepted 2026-07-30). Community index is live at measured on 0.2.13 (winget search 2026-09-18; GitHub v0.2.14 published, index may lag. History: older 0.2.12 was PR #430322 merged 2026-09-06; older leftover 0.2.8 (#415913) merged; older leftover 0.2.9 (#416853) closed-superseded. winget install Ledgerful.Ledgerful installs the community-index build. The index can lag a merge by minutes–hours.

Cargo (source)

cargo install --git https://github.com/Ryan-AI-Studios/Ledgerful --bin ledgerful

Cargo builds and links the binary from source. The first build takes several minutes. Subsequent installs reuse the build cache. The binary is placed in ~/.cargo/bin/ledgerful — make sure ~/.cargo/bin is on your PATH.

Verify the install

Confirm the binary is reachable and print the version string.

ledgerful --version

If the command is not found, check that ~/.cargo/bin is on your PATH and that the Cargo install completed without errors.

First commands

Run these commands from inside a git repository root to confirm the engine is working.

# Health check — verifies daemon, ledger, and key state
ledgerful doctor

# Scan changed files for risk (compare HEAD to main)
ledgerful scan --base-ref main

# Scan with JSON output and an impact flag
ledgerful scan --base-ref main --impact --json

# Run a full audit of the ledger
ledgerful audit

# Start the local dashboard daemon
ledgerful web start

Platform notes

Ledgerful runs on Linux, macOS, and Windows. A few things differ by platform.

Platform	Notes
Linux / macOS	`~/.cargo/bin` on PATH. Key storage at `~/.ledgerful/keys/`. Shell: bash or zsh.
Windows	`%USERPROFILE%\.cargo\bin` on PATH. Key storage at `%USERPROFILE%\.ledgerful\keys\`. Use PowerShell or Git Bash. Windows Authenticode signing is not yet implemented — you may see a SmartScreen prompt on first run.

OS code signing: Windows Authenticode and macOS Developer ID / Gatekeeper notarization are not yet implemented. Binaries built from source or downloaded from a release artifact may trigger OS security prompts on first launch. Code signing for both platforms is a planned enhancement for a future release.

← All docs Dashboard →