Installation
The Ferret CLI runs on Linux, macOS, and Windows. This page covers CLI-specific setup. To compare the CLI with Go and JavaScript embedding, see the Installation chooser.
These CLI guides describe current main. Build a source checkout to use that implementation. The tagged downloads below are published v2 releases and may not include changes added after their tag. Choose a v2 release explicitly; GitHub’s latest stable release and the shell installer can select the v1 CLI.
Prebuilt binary
Download v2.0.0-alpha.47 for your platform from the CLI release page.
Release archives use these names:
| Platform | Archive |
|---|---|
| Linux x86_64 | cli_linux_x86_64.tar.gz |
| Linux arm64 | cli_linux_arm64.tar.gz |
| macOS x86_64 | cli_darwin_x86_64.tar.gz |
| macOS arm64 | cli_darwin_arm64.tar.gz |
| Windows x86_64 | cli_windows_x86_64.zip |
| Windows arm64 | cli_windows_arm64.zip |
Extract the archive and place the ferret binary in a directory on your PATH. For a user-local installation on Linux or macOS:
mkdir -p "$HOME/.ferret"mv ferret "$HOME/.ferret/"export PATH="$HOME/.ferret:$PATH"
On Windows, extract ferret.exe from the zip file and place it in a directory included in PATH.
Build from source
Build current main with Go 1.26.5 or later and make:
git clone --branch main https://github.com/MontFerret/cli.gitcd climake compileexport PATH="$PWD/bin:$PATH"
The binary is written to bin/ferret. The export command adds this checkout’s binary directory to PATH for the current shell; you can also run ./bin/ferret directly.
To install source from the published v2 tag instead:
go install github.com/MontFerret/cli/v2/ferret@v2.0.0-alpha.47
For the tagged Go installation, ensure Go’s binary installation directory is on PATH.
Verify installation
ferret version
This prints the CLI version and the runtime version.
Update
To update a published v2 installation, install the newer tagged archive or rerun go install with the newer v2 tag. For a source checkout, update main and rerun make compile.
The ferret update self command checks GitHub’s latest non-prerelease release, so it does not advance between v2 prereleases. It also cannot install the Windows zip release. Do not use it as the v2 prerelease update path.
Uninstall
Remove the ferret binary from the directory where you installed it. For the user-local path shown above:
rm "$HOME/.ferret/ferret"
The CLI configuration remains at $HOME/.ferret/config.yaml. Remove that file separately only when you also want to discard the saved configuration. Do not remove the shared $HOME/.ferret directory if it contains Lab or other files.