Skip to content

CLI Install and Setup

Last updated

View as Markdown

The DBGorilla CLI is how you set up collectors and wire AI tools into DBGorilla. Install it once and sign in once.

The binary is dbgorilla. Homebrew also installs dbg as an alias for it.

Terminal window
brew install dbgorilla/tap/dbgorilla

Use the full dbgorilla/tap/dbgorilla name. Tab completion for bash, zsh and fish is set up automatically.

Terminal window
go install github.com/dbgorilla/dbgorilla-cli/cmd/dbgorilla@latest

A Go install gives you dbgorilla only. To use the shorter dbg, create the symlink yourself:

Terminal window
ln -s "$(which dbgorilla)" /usr/local/bin/dbg

Binaries are on the releases page.

FilePlatform
dbg-darwin-arm64macOS, Apple silicon
dbg-darwin-amd64macOS, Intel
dbg-linux-arm64Linux, arm64
dbg-linux-amd64Linux, x86-64

There is no Windows build. Rename the downloaded file to dbgorilla and put it on your PATH.

Every release binary carries build provenance, so you can confirm where it came from before you run it. This needs the GitHub CLI:

Terminal window
gh attestation verify dbg-darwin-arm64 \
--repo dbgorilla/dbgorilla-cli \
--signer-workflow dbgorilla/dbgorilla-cli/.github/workflows/release.yml

An exit code of 0 confirms the file was built by that repository’s release workflow. Naming the workflow matters: --repo on its own accepts anything built anywhere in the repository, and the release workflow is the only thing that should produce these binaries.

For Go and manual installs, set up completion separately:

Terminal window
source <(dbgorilla completion zsh) # this shell only
dbgorilla completion --help # bash, zsh, fish, powershell
Terminal window
dbgorilla login

On DBGorilla SaaS that is the whole command. The CLI talks to app.dbgorilla.com unless you tell it otherwise.

The CLI selects the sign-in mode automatically by asking your deployment whether single sign-on is enabled. If it is, you get the browser device flow, where the CLI prints a code you approve in a browser. If it is not, you get a username and password prompt. Force one with --mode sso or --mode password. In password mode you can pass --account and --tenant instead of being prompted.

Check it worked:

Terminal window
dbgorilla whoami # your email and organization
dbgorilla whoami --json # the same, as JSON
Terminal window
dbgorilla doctor

It checks your API URL and where it came from, your auth token, that an MCP key exists, and then one check per detected editor. It exits 0 only if everything passed.

Checking DBGorilla setup...
[ OK ] API URL https://app.dbgorilla.com (source: default)
[ OK ] Auth + API you@example.com (org: ...)
[ OK ] MCP API key exists
[ OK ] MCP: Claude Code registered (`claude mcp list`)
[ OK ] MCP: Cursor entry present in ~/.cursor/mcp.json
[FAIL] MCP: VS Code no config at ./.vscode/mcp.json -- run: dbgorilla setup-ide --client vscode
[ OK ] MCP: Gemini CLI entry present in ~/.gemini/settings.json

A failure line does not always mean a fault; see doctor reports a failure but your setup is fine.

See Configuration in CLI commands.

Terminal window
dbgorilla upgrade

On a Homebrew install this runs brew upgrade for you. On any other install, it does not update anything. It prints instructions, and you run them yourself. Download the current binary from the releases page and replace the file. The CLI does not replace its own binary.

Terminal window
dbgorilla logout