Installation
Protocol Canary does not yet publish prebuilt binaries or checksums (see
Releases). The documented install path is cargo install
against a pinned release tag.
Prerequisites
- A Rust/Cargo toolchain. The repository pins
1.91.0in its ownrust-toolchain.toml;cargo installwill use whatever toolchain is active on your machine (rustup will fetch a matching one automatically if you use it). - Network access to
crates.io(for dependency resolution) and GitHub (to fetch the source).
No other runtime dependency is required. There is no Docker requirement and no OS-specific instructions beyond “a working Rust toolchain” — this project does not claim support for a specific operating system beyond what the Rust toolchain itself supports.
Install the current release
cargo install --git https://github.com/StellarCanary/Protocol-Canary --tag v0.1.1 --locked
--tag v0.1.1pins the exact, currently verified release — nevermain, and never an unpinned “latest”.--lockeduses the exact dependency versions in the repository’s own committedCargo.lock, rather than whatever the latest compatible versions happen to be at install time.
Verify the install:
stellar-canary version
stellar-canary 0.1.1
Alternative: build from a local checkout
git clone https://github.com/StellarCanary/Protocol-Canary
cd Protocol-Canary
cargo install --path crates/canary-cli
Alternative: run without installing (development)
From a workspace checkout, every command can be run directly through Cargo without installing a binary at all:
cargo run -p canary-cli -- check
cargo run -p canary-cli -- inspect
cargo run -p canary-cli -- fixtures --protocol 28
Next step
Continue to Your First Check.