trufflehog

(β˜… 27,538)

Find, verify, and analyze leaked credentials

File Explorer

Download Latest Version (.zip)

Showing a partial file list β€” download the zip above to see everything.

  • .gitattributes
  • .gitignore
  • .goreleaser.yml
  • .pre-commit-config.yaml
  • .pre-commit-hooks.yaml
  • action.yml
  • CODE_OF_CONDUCT.md
  • CODEOWNERS
  • CONTRIBUTING.md
  • Dockerfile
  • Dockerfile.goreleaser
  • entrypoint.sh
  • go.mod
  • go.sum
  • LICENSE
  • main.go
  • Makefile
  • manpage.go
  • PreCommit.md
  • README.md
  • SECURITY.md

# Installation Guide

1. Get the code
git clone https://github.com/trufflesecurity/trufflehog

Downloads the entire project code from GitHub to your computer.

cd trufflehog

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Homebrew A package manager for macOS/Linux.
brew install trufflehog

Installs the pre-built package via Homebrew β€” no source build required.

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker run --rm -it -v "$PWD:/pwd" trufflesecurity/trufflehog:latest github --org=trufflesecurity

Runs the built image as an actual container.

docker run --rm -it -v "$PWD:/pwd" trufflesecurity/trufflehog:latest github --repo https://github.com/trufflesecurity/test_keys

Runs the built image as an actual container.

docker run --rm -it -v "%cd:/=\%:/pwd" trufflesecurity/trufflehog:latest github --repo https://github.com/trufflesecurity/test_keys

Runs the built image as an actual container.

docker run --rm -it -v "${PWD}:/pwd" trufflesecurity/trufflehog github --repo https://github.com/trufflesecurity/test_keys

Runs the built image as an actual container.

docker run --platform linux/arm64 --rm -it -v "$PWD:/pwd" trufflesecurity/trufflehog:latest github --repo https://github.com/trufflesecurity/test_keys

Runs the built image as an actual container.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

4. Go

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Go The Go compiler and toolchain.
cd trufflehog; go install

Moves into the project folder you just downloaded.

βœ… If the build finishes without errors, it worked. If you used go run ., check the terminal output.

Pulled directly from this repo's README.

5. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make

Compiles the code based on the generated build configuration to produce an executable.

βœ… If it finishes without errors, it worked. Try running the generated executable directly.

Today's picks

hugo β˜… 89,432

The world’s fastest framework for building websites.

Go
pi β˜… 91,423

AI agent toolkit: unified LLM API, agent loop, TUI, coding agent CLI

TypeScript
hackingtool β˜… 78,992

ALL IN ONE Hacking Tool For Hackers

Python
frp β˜… 108,813

A fast reverse proxy to help you expose a local server behind a NAT or firewall to the int

Go
Python β˜… 223,790

All Algorithms implemented in Python

Python
freeCodeCamp β˜… 454,112

freeCodeCamp.org's open-source codebase and curriculum. Learn math, programming, and compu

TypeScript
// repository documentation