Gitleaks-readme-7.sh
· 2.2 KiB · Bash
Raw
Usage:
gitleaks [command]
Available Commands:
completion generate the autocompletion script for the specified shell
dir scan directories or files for secrets
git scan git repositories for secrets
help Help about any command
stdin detect secrets from stdin
version display gitleaks version
Flags:
-b, --baseline-path string path to baseline with issues that can be ignored
-c, --config string config file path
order of precedence:
1. --config/-c
2. env var GITLEAKS_CONFIG
3. (target path)/.gitleaks.toml
If none of the three options are used, then gitleaks will use the default config
--enable-rule strings only enable specific rules by id
--exit-code int exit code when leaks have been encountered (default 1)
-i, --gitleaks-ignore-path string path to .gitleaksignore file or folder containing one (default ".")
-h, --help help for gitleaks
--ignore-gitleaks-allow ignore gitleaks:allow comments
-l, --log-level string log level (trace, debug, info, warn, error, fatal) (default "info")
--max-decode-depth int allow recursive decoding up to this depth (default "0", no decoding is done)
--max-target-megabytes int files larger than this will be skipped
--no-banner suppress banner
--no-color turn off color for verbose output
--redact uint[=100] redact secrets from logs and stdout. To redact only parts of the secret just apply a percent value from 0..100. For example --redact=20 (default 100%)
-f, --report-format string output format (json, csv, junit, sarif) (default "json")
-r, --report-path string report file
-v, --verbose show verbose output from scan
--version version for gitleaks
Use "gitleaks [command] --help" for more information about a command.
| 1 | Usage: |
| 2 | gitleaks [command] |
| 3 | |
| 4 | Available Commands: |
| 5 | completion generate the autocompletion script for the specified shell |
| 6 | dir scan directories or files for secrets |
| 7 | git scan git repositories for secrets |
| 8 | help Help about any command |
| 9 | stdin detect secrets from stdin |
| 10 | version display gitleaks version |
| 11 | |
| 12 | Flags: |
| 13 | -b, --baseline-path string path to baseline with issues that can be ignored |
| 14 | -c, --config string config file path |
| 15 | order of precedence: |
| 16 | 1. --config/-c |
| 17 | 2. env var GITLEAKS_CONFIG |
| 18 | 3. (target path)/.gitleaks.toml |
| 19 | If none of the three options are used, then gitleaks will use the default config |
| 20 | --enable-rule strings only enable specific rules by id |
| 21 | --exit-code int exit code when leaks have been encountered (default 1) |
| 22 | -i, --gitleaks-ignore-path string path to .gitleaksignore file or folder containing one (default ".") |
| 23 | -h, --help help for gitleaks |
| 24 | --ignore-gitleaks-allow ignore gitleaks:allow comments |
| 25 | -l, --log-level string log level (trace, debug, info, warn, error, fatal) (default "info") |
| 26 | --max-decode-depth int allow recursive decoding up to this depth (default "0", no decoding is done) |
| 27 | --max-target-megabytes int files larger than this will be skipped |
| 28 | --no-banner suppress banner |
| 29 | --no-color turn off color for verbose output |
| 30 | --redact uint[=100] redact secrets from logs and stdout. To redact only parts of the secret just apply a percent value from 0..100. For example --redact=20 (default 100%) |
| 31 | -f, --report-format string output format (json, csv, junit, sarif) (default "json") |
| 32 | -r, --report-path string report file |
| 33 | -v, --verbose show verbose output from scan |
| 34 | --version version for gitleaks |
| 35 | |
| 36 | Use "gitleaks [command] --help" for more information about a command. |