Install

flockr ships as a single binary named flockr. Pick one of the methods below, then run flockr --version to check it is on your PATH.

macOS and Linux: install script

curl -fsSL https://raw.githubusercontent.com/flockr-sh/flockr/master/distribution/install.sh | sh

The script:

1. Detects your OS (Linux or macOS) and architecture (x86_64 or aarch64).
2. Reads the latest release manifest and picks the binary for your platform.
3. Downloads the binary and checks its SHA-256 against the manifest. It uses sha256sum, shasum, or openssl, whichever it finds. If the checksum does not match, it stops without installing.
4. Installs flockr to ~/.local/bin and warns you if that directory is not on your PATH.

The script needs curl and awk. Android and Termux are not supported; SSH to a supported host instead.

Change the install directory

Set FLOCKR_INSTALL_DIR to install somewhere other than ~/.local/bin:

curl -fsSL https://raw.githubusercontent.com/flockr-sh/flockr/master/distribution/install.sh | FLOCKR_INSTALL_DIR="$HOME/bin" sh

If the directory is not on your PATH, add it to your shell config:

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

Windows: PowerShell

powershell -ExecutionPolicy Bypass -c "irm https://raw.githubusercontent.com/flockr-sh/flockr/master/distribution/install.ps1 | iex"

By default this installs to %LOCALAPPDATA%\Programs\Flockr\bin. FLOCKR_INSTALL_DIR changes the directory here too.

mise

With mise:

mise use -g github:flockr-sh/flockr

Release binaries

Each release on the releases page has binaries for:

• Linux x86_64 and aarch64
• macOS x86_64 and aarch64
• Windows x86_64 (a zip file)

Download the one for your platform, make it executable, and put it on your PATH.

Build from source

You need Rust (via rustup) and Zig 0.16.0. With mise, run mise install in the repo to set up Zig.

git clone https://github.com/flockr-sh/flockr
cd flockr
mise install
mise exec -- cargo build --release --locked
ln -sf "$PWD/target/release/flockr" ~/.local/bin/flockr

Shell completions

flockr completion <shell> prints a completion script for bash, elvish, fish, powershell, or zsh. For example:

flockr completion zsh > ~/.zfunc/_flockr

Next

Go to the Quick start.