Skip to content

Install the card tools (archive)

The ledger commands are installed as described in Install. This page describes the older card-level tools and is kept for reference; its Python version note may be out of date.

Protocolith needs Python 3.11 or newer and works on Windows, macOS and Linux (platform support).

Card-level CLI from PyPI

pipx install protocolith        # or: uv tool install protocolith
                                        # or: pip install protocolith
                                        # or: conda install -c conda-forge protocolith   (pixi add protocolith)
protocolith --version
protocolith doctor

The package contains the validator and the card-level commands: validate-card, inspect, hash, run-root, new and doctor. It does not contain the 8,000+ evidence cards, the registry or the runner scripts. Commands that need them (validate-all, demo, rerun, drift, verify) print how to clone the repository.

Full clone

git clone https://github.com/protocolith/protocolith.git
cd protocolith
uv sync --extra dev
uv run protocolith validate-all

The repository is large because it holds every card and its SVG. If you only need the code, tests and registry index:

git clone --filter=blob:none --sparse https://github.com/protocolith/protocolith.git
cd protocolith
git sparse-checkout set src tests docs/registry docs/evidence_cards docs/track_families

validate-all needs docs/evidence_cards; skip that folder only if you do not run it.