Skip to content

limuitech/gitleaks

Repository files navigation

gitleaks

Travis

Audit git repos for secrets

Powered by src-d's go-git

Installing

go get -u github.com/zricethezav/gitleaks

Or download from release binaries here

Usage and Options

Usage: gitleaks [OPTIONS] Application Options: -r, --repo= Repo url to audit --github-user= User url to audit --github-org= Organization url to audit --github-url= GitHub API Base URL, use for GitHub Enterprise. Example: https://github.example.com/api/v3/ (default: https://api.github.com/) -p, --private Include private repos in audit -b, --branch= branch name to audit (defaults to HEAD) -c, --commit= sha of commit to stop at --repo-path= Path to repo --owner-path= Path to owner directory (repos discovered) --max-go= Maximum number of concurrent go-routines gitleaks spawns --disk Clones repo(s) to disk --all-refs run audit on all refs --single-search= single regular expression to search for --config= path to gitleaks config --ssh-key= path to ssh key -l, --log= log level -v, --verbose Show verbose output from gitleaks audit --report= path to write report file --redact redact secrets from log messages and report --version version number Help Options: -h, --help Show this help message 

Exit Codes

1: leaks present 0: no leaks 

Additional Examples and Explanations

Check the wiki here

If you find a valid leak in a repo

Please read this Github article on removing sensitive data from a repository to remove the sensitive information from your history.

Run me with docker

Simply run docker run --rm --name=gitleaks zricethezav/gitleaks --help

About

Audit git repos for secrets 🔑

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Go96.3%
  • Makefile2.4%
  • Dockerfile1.3%