scan
Scan git history, directories, and files for secrets
Description
The infisical scan
command serves to scan repositories, directories, and files. It’s compatible with both individual developer machines and Continuous Integration (CI) environments.
When you run infisical scan
on a Git repository, Infisical will parses the output of a git log -p
command. This command generates patches that Infisical uses to identify secrets in your code.
You can configure the range of commits that git log
will cover using the --log-opts
flag.
Any options you can use with git log -p
are valid for --log-opts
.
For instance, to instruct Infisical to scan a specific range of commits, use the following command: infisical scan --log-opts="--all commitA..commitB"
. For more details, refer to the Git log documentation.
To scan individual files and directories, use the --no-git
flag.
Flags
--log-opts
--log-opts
Description
git log options
--no-git
--no-git
Description
treat git repo as a regular directory and scan those files, —log-opts has no effect on the scan when —no-git is set
Default value: false
--pipe
--pipe
Short hand: -b
Description
scan input from stdin, ex: cat some_file | infisical scan --pipe
Default value: false
--follow-symlinks
--follow-symlinks
Short hand: -b
Description scan files that are symlinks to other files
Default value: false
--baseline-path
--baseline-path
Short hand: -b
Description
path to baseline with issues that can be ignored
--config
--config
Short hand: -c
Description
config file path
order of precedence:
- —config flag
- env var INFISICAL_SCAN_CONFIG
- (—source/-s)/.infisical-scan.toml If none of the three options are used, then Infisical will use the default config
--exit-code
--exit-code
Description
exit code when leaks have been encountered (default 1)
--max-target-megabytes
--max-target-megabytes
Description
files larger than this will be skipped
--no-color
--no-color
Description
turn off color for verbose output
--redact
--redact
Description
redact secrets from logs and stdout
--report-format
--report-format
Description
output format (json, csv, sarif) (default “json”)
--report-path
--report-path
Description
report file
--source
--source
Description
path to source (default ”.”)
--verbose
--verbose
Description
show verbose output from scan