Skip to content
This repository was archived by the owner on Jan 22, 2026. It is now read-only.

Commit d0f8efd

Browse files
committed
Update vulnerability scanning documentation to include SARIF output format
1 parent c0a3678 commit d0f8efd

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

docs/vulns.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ $ git pkgs vulns main
2626
```
2727
-e, --ecosystem=NAME Filter by ecosystem (npm, rubygems, pypi, etc.)
2828
-s, --severity=LEVEL Minimum severity (critical, high, medium, low)
29-
-f, --format=FORMAT Output format (text, json)
29+
-f, --format=FORMAT Output format (text, json, sarif)
3030
-b, --branch=NAME Branch context for database queries
3131
--stateless Parse manifests directly without database
3232
--no-pager Do not pipe output into a pager
@@ -52,6 +52,21 @@ JSON output for CI/CD pipelines:
5252
$ git pkgs vulns -f json
5353
```
5454

55+
SARIF output for GitHub code scanning and other security tools:
56+
57+
```
58+
$ git pkgs vulns -f sarif > results.sarif
59+
```
60+
61+
SARIF (Static Analysis Results Interchange Format) is supported by GitHub Advanced Security, VS Code, and many CI/CD platforms. Upload to GitHub code scanning:
62+
63+
```yaml
64+
- run: git pkgs vulns --stateless -f sarif > results.sarif
65+
- uses: github/codeql-action/upload-sarif@v3
66+
with:
67+
sarif_file: results.sarif
68+
```
69+
5570
Compare vulnerabilities between releases:
5671
5772
```

0 commit comments

Comments
 (0)