Skip to content

docs: add trufflehog as a required dependency #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs: add trufflehog as a required dependency #4

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7f66b6d
docs: add trufflehog as a required dependency
splinesreticulating Jul 6, 2025
b7d22b4
docs: clarify TruffleHog v3+ requirement and improve installation ins…
splinesreticulating Jul 7, 2025
810abb7
fix: retain casualness
splinesreticulating Jul 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,22 @@ This project was created in collaboration with [Sharon Brizinov](https://github.
```bash
pip install -r requirements.txt
```
3. Scan an org/user for secrets:

3. Install TruffleHog (v3 or later — required for secret scanning):

#### macOS (Homebrew):
```bash
brew install trufflehog
```

#### Linux / Other:
Download the latest binary from the [Releases page](https://github.com/trufflesecurity/trufflehog/releases), or use:

```bash
go install github.com/trufflesecurity/trufflehog@latest
```

4. Scan an org/user for secrets:

```bash
python force_push_scanner.py <org> --db-file /path/to/force_push_commits.sqlite3 --scan
Expand Down