Local installation
Cargo
cargo install ferrflow
npm
npm install -g ferrflow
# or as a dev dependency
npm install -D ferrflow
WASM (browser)
npm install @ferrflow/wasm
Use FerrFlow directly in the browser — parse commits, compute version bumps, and generate changelogs client-side without a backend.
Binary
Download a pre-built binary from Releases:
# Linux x86_64
curl -L https://github.com/FerrLabs/FerrFlow/releases/latest/download/ferrflow-linux-x64.tar.gz | tar xz
sudo mv ferrflow /usr/local/bin/
Docker
docker run --rm -v $(pwd):/repo ghcr.io/ferrlabs/ferrflow:latest check
CI installation
The recommended way to use FerrFlow in CI is the GitHub Action — no installation step needed:
- uses: FerrLabs/ferrflow@v2
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
See GitHub Actions and GitLab CI for complete examples.
Verify
ferrflow --version