> ## Documentation Index
> Fetch the complete documentation index at: https://docs.usegandalf.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Install Gandalf on macOS or Linux

> Install the Gandalf CLI via Homebrew, the install.sh script, or Go source builds. Prebuilt binaries are published for darwin and linux on every v-tag release.

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

```bash theme={null}
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`:

```bash theme={null}
curl -fsSL https://raw.githubusercontent.com/qyinm/gandalf/main/install.sh | sh
gandalf --help
```

## Go source build

```bash theme={null}
go install github.com/qyinm/gandalf/cmd/gandalf@latest
```

Or clone and build with the `Makefile`:

```bash theme={null}
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](https://github.com/qyinm/gandalf/releases) via GoReleaser. Download the tarball for your OS and architecture, extract, and place `gandalf` on your `PATH`.

## Verify the install

```bash theme={null}
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.

<Note>
  Gandalf does not check for updates by default. Set `GANDALF_UPDATE_CHECK=1` to opt in.
</Note>