Install

Install the Checkrd CLI on macOS or Linux. Single static binary, no runtime dependencies.

Install the CLI

checkrd is a single static binary. There's no runtime to install.

Homebrew (macOS, Linux)

bash

brew install checkrd-io/homebrew-tap/checkrd-cli

This installs the checkrd binary into Homebrew's prefix. Update with brew upgrade checkrd-cli when a new version ships.

Shell installer (macOS, Linux)

bash

curl -fsSL https://checkrd.io/install.sh | sh

Detects your OS + architecture, downloads the matching binary from GitHub Releases, and drops it in ~/.checkrd/bin. Add that to your PATH:

bash

export PATH="$HOME/.checkrd/bin:$PATH"

You can audit the script before piping to sh; it's the standard cargo-dist-generated installer, ~150 lines of POSIX shell.

Verify

bash

checkrd --version

Prints the installed version. The latest released version is 0.1.5.

Shell completions

Generate completions for your shell and source them in your shell's rc file:

bash

# Bash
eval "$(checkrd completions bash)"

# Zsh
checkrd completions zsh > ~/.zsh/completions/_checkrd
# add `fpath+=~/.zsh/completions` and `autoload -U compinit && compinit` to ~/.zshrc

# Fish
checkrd completions fish | source
# or persist: checkrd completions fish > ~/.config/fish/completions/checkrd.fish

macOS Gatekeeper

The first time you run a binary downloaded outside the Mac App Store, Gatekeeper may quarantine it. If you see "checkrd cannot be opened because the developer cannot be verified," run:

bash

xattr -d com.apple.quarantine $(which checkrd)

Or install via Homebrew, which handles signing transparently.

Linux secret service

The CLI stores credentials in the OS keychain via libsecret. On a fresh Linux install you may need:

bash

sudo apt install libsecret-1-0 gnome-keyring

On headless servers where no secret service is running, set CHECKRD_API_KEY in your environment instead; the CLI checks env before keychain.

Verify your download

Auditable binary (cargo-auditable)

Every binary embeds its Cargo.lock-derived dependency tree in a .dep-v0 ELF/Mach-O/PE section (~4 KB overhead). Query it offline against the RustSec advisory database:

bash

cargo install cargo-audit --features=fix
cargo audit bin $(which checkrd)
# Crate:    checkrd-cli
# Version:  <your installed version>
# Loaded:   358 dependencies from binary
# Crate vulnerabilities found: 0

Trivy, Grype, Syft, and osv-scanner all read the same section if you prefer them over cargo audit.

SHA-256 checksums

Each binary tarball ships with a matching .sha256 file on the GitHub Release. Verify after download:

bash

shasum -a 256 -c checkrd-cli-aarch64-apple-darwin.tar.gz.sha256

Next step

bash

checkrd login

Authenticate via your browser. The CLI opens the dashboard, you sign in once, and a long-lived API key gets stored in your OS keychain. See Authentication for the full flow.

Overview Authentication