Install Gandalf on macOS or Linux

Gandalf ships as a single Go binary for darwin and linux (amd64 and arm64). Choose the channel that matches how you install other developer tools. There is no npm distribution.

Homebrew

brew install qyinm/tap/gandalf
gandalf --help

The formula is generated by GoReleaser into qyinm/homebrew-tap.

install.sh

The install script downloads the latest stable GitHub Release binary and drops it on your PATH:

curl -fsSL https://raw.githubusercontent.com/qyinm/gandalf/main/install.sh | sh
gandalf --help

Go source build

go install github.com/qyinm/gandalf/cmd/gandalf@latest

Or clone and build with the Makefile:

git clone git@github.com:qyinm/gandalf.git
cd gandalf
make build
./bin/gandalf --help

Prebuilt release binaries

Prebuilt darwin and linux binaries are published on every v* tag on the GitHub Releases page via GoReleaser. Download the tarball for your OS and architecture, extract, and place gandalf on your PATH.

Verify the install

gandalf --help
gandalf scan --project .

scan is read-only. It surfaces the agents Gandalf sees, per-scope evidence counts, blind spots, and a next-step hint.

Gandalf does not check for updates by default. Set GANDALF_UPDATE_CHECK=1 to opt in.

⌘I

Get Started

Concepts

Guides

Reference

Install Gandalf on macOS or Linux

Homebrew

install.sh

Go source build

Prebuilt release binaries

Verify the install

​Homebrew

​install.sh

​Go source build

​Prebuilt release binaries

​Verify the install

Homebrew

install.sh

Go source build

Prebuilt release binaries

Verify the install