Docs · CLI

Install and run Ledgerful.

Build from source using Cargo. Release artifacts (pre-built binaries) are a WEB-0005 launch fact and are not yet available.

Prerequisites

The source install requires the Rust toolchain. Release binaries, once available, will 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.1.8 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. When available, they will not require Rust. Check the release verification page for status.

Install from source

Install the ledgerful binary directly from the GitHub repository using Cargo. 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.

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 →