Installation
Install the Rustywoof CLI on Linux, macOS, or Windows using your preferred package manager.
Rustywoof ships as a single compiled binary named woof. You can install it globally on your workstation or add it as a development dependency inside an existing Rust, Node.js, or Python project.
Choose an Installation Method
Pick the package manager that matches your environment:
If you have the Rust toolchain (cargo) installed, compile and install the binary directly from crates.io:
cargo install rustywoofCargo places the compiled woof binary inside ~/.cargo/bin/. Make sure that directory is in your shell PATH.
Need a raw archive for an air-gapped runner or Docker image? You can download platform binaries directly from GitHub Releases.
Verify Your Setup
After installation finishes, open a terminal and check that woof responds:
woof versionYou should see the installed version printed to your terminal (for example, woof 0.3.0).
Run Your First Check
Navigate to any project directory on your machine and run a quick scan:
cd /path/to/your/project
# 1. Create a starter .woof.toml file
woof init
# 2. Check your files for exposed keys and audit your lockfile
woof patrolEnable Shell Autocompletion (Optional)
To get tab-completion for woof subcommands and flags in your terminal, use woof generate:
# Bash
woof generate bash > ~/.local/share/bash-completion/completions/woof
# Zsh
woof generate zsh > ~/.zsh/completion/_woof
# Fish
woof generate fish | sourceLast updated on 09/11/2026