|
|
@@ -32,12 +32,8 @@
|
|
|
[![GoReportCard][go-report-card-badge]][go-report-card]
|
|
|
[![License][badge-license]][license]
|
|
|
|
|
|
-
|
|
|
-### Join our Discord! [](https://discord.gg/8Hzbrnkr7E)
|
|
|
-
|
|
|
Gitleaks is a tool for **detecting** secrets like passwords, API keys, and tokens in git repos, files, and whatever else you wanna throw at it via `stdin`. If you wanna learn more about how the detection engine works check out this blog: [Regex is (almost) all you need](https://lookingatcomputer.substack.com/p/regex-is-almost-all-you-need).
|
|
|
|
|
|
-
|
|
|
```
|
|
|
➜ ~/code(master) gitleaks git -v
|
|
|
|
|
|
@@ -61,6 +57,11 @@ Date: 2022-08-03T12:31:40Z
|
|
|
Fingerprint: cd5226711335c68be1e720b318b7bc3135a30eb2:cmd/generate/config/rules/sidekiq.go:sidekiq-secret:23
|
|
|
```
|
|
|
|
|
|
+### GitHub Sponsors
|
|
|
+
|
|
|
+Sponsor [@zricethezav on GitHub](https://github.com/sponsors/zricethezav/) to get
|
|
|
+featured on this README.
|
|
|
+
|
|
|
## Getting Started
|
|
|
|
|
|
Gitleaks can be installed using Homebrew, Docker, or Go. Gitleaks is also available in binary form for many popular platforms and OS types on the [releases page](https://github.com/gitleaks/gitleaks/releases). In addition, Gitleaks can be implemented as a pre-commit hook directly in your repo or as a GitHub action using [Gitleaks-Action](https://github.com/gitleaks/gitleaks-action).
|
|
|
@@ -646,3 +647,5 @@ You can always set the exit code when leaks are encountered with the --exit-code
|
|
|
1 - leaks or error encountered
|
|
|
126 - unknown flag
|
|
|
```
|
|
|
+
|
|
|
+### Join the Discord! [](https://discord.gg/8Hzbrnkr7E)
|