Skip to content

Quick Start

Install Kingfisher, scan a target, and inspect the results.

1. Install Kingfisher

brew install kingfisher

uv tool install kingfisher-bin

docker run --rm -v "$PWD":/src ghcr.io/mongodb/kingfisher:latest scan /src

curl -sSL https://raw.githubusercontent.com/mongodb/kingfisher/main/scripts/install-kingfisher.sh | bash

Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass -Force
Invoke-WebRequest -Uri 'https://raw.githubusercontent.com/mongodb/kingfisher/main/scripts/install-kingfisher.ps1' -OutFile install-kingfisher.ps1
./install-kingfisher.ps1

For all installation options, see the Installation Guide.

2. Scan a Directory

kingfisher scan /path/to/code

Kingfisher automatically detects whether the path is a Git repo or plain directory.

3. View Results in Your Browser

kingfisher scan /path/to/code --view-report

You can also open existing Kingfisher, Gitleaks, or TruffleHog JSON reports with kingfisher view <report.json>.

If you want a shareable upload-based version, the docs site also hosts the report viewer.

4. Show Only Live Secrets

Filter to only secrets confirmed active by provider APIs:

kingfisher scan /path/to/code --only-valid

To include live credentials plus high-signal findings such as private keys that require manual review, use:

kingfisher scan /path/to/code --validation-filter actionable

5. Map the Blast Radius (aka Access Map)

Inspect the identities, permissions, and resources visible to a supported credential:

kingfisher scan /path/to/code --blast-radius --view-report

6. Revoke a Compromised Secret

Use a finding’s generated revoke command for supported credentials:

kingfisher revoke --rule github-pat "ghp_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Kingfisher custom YAML rules may also define revocation:.

7. Scan a GitHub Organization

KF_GITHUB_TOKEN="ghp_..." kingfisher scan github --organization my-org

8. Output JSON for CI/CD

kingfisher scan /path/to/code --format json --output findings.json

What's Next?