> ## Documentation Index > Fetch the complete documentation index at: https://docs.semgrep.dev/llms.txt > Use this file to discover all available pages before exploring further. # CLI reference This document provides the outputs of the following [Semgrep CLI](https://github.com/semgrep/semgrep) tool commands: * `semgrep --help` * `semgrep scan --help` * `semgrep ci --help` In addition, this page also gives an overview of the Semgrep CLI exit codes. ## Semgrep commands For a list of available commands, run the following command: ```bash theme={null} semgrep --help ``` Command output: ```bash expandable theme={null} 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 Options: -h, --help Show this message and exit. Commands: ci Run Semgrep on a git diff (for use 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 local folders or files show Show various types of information test Test the rules (EXPERIMENTAL improvements over scan --test) validate Validate the rules (EXPERIMENTAL improvements over scan --validate) mcp Start the Semgrep MCP server ``` ## `semgrep ci` and `semgrep scan` command options You can invoke Semgrep using the CLI with either `semgrep ci` or `semgrep scan`. The `semgrep scan` command is primarily used for local scans and is suitable if you want to scan your codebase for security issues without requiring a Semgrep account. You can run scans using specific rules or rulesets. For example, to use the default ruleset, the command would be `semgrep scan --config "p/default"`. By default, these scans don't return failing error codes on findings for further handling. The `semgrep ci` command is primarily used in CI pipelines for both full scans of codebases, as well as diff-aware scans that are initiated in the context of a pull request or a merge request. With `semgrep ci`, Semgrep uses the policies and rules defined by your organization. It also uses cross-file (interfile) and cross-function (intrafile) analysis for improved results. By default, these scans return failing error codes on findings for further handling. You can list all available `semgrep ci` or `semgrep scan` options by running `semgrep ci --help` or `semgrep scan --help`, respectively. The available options are also listed below; **select the tab that best fits the command that you're using.** ```bash expandable theme={null} NAME semgrep scan - run semgrep rules on files SYNOPSIS semgrep scan [OPTION]… [TARGETS]… DESCRIPTION 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/metrics. To modify this behavior, see the --metrics option below. ARGUMENTS TARGETS Files or folders to be scanned by semgrep. OPTIONS -a, --autofix 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 properly. --allow-local-builds Experimental: allow building projects contained in the repository. This allows Semgrep to identify dependencies and dependency relationships when lockfiles are not present or are insufficient. However, building code may inherently require the execution of code contained in the scanned project or in its dependencies, which is a security risk. --allow-untrusted-validators Allows running rules with validators from origins other than semgrep.dev. Avoid running rules from origins you don't trust. --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. -d, --dump-command-for-core --dataflow-traces Explain how non-local values reach the location of a finding (only affects text and SARIF output). --disable-nosem negates --enable-nosem --disable-version-check negates --enable-version-check --dryrun 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 does nothing. --dump-ast If --dump-ast, shows AST of the input file or passed expression and then exit (can use --json). --dump-engine-path -e VAL, --pattern=VAL Code search pattern. See https://semgrep.dev/writing-rules/pattern-syntax for information on pattern features. --emacs Output results in Emacs single-line format. --emacs-output=VAL Write a copy of the emacs output to a file or post to URL. --enable-nosem 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. --error Exit 1 if there are findings. Useful for CI and scripts. --exclude=PATTERN Skip any file or directory whose path that matches 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'. Multiple '--exclude' options may be specified. PATTERN is a glob-style pattern that uses the same syntax as gitignore and semgrepignore, which is documented at https://git-scm.com/gitignore#_pattern_format --exclude-minified-files Skip minified files. These are files that are < 7% whitespace, or which have an average of > 1000 bytes per line. By default minified files are scanned. --exclude-rule=VAL Skip any rule with the given id. Can add multiple times. -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 myrules/myrule.yaml` See https://semgrep.dev/writing-rules/rule-syntax for information on configuration file format. --files-with-matches Output only the names of files containing matches. REQUIRES --experimental --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 --gitlab-sast Output results in GitLab SAST format. --gitlab-sast-output=VAL Write a copy of the GitLab SAST output to a file or post to URL. --gitlab-secrets Output results in GitLab Secrets format. --gitlab-secrets-output=VAL Write a copy of the GitLab Secrets output to a file or post to URL. --historical-secrets Scans git history using Secrets rules. --include=PATTERN Specify files or directories that should be scanned by semgrep, excluding other files. This filter is applied after these other filters: '--exclude' options, any filtering done by git (or other SCM), and filtering by '.semgrepignore' files. Multiple '--include' options can be specified. A file path is selected if it matches at least one of the include patterns. PATTERN is a glob-style pattern such as 'foo.*' that must match the path. For example, specifying the language with '-l javascript' might preselect files '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 gitignore and semgrepignore, which is documented at https://git-scm.com/gitignore#_pattern_format --incremental-output Output results incrementally. REQUIRES --experimental --interfile-timeout=INT (absent=0) 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 VALUE, --jobs=VALUE (absent=3) Degree of parallelism to use for parallel scanning, either using shared-memory threads (the default) or the legacy process-based parallelism (enabled with the deprecated --x-parmap flag). Semgrep recommends under-provisioning the job count by 10-15 percent to account for overhead from the garbage collector managing the shared heap (for example, on a 12-core box, a -j value of 10 or 11 would be considered a good starting value). We highly recommend that users do not _oversubscribe_ threads to CPUs, since this has been seen to induce significant GC latency and slow scan times. (Doing so will log a warning in debug mode.) The default jobs value is derived from the number of logical cores that are detected by Semgrep, scaled by 0.85. --json Output results in Semgrep's JSON format. --json-output=VAL Write a copy of the json output to a file or post to URL. --junit-xml Output results in JUnit XML format. --junit-xml-output=VAL Write a copy of the JUnit XML output to a file or post to URL. -l VAL, --lang=VAL Parse pattern and all files in specified language. Must be used with -e/--pattern. --matching-explanations 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) --max-chars-per-line=INT (absent=160) Maximum number of characters to show per line. --max-lines-per-finding=INT (absent=10) Maximum number of lines of code that will be shown for each match before trimming (set to 0 for unlimited). --max-log-list-entries=INT (absent=100) Maximum number of entries that will be shown in the log (e.g., list of rule ids, list of skipped files). A zero or negative value disables this filter. Defaults to 100 --max-memory=INT (absent=0) Maximum system memory in MiB to use during the interfile pre-processing phase, or when running a rule on a single file. If set to 0, will not have memory limit. Defaults to 0. For CI scans that use the Pro Engine, defaults to 5000 MiB. --max-target-bytes=VALUE (absent=1000000) 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=ENUM (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 or if the user is logged in. 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'. --no-autofix negates -a/--autofix --no-dryrun negates --dryrun --no-error negates --error --no-exclude-minified-files negates --exclude-minified-files --no-force-color negates --force-color --no-git-ignore negates --use-git-ignore --no-rewrite-rule-ids negates --rewrite-rule-ids --no-secrets-validation Disables secret validation. --no-strict negates --strict --no-test-ignore-todo negates --test-ignore-todo --no-time negates --time --novcs Assume the project is not managed by a version control system (VCS), even if the project appears to be under version control based on the presence of files such as '.git' or similar. REQUIRES --experimental or --semgrepignore-v2. -o VAL, --output=VAL Save search results to a file or post to URL. Default is to print to stdout. --optimizations=VALUE (absent=all) Turn on/off optimizations. Default = 'all'. Use 'none' to turn all optimizations off. --oss-only Run using only the OSS engine, even if the Semgrep Pro toggle is on. This may still run Pro rules, but only using the OSS features. --pro Inter-file analysis and Pro languages (currently Apex, C#, and Elixir. Requires Semgrep Pro Engine. See https://semgrep.dev/products/pro-engine/ for more. --pro-intrafile Intra-file inter-procedural taint analysis. Implies --pro-languages. Requires Semgrep Pro Engine. See https://semgrep.dev/products/pro-engine/ for more. --pro-languages Enable Pro languages (currently Apex, C#, and Elixir). Requires Semgrep Pro Engine. See https://semgrep.dev/products/pro-engine/ for more. --pro-path-sensitive Path sensitivity. Implies --pro-intrafile. Requires Semgrep Pro Engine. See https://semgrep.dev/products/pro-engine/ for more. --project-root=VAL Semgrep normally determines the type of project (git or novcs) and the project root automatically. The project root is then used to locate and use '.gitignore' and '.semgrepignore' files which determine target files that should be ignored by semgrep. This option forces the project root to be a specific folder and assumes a local project without version control (novcs). This option is useful to ensure the '.semgrepignore' file that may exist at the project root is consulted when the scanning root is not the current folder '.'. A valid project root must be a folder (path referencing a directory) whose physical path is a prefix of the physical path of the scanning roots passed on the command line. For example, the command 'semgrep scan --project-root . src' is valid if '.' is '/home/me' and 'src' is a directory or a symbolic link to a '/home/me/sources' directory or a symbolic link to a 'sources' directory but not if it is a symbolic link to a directory '/var/sources' (assuming '/var' is not a symbolic link). REQUIRES --experimental or --semgrepignore-v2. --remote=VAL Remote will quickly check out and scan a remote git repository of the format "http[s]:///.../.git". Must be run with --pro. Incompatible with --project-root. Note this requires an empty CWD as this command will clone the repository into the CWD. REQUIRES --experimental --replacement=VAL An autofix expression that will be applied to any matches found with --pattern. Only valid with a command-line specified pattern. --rewrite-rule-ids Rewrite rule ids when they appear in nested sub-directories (Rule 'foo' in test/rules.yaml will be renamed 'test.foo'). --sarif Output results in SARIF format. --sarif-output=VAL Write a copy of the SARIF output to a file or post to URL. --scan-unknown-extensions If true, target files specified directly on the command line will bypass normal language detection. They will be analyzed according to the value of --lang if applicable, or otherwise with the analyzers/languages specified in the Semgrep rule(s) regardless of file extension or file type. This setting doesn't apply to target files discovered by scanning folders. Defaults to false. --secrets Run Semgrep Secrets product, including support for secret validation. Requires access to Secrets, contact support@semgrep.com for more information. --secrets-timeout=INT (absent=30) Timeout in seconds for each secrets validation HTTP request. If set to 0, no timeout is applied. Defaults to 30. --semgrepignore-v2 [DEPRECATED] '--semgrepignore-v2' used to force the use of the newer Semgrepignore v2 implementation for discovering and filtering target files. It is now the default and only behavior. The transitional option '--no-semgrepignore-v2' is no longer available. --severity=ENUM 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. --show-supported-languages Print a list of languages that are currently supported by Semgrep. --skip-unknown-extensions negates --scan-unknown-extensions --strict Return a nonzero exit code when WARN level errors are encountered. Fails early if invalid configuration files are present. Defaults to --no-strict. --test Run test suite. --test-ignore-todo If --test-ignore-todo, ignores rules marked as '#todoruleid:' in test files. --text Output results in text format. --text-output=VAL Write a copy of the text output to a file or post to URL. --time Include a timing summary with the results. If output format is json, provides times for each pair (rule, target). This feature is meant for internal use and may be changed or removed without warning. At the current moment, --trace is better supported. --timeout=DOUBLE (absent=5.) 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. --timeout-threshold=INT (absent=3) 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. --use-git-ignore '--use-git-ignore' is Semgrep's default behavior. Under the default behavior, Git-tracked files are not excluded by Gitignore rules and only untracked files are excluded by Gitignore rules. '--no-git-ignore' causes semgrep to not call 'git' and not consult '.gitignore' files to determine which files semgrep should scan. As a result of '--no-git-ignore', gitignored files and Git submodules will be scanned unless excluded by other means ('.semgrepignore', '--exclude', etc.). This flag has no effect if the scanning root is not in a Git repository. --validate Validate configuration file(s). This will check YAML files for errors and run 'p/semgrep-rule-lints' on the YAML files. No search is performed. --version Show the version and exit. --vim Output results in vim single-line format. --vim-output=VAL Write a copy of the vim output to a file or post to URL. --x-mem-policy=VAL [INTERNAL] Heap and GC tuning policy. Only affects the Pro Engine. COMMON OPTIONS --debug All of --verbose, but with additional debugging information. --develop Living on the edge. --experimental Enable experimental features. --help[=FMT] (default=auto) 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. --legacy Prefer old (legacy) behavior. --no-trace negates --trace --profile Record profiles via Pyro Caml. By default sends them to localhost:4040 -q, --quiet Only output findings. --trace Record traces from Semgrep scans to help debugging. This feature is meant for internal use and may be changed or removed without warning. --trace-endpoint=VAL Endpoint to send OpenTelemetry traces to, if `--trace` is present. The value may be `semgrep-prod` (default), `semgrep-dev`, `semgrep-local`, or any valid URL. This feature is meant for internal use and may be changed or removed without warning. -v, --verbose Show more details about what rules are running, which files failed to parse, etc. EXPERIMENTAL OPTIONS Any option starting with '--x-' is experimental and may be removed from semgrep without notice. --no-x-run-taint-once [INTERNAL] Disable running taint analysis just once --x-disable-transitive-reachability [INTERNAL] Disable transitive reachability analysis regardless of app-based configuration. --x-dump-symbol-analysis [INTERNAL] Dump symbol analysis results in JSON format, ATD type 'symbol_analysis'. --x-eio [INTERNAL] --x-group-taint-rules [INTERNAL] Do not use --x-ignore-semgrepignore-files [INTERNAL] Ignore all '.semgrepignore' files found in the project tree for the purpose of selecting target files to be scanned by semgrep. Other filters may still apply. THIS OPTION IS NOT PART OF THE SEMGREP API AND MAY CHANGE OR DISAPPEAR WITHOUT NOTICE. --x-ls [INTERNAL] List the selected target files before any rule-specific or language-specific filtering. Then exit. The default output format is one path per line. THIS OPTION IS NOT PART OF THE SEMGREP API AND MAY CHANGE OR DISAPPEAR WITHOUT NOTICE. --x-ls-long [INTERNAL] Show selected targets and skipped targets with reasons why they were skipped, using an unspecified output format. Implies --x-ls. THIS OPTION IS NOT PART OF THE SEMGREP API AND MAY CHANGE OR DISAPPEAR WITHOUT NOTICE. --x-mcp [INTERNAL] This flag indicates that the scan is run by the MCP server. It is used to output extra info (e.g. rules, num bytes scanned) at the end of the scan for the MCP server to use and makes sure that metrics are not sent so that the MCP server can send its own metrics. --x-no-python-schema-validation [INTERNAL] Skip JSON schema validation; rely on osemgrep parser to validate rules files --x-parmap [INTERNAL] Rely on legacy Parmap-based parallelism --x-pro-naming [INTERNAL] Do not use --x-run-taint-once [INTERNAL] Run taint analysis just once (default: true) --x-semgrepignore-filename=FILENAME [INTERNAL] Files named FILENAME shall be consulted instead of the files named '.semgrepignore'. This option can be useful for testing semgrep on intentionally broken code that should normally be ignored. --x-simple-profiling Upon exit, print on stderr a report showing how long certain operations took, in an unspecified text format. --x-tr, --x-enable-transitive-reachability [INTERNAL] Enable transitive reachability analysis regardless of app-based configuration. Typically used with '--allow-local-builds'. EXIT STATUS semgrep scan exits with: 0 OK 1 some findings 2 fatal error 3 invalid target code 4 invalid pattern 5 unparseable YAML 7 missing configuration 8 invalid language 13 invalid API key 99 not implemented in osemgrep ENVIRONMENT These environment variables affect the execution of semgrep scan: SEMGREP_BASELINE_COMMIT See option --baseline-commit. SEMGREP_ENABLE_VERSION_CHECK See option --enable-version-check. SEMGREP_FORCE_COLOR See option --force-color. SEMGREP_RULES See option --config. SEMGREP_SEND_METRICS See option --metrics. AUTHORS Semgrep Inc. BUGS If you encounter an issue, please report it at https://github.com/semgrep/semgrep/issues ``` ```bash expandable theme={null} NAME semgrep ci - the recommended way to run semgrep in CI SYNOPSIS semgrep ci [OPTION]… DESCRIPTION In pull_request/merge_request (PR/MR) contexts, `semgrep ci` will only report findings that were introduced by the PR/MR. When logged in, `semgrep ci` runs rules configured on Semgrep App and sends findings to your findings dashboard. Only displays findings that were marked as blocking. OPTIONS -a, --autofix Currently ignored. --allow-local-builds Experimental: allow building projects contained in the repository. This allows Semgrep to identify dependencies and dependency relationships when lockfiles are not present or are insufficient. However, building code may inherently require the execution of code contained in the scanned project or in its dependencies, which is a security risk. --allow-untrusted-validators Allows running rules with validators from origins other than semgrep.dev. Avoid running rules from origins you don't trust. --audit-on=VAL (absent SEMGREP_AUDIT_ON env) --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. --code Run Semgrep Code (SAST) product. -d, --dump-command-for-core --dataflow-traces Explain how non-local values reach the location of a finding (only affects text and SARIF output). --disable-nosem negates --enable-nosem --disable-version-check negates --enable-version-check --dry-run When set, will not start a scan on semgrep.dev and will not report findings. Instead will print out json objects it would have sent. --dryrun Currently ignored. --emacs Output results in Emacs single-line format. --emacs-output=VAL Write a copy of the emacs output to a file or post to URL. --enable-nosem 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. --exclude=PATTERN Skip any file or directory whose path that matches 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'. Multiple '--exclude' options may be specified. PATTERN is a glob-style pattern that uses the same syntax as gitignore and semgrepignore, which is documented at https://git-scm.com/gitignore#_pattern_format --exclude-minified-files Skip minified files. These are files that are < 7% whitespace, or which have an average of > 1000 bytes per line. By default minified files are scanned. --exclude-rule=VAL Skip any rule with the given id. Can add multiple times. -f VAL, -c VAL, --config=VAL Not supported in 'ci' mode --fake-backend=VAL Internal flag. --files-with-matches Output only the names of files containing matches. REQUIRES --experimental --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 --gitlab-sast Output results in GitLab SAST format. --gitlab-sast-output=VAL Write a copy of the GitLab SAST output to a file or post to URL. --gitlab-secrets Output results in GitLab Secrets format. --gitlab-secrets-output=VAL Write a copy of the GitLab Secrets output to a file or post to URL. --historical-secrets Scans git history using Secrets rules. --include=PATTERN Specify files or directories that should be scanned by semgrep, excluding other files. This filter is applied after these other filters: '--exclude' options, any filtering done by git (or other SCM), and filtering by '.semgrepignore' files. Multiple '--include' options can be specified. A file path is selected if it matches at least one of the include patterns. PATTERN is a glob-style pattern such as 'foo.*' that must match the path. For example, specifying the language with '-l javascript' might preselect files '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 gitignore and semgrepignore, which is documented at https://git-scm.com/gitignore#_pattern_format --incremental-output Output results incrementally. REQUIRES --experimental --interfile-timeout=INT (absent=0) 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. --internal-ci-scan-results Internal flag. -j VALUE, --jobs=VALUE (absent=3) Degree of parallelism to use for parallel scanning, either using shared-memory threads (the default) or the legacy process-based parallelism (enabled with the deprecated --x-parmap flag). Semgrep recommends under-provisioning the job count by 10-15 percent to account for overhead from the garbage collector managing the shared heap (for example, on a 12-core box, a -j value of 10 or 11 would be considered a good starting value). We highly recommend that users do not _oversubscribe_ threads to CPUs, since this has been seen to induce significant GC latency and slow scan times. (Doing so will log a warning in debug mode.) The default jobs value is derived from the number of logical cores that are detected by Semgrep, scaled by 0.85. --json Output results in Semgrep's JSON format. --json-output=VAL Write a copy of the json output to a file or post to URL. --junit-xml Output results in JUnit XML format. --junit-xml-output=VAL Write a copy of the JUnit XML output to a file or post to URL. --log-backend=VAL Internal flag. --matching-explanations 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) --max-chars-per-line=INT (absent=160) Maximum number of characters to show per line. --max-lines-per-finding=INT (absent=10) Maximum number of lines of code that will be shown for each match before trimming (set to 0 for unlimited). --max-log-list-entries=INT (absent=100) Maximum number of entries that will be shown in the log (e.g., list of rule ids, list of skipped files). A zero or negative value disables this filter. Defaults to 100 --max-memory=INT (absent=0) Maximum system memory in MiB to use during the interfile pre-processing phase, or when running a rule on a single file. If set to 0, will not have memory limit. Defaults to 0. For CI scans that use the Pro Engine, defaults to 5000 MiB. --max-target-bytes=VALUE (absent=1000000) 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=ENUM (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 or if the user is logged in. 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'. --no-autofix negates -a/--autofix --no-dryrun negates --dryrun --no-exclude-minified-files negates --exclude-minified-files --no-force-color negates --force-color --no-git-ignore negates --use-git-ignore --no-rewrite-rule-ids negates --rewrite-rule-ids --no-secrets-validation Disables secret validation. --no-suppress-errors negates --suppress-errors -o VAL, --output=VAL Save search results to a file or post to URL. Default is to print to stdout. --optimizations=VALUE (absent=all) Turn on/off optimizations. Default = 'all'. Use 'none' to turn all optimizations off. --oss-only Run using only the OSS engine, even if the Semgrep Pro toggle is on. This may still run Pro rules, but only using the OSS features. --pro Inter-file analysis and Pro languages (currently Apex, C#, and Elixir. Requires Semgrep Pro Engine. See https://semgrep.dev/products/pro-engine/ for more. --pro-intrafile Intra-file inter-procedural taint analysis. Implies --pro-languages. Requires Semgrep Pro Engine. See https://semgrep.dev/products/pro-engine/ for more. --pro-languages Enable Pro languages (currently Apex, C#, and Elixir). Requires Semgrep Pro Engine. See https://semgrep.dev/products/pro-engine/ for more. --pro-path-sensitive Path sensitivity. Implies --pro-intrafile. Requires Semgrep Pro Engine. See https://semgrep.dev/products/pro-engine/ for more. --rewrite-rule-ids Rewrite rule ids when they appear in nested sub-directories (Rule 'foo' in test/rules.yaml will be renamed 'test.foo'). --sarif Output results in SARIF format. --sarif-output=VAL Write a copy of the SARIF output to a file or post to URL. --scan-unknown-extensions If true, target files specified directly on the command line will bypass normal language detection. They will be analyzed according to the value of --lang if applicable, or otherwise with the analyzers/languages specified in the Semgrep rule(s) regardless of file extension or file type. This setting doesn't apply to target files discovered by scanning folders. Defaults to false. --secrets Run Semgrep Secrets product, including support for secret validation. Requires access to Secrets, contact support@semgrep.com for more information. --secrets-timeout=INT (absent=30) Timeout in seconds for each secrets validation HTTP request. If set to 0, no timeout is applied. Defaults to 30. --semgrepignore-v2 [DEPRECATED] '--semgrepignore-v2' used to force the use of the newer Semgrepignore v2 implementation for discovering and filtering target files. It is now the default and only behavior. The transitional option '--no-semgrepignore-v2' is no longer available. --skip-unknown-extensions negates --scan-unknown-extensions --subdir=VAL Scan only a subdirectory of this folder. This creates a project specific to the subdirectory unless SEMGREP_REPO_DISPLAY_NAME is set. Expects a relative path. (Note that when two scans have the same SEMGREP_REPO_DISPLAY_NAME but different targeted directories, the results of the second scan overwrite the first.) --supply-chain Run Semgrep Supply Chain product. --suppress-errors (absent SEMGREP_SUPPRESS_ERRORS env) Configures how the CI command reacts when an error occurs. If true, encountered errors are suppressed and the exit code is zero (success). If false, encountered errors are not suppressed and the exit code is non-zero (failure). --text Output results in text format. --text-output=VAL Write a copy of the text output to a file or post to URL. --timeout=DOUBLE (absent=5.) 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. --timeout-threshold=INT (absent=3) 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. --use-git-ignore '--use-git-ignore' is Semgrep's default behavior. Under the default behavior, Git-tracked files are not excluded by Gitignore rules and only untracked files are excluded by Gitignore rules. '--no-git-ignore' causes semgrep to not call 'git' and not consult '.gitignore' files to determine which files semgrep should scan. As a result of '--no-git-ignore', gitignored files and Git submodules will be scanned unless excluded by other means ('.semgrepignore', '--exclude', etc.). This flag has no effect if the scanning root is not in a Git repository. --vim Output results in vim single-line format. --vim-output=VAL Write a copy of the vim output to a file or post to URL. --x-enable-mal-deps Enable malicious dependency rules for this scan. --x-mem-policy=VAL [INTERNAL] Heap and GC tuning policy. Only affects the Pro Engine. COMMON OPTIONS --debug All of --verbose, but with additional debugging information. --develop Living on the edge. --experimental Enable experimental features. --help[=FMT] (default=auto) 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. --legacy Prefer old (legacy) behavior. --no-trace negates --trace --profile Record profiles via Pyro Caml. By default sends them to localhost:4040 -q, --quiet Only output findings. --trace Record traces from Semgrep scans to help debugging. This feature is meant for internal use and may be changed or removed without warning. --trace-endpoint=VAL Endpoint to send OpenTelemetry traces to, if `--trace` is present. The value may be `semgrep-prod` (default), `semgrep-dev`, `semgrep-local`, or any valid URL. This feature is meant for internal use and may be changed or removed without warning. -v, --verbose Show more details about what rules are running, which files failed to parse, etc. EXPERIMENTAL OPTIONS Any option starting with '--x-' is experimental and may be removed from semgrep without notice. --no-x-run-taint-once [INTERNAL] Disable running taint analysis just once --x-computed-dependencies-dir=VAL Internal flag. --x-disable-transitive-reachability [INTERNAL] Disable transitive reachability analysis regardless of app-based configuration. --x-dump-rule-partitions=INT (absent=0) Internal flag. --x-dump-rule-partitions-dir=VAL Internal flag. --x-dump-rule-partitions-strategy=VAL Internal flag. --x-dump-scan-config-path=VAL Internal flag. --x-dump-subprojects-and-exit=VAL Internal flag. --x-eio [INTERNAL] --x-ignore-semgrepignore-files [INTERNAL] Ignore all '.semgrepignore' files found in the project tree for the purpose of selecting target files to be scanned by semgrep. Other filters may still apply. THIS OPTION IS NOT PART OF THE SEMGREP API AND MAY CHANGE OR DISAPPEAR WITHOUT NOTICE. --x-mcp [INTERNAL] This flag indicates that the scan is run by the MCP server. It is used to output extra info (e.g. rules, num bytes scanned) at the end of the scan for the MCP server to use and makes sure that metrics are not sent so that the MCP server can send its own metrics. --x-merge-partial-results-dir=DIR Internal flag. --x-merge-partial-results-output=VAL Internal flag. --x-no-python-schema-validation [INTERNAL] Skip JSON schema validation; rely on osemgrep parser to validate rules files --x-parmap [INTERNAL] Rely on legacy Parmap-based parallelism --x-partial-config=VAL Internal flag. --x-partial-output=VAL Internal flag. --x-pro-naming [INTERNAL] Do not use --x-run-taint-once [INTERNAL] Run taint analysis just once (default: true) --x-semgrepignore-filename=FILENAME [INTERNAL] Files named FILENAME shall be consulted instead of the files named '.semgrepignore'. This option can be useful for testing semgrep on intentionally broken code that should normally be ignored. --x-simple-profiling Upon exit, print on stderr a report showing how long certain operations took, in an unspecified text format. --x-tr, --x-enable-transitive-reachability [INTERNAL] Enable transitive reachability analysis regardless of app-based configuration. Typically used with '--allow-local-builds'. --x-upload-partial-results=VAL Internal flag. --x-upload-partial-results-scan-id=INT Internal flag. --x-use-saved-scan-config-path=VAL Internal flag. --x-validate-partial-results-actual=VAL Internal flag. --x-validate-partial-results-expected=VAL Internal flag. EXIT STATUS semgrep ci exits with: 0 OK 1 some findings 2 fatal error 3 invalid target code 4 invalid pattern 5 unparseable YAML 7 missing configuration 8 invalid language 13 invalid API key 99 not implemented in osemgrep ENVIRONMENT These environment variables affect the execution of semgrep ci: SEMGREP_AUDIT_ON See option --audit-on. SEMGREP_BASELINE_COMMIT See option --baseline-commit. SEMGREP_ENABLE_VERSION_CHECK See option --enable-version-check. SEMGREP_FORCE_COLOR See option --force-color. SEMGREP_SEND_METRICS See option --metrics. SEMGREP_SUPPRESS_ERRORS See option --suppress-errors. AUTHORS Semgrep Inc. BUGS If you encounter an issue, please report it at https://github.com/semgrep/semgrep/issues ``` ## Ignore files 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 vendor and test related code. For a complete example, see the [.semgrepignore file on Semgrep’s source code](https://github.com/semgrep/semgrep/blob/develop/.semgrepignore). In addition to `.semgrepignore` there are several methods to set up ignore patterns. See [Ignoring files, folders, or code](/ignoring-files-folders-code). ## Connect to Semgrep Registry through a proxy Semgrep uses the Python3 `requests` library. Set the following environment variables to point to your proxy: ```bash theme={null} export HTTP_PROXY="HTTP_PROXY_URL" export HTTPS_PROXY="HTTPS_PROXY_URL" ``` For example: ```bash theme={null} export HTTP_PROXY="http://10.10.1.10:3128" export HTTPS_PROXY="http://10.10.1.10:1080" ``` ## Exit codes Semgrep can finish with the following exit codes: * **0**: Semgrep ran successfully and found no errors (or did find errors, but the `--error` flag is **not** being used). * **1**: Semgrep ran successfully and found issues in your code (while using the `--error` flag). * **2**: Semgrep failed. * **3**: Invalid syntax of the scanned language. This error occurs only while using the `--strict` flag. * **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**: \[Deprecated] Semgrep scan failed. **TIP** To view the exit code when running `semgrep scan`, enter the following command immediately after the Semgrep scan finishes: ```bash theme={null} echo $? ``` The output is a single exit code, such as: ```bash theme={null} 1 ``` Not finding what you need in this doc? Ask questions in our [Community Slack group](https://go.semgrep.dev/slack), or see [Support](/support) for other ways to get help.