Skip to content

Commit 3bfa27e

Browse files
ashokfaireandrew
authored andcommitted
Adjust the examples for running a vulnerability scan.
To run the scan, I believe you need to pass the subcommand. It looks like these documentation examples arrived very early in the repo and haven't changed, so I assume the behaviour I'm getting in 0.14.0 should match the documentation.
1 parent 4a20747 commit 3bfa27e

2 files changed

Lines changed: 7 additions & 7 deletions

File tree

content/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ git pkgs why rails # why was this added?
3535
git pkgs diff # HEAD vs working tree
3636
git pkgs diff --from=HEAD~10 # what changed recently?
3737
git pkgs diff main..feature # compare branches
38-
git pkgs vulns # scan for known CVEs
38+
git pkgs vulns scan # scan for known CVEs
3939
git pkgs vulns blame # who introduced each vulnerability
4040
git pkgs outdated # find packages with newer versions
4141
git pkgs update # update all dependencies
@@ -51,7 +51,7 @@ The database lives in `.git/pkgs.sqlite3` and stays current through git hooks. C
5151
Static scanners tell you what's vulnerable. git-pkgs tells you who introduced it, when, and how long it took to fix.
5252

5353
```bash
54-
git pkgs vulns # scan current dependencies
54+
git pkgs vulns scan # scan current dependencies
5555
git pkgs vulns blame # who introduced each vulnerability
5656
git pkgs vulns praise --summary # who fixes vulnerabilities fastest
5757
git pkgs vulns history lodash # timeline for a specific package

content/docs/vulnerabilities.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@ git-pkgs scans dependencies for known vulnerabilities using the [OSV](https://os
88
## Basic usage
99

1010
```bash
11-
git pkgs vulns # scan at HEAD
12-
git pkgs vulns v1.0.0 # scan at a tag
13-
git pkgs vulns -s high # only critical and high severity
14-
git pkgs vulns -e npm # filter by ecosystem
15-
git pkgs vulns -f sarif # output for GitHub code scanning
11+
git pkgs vulns scan # scan at HEAD
12+
git pkgs vulns scan -c v1.0.0 # scan at a commit or tag
13+
git pkgs vulns scan -s high # only critical and high severity
14+
git pkgs vulns scan -e npm # filter by ecosystem
15+
git pkgs vulns scan -f sarif # output for GitHub code scanning
1616
```
1717

1818
## Blame

0 commit comments

Comments
 (0)