Skip to content

Commit 3fe77d7

Browse files
committed
Update README to document new filtering options and required use of --reach flag
Signed-off-by: lelia <lelia@socket.dev>
1 parent 4376ca2 commit 3fe77d7

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ This will simultaneously generate:
114114
- SARIF report to `results.sarif` (and stdout)
115115
- GitLab Security Dashboard report to `gl-dependency-scanning-report.json`
116116

117-
> **Note:** `--enable-sarif` prints SARIF to stdout only. Use `--sarif-file <path>` to save to a file (this also implies `--enable-sarif`). These are independent from `--enable-gitlab-security`, which produces a separate GitLab-specific Dependency Scanning report.
117+
> **Note:** `--enable-sarif` prints SARIF to stdout only. Use `--sarif-file <path>` to save to a file (this also implies `--enable-sarif`). Add `--sarif-reachable-only` (requires `--reach`) to filter results down to only reachable findings — useful for uploading to GitHub Code Scanning without noisy alerts on unreachable vulns. These flags are independent from `--enable-gitlab-security`, which produces a separate GitLab-specific Dependency Scanning report.
118118
119119
### Requirements
120120

@@ -130,7 +130,7 @@ socketcli [-h] [--api-token API_TOKEN] [--repo REPO] [--workspace WORKSPACE] [--
130130
[--target-path TARGET_PATH] [--sbom-file SBOM_FILE] [--license-file-name LICENSE_FILE_NAME] [--save-submitted-files-list SAVE_SUBMITTED_FILES_LIST]
131131
[--save-manifest-tar SAVE_MANIFEST_TAR] [--files FILES] [--sub-path SUB_PATH] [--workspace-name WORKSPACE_NAME]
132132
[--excluded-ecosystems EXCLUDED_ECOSYSTEMS] [--default-branch] [--pending-head] [--generate-license] [--enable-debug]
133-
[--enable-json] [--enable-sarif] [--sarif-file <path>] [--enable-gitlab-security] [--gitlab-security-file <path>]
133+
[--enable-json] [--enable-sarif] [--sarif-file <path>] [--sarif-reachable-only] [--enable-gitlab-security] [--gitlab-security-file <path>]
134134
[--disable-overview] [--exclude-license-details] [--allow-unverified] [--disable-security-issue]
135135
[--ignore-commit-files] [--disable-blocking] [--enable-diff] [--scm SCM] [--timeout TIMEOUT] [--include-module-folders]
136136
[--reach] [--reach-version REACH_VERSION] [--reach-analysis-timeout REACH_ANALYSIS_TIMEOUT]
@@ -200,6 +200,7 @@ If you don't want to provide the Socket API Token every time then you can use th
200200
| --enable-json | False | False | Output in JSON format |
201201
| --enable-sarif | False | False | Enable SARIF output of results instead of table or JSON format (prints to stdout) |
202202
| --sarif-file | False | | Output file path for SARIF report (implies --enable-sarif). Use this to save SARIF output to a file for upload to GitHub Code Scanning, SonarQube, VS Code, or other SARIF-compatible tools |
203+
| --sarif-reachable-only | False | False | Filter SARIF output to only include reachable findings (requires --reach) |
203204
| --enable-gitlab-security | False | False | Enable GitLab Security Dashboard output format (Dependency Scanning report) |
204205
| --gitlab-security-file | False | gl-dependency-scanning-report.json | Output file path for GitLab Security report |
205206
| --disable-overview | False | False | Disable overview output |

0 commit comments

Comments
 (0)