CLI Install and Setup
The DBGorilla CLI is how you set up collectors and wire AI tools into DBGorilla. Install it once, sign in once, and every other page that needs it can assume both are done.
Install
Section titled “Install”The binary is dbgorilla. Homebrew also installs dbg as an alias for it.
Homebrew
Section titled “Homebrew”brew install dbgorilla/tap/dbgorillaUse the full dbgorilla/tap/dbgorilla name. Tab completion for bash, zsh and fish is set up for
you.
go install github.com/dbgorilla/dbgorilla-cli/cmd/dbgorilla@latestA Go install gives you dbgorilla only. If you want the shorter dbg, create the symlink
yourself:
ln -s "$(which dbgorilla)" /usr/local/bin/dbgManual download
Section titled “Manual download”Binaries are on the releases page.
| File | Platform |
|---|---|
dbg-darwin-arm64 |
macOS, Apple silicon |
dbg-darwin-amd64 |
macOS, Intel |
dbg-linux-arm64 |
Linux, arm64 |
dbg-linux-amd64 |
Linux, x86-64 |
There is no Windows build. Rename the file you download to dbgorilla and put it on your PATH.
Verify a download
Section titled “Verify a download”Every release binary carries build provenance, so you can confirm where it came from before you run it. This needs the GitHub CLI:
gh attestation verify dbg-darwin-arm64 \ --repo dbgorilla/dbgorilla-cli \ --signer-workflow dbgorilla/dbgorilla-cli/.github/workflows/release.ymlAn 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 be producing these binaries.
For Go and manual installs, set up completion separately:
source <(dbgorilla completion zsh) # this shell onlydbgorilla completion --help # bash, zsh, fish, powershellSign in
Section titled “Sign in”dbgorilla loginOn DBGorilla SaaS that is the whole command. The CLI talks to app.dbgorilla.com unless you tell
it otherwise.
The CLI picks the sign-in mode for you: it asks 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:
dbgorilla whoami # your email and organizationdbgorilla whoami --json # the same, as JSONCheck your setup
Section titled “Check your setup”dbgorilla doctorIt 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.jsonConfiguration
Section titled “Configuration”Two settings persist: api-url and insecure.
dbgorilla config get api-url # the value, and where it came fromdbgorilla config set api-url https://dbgorilla.your-company.exampledbgorilla config unset api-urlA setting can come from five places. The first one wins:
--api-urlon the command line- the
DBGORILLA_API_URLenvironment variable - your config file:
~/.config/dbgorilla/cli.toml, or$XDG_CONFIG_HOME/dbgorilla/cli.toml - a system-wide file your IT team deploys:
/Library/Application Support/dbgorilla/cli.tomlon macOS,/etc/dbgorilla/cli.tomlon Linux app.dbgorilla.com, the built-in default
dbgorilla config unset api-url therefore returns you to SaaS rather than leaving the CLI with
nowhere to talk to.
dbgorilla config get tells you which layer won, which is the fastest way to find out why a
command is talking to the wrong deployment.
Updating
Section titled “Updating”dbgorilla upgradeOn 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.
Signing out
Section titled “Signing out”dbgorilla logout