- Semgrep CLI
- Semgrep Code
- Team & Enterprise Tier
This document provides the outputs of the
semgrep --help and
semgrep scan --help commands of the Semgrep command-line interface (CLI). In addition, this page also gives an overview of the Semgrep CLI exit codes.
For a list of available commands, run the following command:
Usage: semgrep [OPTIONS] COMMAND [ARGS]...
To get started quickly, run `semgrep scan --config auto`
Run `semgrep SUBCOMMAND --help` for more information on each subcommand
If no subcommand is passed, will run `scan` subcommand by default
-h, --help Show this message and exit.
ci The recommended way to run semgrep in CI
install-semgrep-pro Install the Semgrep Pro Engine
login Obtain and save credentials for semgrep.dev
logout Remove locally stored credentials to semgrep.dev
lsp Start the Semgrep LSP server (useful for IDEs)
publish Upload rule to semgrep.dev
scan Run semgrep rules on files
show Show various information about Semgrep
Semgrep scan command options
To list all available
semgrep scan options, run the following command:
semgrep scan --help
semgrep scan - run semgrep rules on files
semgrep scan [OPTION]… [TARGETS]…
Searches TARGET paths for matches to rules or patterns. Defaults to
searching entire current working directory.
To get started quickly, run
semgrep --config auto .
This will automatically fetch rules for your project from the Semgrep
Registry. NOTE: Using `--config auto` will log in to the Semgrep
Registry with your project URL.
For more information about Semgrep, go to https://semgrep.dev.
NOTE: By default, Semgrep will report pseudonymous usage metrics to
its server if you pull your configuration from the Semgrep registry.
To learn more about how and why these metrics are collected, please
see https://semgrep.dev/docs/metrics. To modify this behavior, see the
--metrics option below.
Files or folders to be scanned by semgrep.
Apply autofix patches. WARNING: data loss can occur with this
flag. Make sure your files are stored in a version control system.
Note that this mode is experimental and not guaranteed to function
Run postprocessors from untrusted sources.
Store in ~/.semgrep/cache/asts/ the parsed ASTs to speedup things.
--baseline-commit=VAL (absent SEMGREP_BASELINE_COMMIT env)
Only show results that are not found in this commit hash. Aborts
run if not currently in a git directory, there are unstaged
changes, or given baseline hash doesn't exist.
Enable support for secret validation. Requires Semgrep Secrets,
contact email@example.com for more informationon this.
<internal, do not use>
Explain how non-local values reach the location of a finding (only
affects text and SARIF output).
All of --verbose, but with additional debugging information.
Living on the edge.
The depth of the Pro (interfile) differential scan, the number of
steps (both in the caller and callee sides) from the targets in
the call graph tracked by the deep preprocessor. Only applied in
differential scan mode. Default to 2.
If --dryrun, does not write autofixes to a file. This will print
the changes to the console. This lets you see the changes before
you commit to them. Only works with the --autofix flag. Otherwise
If --dump-ast, shows AST of the input file or passed expression
and then exit (can use --json).
<internal, do not use>
-e VAL, --pattern=VAL
Code search pattern. See
information on pattern features.
Output results in Emacs single-line format.
Enables 'nosem'. Findings will not be reported on lines containing
a 'nosem' comment at the end. Enabled by default.
--enable-version-check (absent SEMGREP_ENABLE_VERSION_CHECK env)
Checks Semgrep servers to see if the latest version is run;
disabling this may reduce exit time after returning results.
Exit 1 if there are findings. Useful for CI and scripts.
Skip any file or directory that matches this pattern;
--exclude='*.py' will ignore the following: foo.py, src/foo.py,
foo.py/bar.sh. --exclude='tests' will ignore tests/foo.py as well
as a/b/tests/c/foo.py. Can add multiple times. If present, any
--include directives are ignored.
Skip any rule with the given id. Can add multiple times.
Enable experimental features.
-f VAL, -c VAL, --config=VAL (absent SEMGREP_RULES env)
YAML configuration file, directory of YAML files ending in
.yml|.yaml, URL of a configuration file, or Semgrep registry entry
name. Use --config auto to automatically obtain rules tailored to
this project; your project URL will be used to log in to the
Semgrep registry. To run multiple rule files simultaneously, use
--config before every YAML, URL, or Semgrep registry entry name.
For example `semgrep --config p/python --config
https://semgrep.dev/docs/writing-rules/rule-syntax for information
on configuration file format.
--force-color (absent SEMGREP_FORCE_COLOR env)
Always include ANSI color in the output, even if not writing to a
TTY; defaults to using the TTY status
Output results in GitLab SAST format.
Output results in GitLab Secrets format.
Filter files or directories by path. The argument is a glob-style
pattern such as 'foo.*' that must match the path. This is an extra
filter in addition to other applicable filters. For example,
'src/foo.jsx' and 'lib/bar.js'. Specifying one of '--include=src',
'-- include=*.jsx', or '--include=src/foo.*' will restrict the
selection to the single file 'src/foo.jsx'. A choice of multiple
'-- include' patterns can be specified. For example,
'--include=foo.* --include=bar.*' will select both 'src/foo.jsx'
and 'lib/bar.js'. Glob-style patterns follow the syntax supported
by python, which is documented at
Maximum time to spend on interfile analysis. If set to 0 will not
have time limit. Defaults to 0 s for all CLI scans. For CI scans,
it defaults to 3 hours.
-j VAL, --jobs=VAL (absent=4)
Number of subprocesses to use to run checks in parallel. Defaults
to the number of cores detected on the system (1 if using --pro).
Output results in Semgrep's JSON format.
Output results in JUnit XML format.
-l VAL, --lang=VAL
Parse pattern and all files in specified language. Must be used
Prefer old (legacy) behavior.
Add debugging information in the JSON output to trace how
different parts of a rule are matched (a.k.a., "Inspect Rule" in
the Semgrep playground)
Maximum number of characters to show per line.
Maximum number of lines of code that will be shown for each match
before trimming (set to 0 for unlimited).
Maximum system memory to use running a rule on a single file in
MiB. If set to 0 will not have memory limit. Defaults to 0. For CI
scans that use the Pro Engine, it defaults to 5000 MiB.
Maximum size for a file to be scanned by Semgrep, e.g '1.5MB'. Any
input program larger than this will be ignored. A zero or negative
value disables this filter. Defaults to 1000000 bytes
--metrics=VAL (absent=auto or SEMGREP_SEND_METRICS env)
Configures how usage metrics are sent to the Semgrep server. If
'auto', metrics are sent whenever the --config value pulls from
the Semgrep server. If 'on', metrics are always sent. If 'off',
metrics are disabled altogether and not sent. If absent, the
SEMGREP_SEND_METRICS environment variable value will be used. If
no environment variable, defaults to 'auto'.
Disables secrets validation
-o VAL, --output=VAL
Save search results to a file or post to URL. Default is to print
Turn on/off optimizations. Default = 'all'. Use 'none' to turn all
Run using only OSS features, even if the Semgrep Pro toggle is on.
Inter-file analysis and Pro languages (currently just Apex).
Requires Semgrep Pro Engine, contact firstname.lastname@example.org for more
information on this.
Intra-file inter-procedural taint analysis. Implies
--pro-languages. Requires Semgrep Pro Engine, contact
email@example.com for more information on this.
Enable Pro languages (currently just Apex). Requires Semgrep Pro
Engine, contact firstname.lastname@example.org for more information on this.
The project root for gitignore and semgrepignore purposes is
detected automatically from the presence of a .git/ directory in
the current directory or one of its parents. If not found, the
current directory is used as the project root. This option forces
a specific directory to be the project root. This is useful for
testing or for restoring compatibility with older semgrep
implementations that only looked for a .semgrepignore file in the
Only output findings.
Cache for 24 hours in ~/.semgrep/cache rules from the registry.
An autofix expression that will be applied to any matches found
with --pattern. Only valid with a command-line specified pattern.
Rewrite rule ids when they appear in nested sub-directories (Rule
'foo' in test/rules.yaml will be renamed 'test.foo').
Output results in SARIF format.
If true, explicit files will be scanned using the language
specified in --lang. If --skip-unknown-extensions, these files
will not be scanned. Defaults to false.
Report findings only from rules matching the supplied severity
level. By default all applicable rules are run. Can add multiple
times. Each should be one of INFO, WARNING, or ERROR.
Print a list of languages that are currently supported by Semgrep.
Return a nonzero exit code when WARN level errors are encountered.
Fails early if invalid configuration files are present. Defaults
Run test suite.
If --test-ignore-todo, ignores rules marked as '#todoruleid:' in
Output results in text format.
Include a timing summary with the results. If output format is
json, provides times for each pair (rule, target).
Maximum time to spend running a rule on a single file in seconds.
If set to 0 will not have time limit. Defaults to 5.0 s.
Maximum number of rules that can time out on a file before the
file is skipped. If set to 0 will not have limit. Defaults to 3.
Skip files ignored by git. Scanning starts from the root folder
specified on the Semgrep command line. Normally, if the scanning
root is within a git repository, only the tracked files and the
new files would be scanned. Git submodules and git- ignored files
would normally be skipped. --no-git-ignore will disable git-aware
filtering. Setting this flag does nothing if the scanning root is
not in a git repository.
Show more details about what rules are running, which files failed
to parse, etc.
Validate configuration file(s). This will check YAML files for
errors and run 'p/semgrep-rule-lints' on the YAML files. No search
Show the version and exit.
Output results in vim single-line format.
Show this help in format FMT. The value FMT must be one of auto,
pager, groff or plain. With auto, the format is pager or plain
whenever the TERM env var is dumb or undefined.
semgrep scan exits with:
0 on success.
123 on indiscriminate errors reported on standard error.
124 on command line parsing errors.
125 on unexpected internal errors (bugs).
These environment variables affect the execution of semgrep scan:
See option --baseline-commit.
See option --enable-version-check.
See option --force-color.
See option --config.
See option --metrics.
Semgrep Inc. <email@example.com>
If you encounter an issue, please report it at
The Semgrep command line tool supports a
.semgrepignore file that follows
.gitignore syntax and is used to skip files and directories during scanning. This is commonly used to avoid vendored and test related code. For a complete example, see the .semgrepignore file on Semgrep’s source code.
In addition to
.semgrepignore there are several methods to set up ignore patterns. See Ignoring files, folders, or code.
Connecting to Semgrep Registry through a proxy
Semgrep uses the Python3
requests library. Set the following environment variables to point to your proxy:
Semgrep can finish with the following exit codes:
- 0: Semgrep ran successfully and found no errors (or did find errors, but the
--errorflag is not being used).
- 1: Semgrep ran successfully and found issues in your code (while using the
- 2: Semgrep failed.
- 3: Invalid syntax of the scanned language. This error occurs only while using the
- 4: Semgrep encountered an invalid pattern in the rule schema.
- 5: Semgrep configuration is not valid YAML.
- 7: At least one rule in the configuration is invalid.
- 8: Semgrep does not understand specified language.
- 13: The API key is invalid.
- 14: Semgrep scan failed.