chg: [doc] usage updated

This commit is contained in:
Alexandre Dulaunoy 2022-01-03 15:16:05 +01:00
parent 29890e3b6d
commit 0a4fd6da61
Signed by: adulau
GPG key ID: 09E2CD4944E6CBCD

View file

@ -93,7 +93,7 @@ into separate virtualenvs to shield them from your system and each other.
### Usage ### Usage
~~~bash ~~~bash
usage: git-vuln-finder [-h] [-v] [-r R] [-o O] [-s S] [-p P] [-c] [-t] usage: git-vuln-finder [-h] [-v] [-r R] [-o O] [-s S] [-p P] [-c] [-t] [-gh GH]
Finding potential software vulnerabilities from git commit messages. Finding potential software vulnerabilities from git commit messages.
@ -103,12 +103,10 @@ optional arguments:
-r R git repository to analyse -r R git repository to analyse
-o O Output format: [json] -o O Output format: [json]
-s S State of the commit found -s S State of the commit found
-p P Matching pattern to use: [vulnpatterns, cryptopatterns, -p P Matching pattern to use: [vulnpatterns, cryptopatterns, cpatterns] - the pattern 'all' is used to match all the patterns at once.
cpatterns] - the pattern 'all' is used to match all the patterns -c output only a list of the CVE pattern found in commit messages (disable by default)
at once.
-c output only a list of the CVE pattern found in commit messages
(disable by default)
-t Include tags matching a specific commit -t Include tags matching a specific commit
-gh GH special option for gharchive, pass a file containing a PushEvent in JSON format
More info: https://github.com/cve-search/git-vuln-finder More info: https://github.com/cve-search/git-vuln-finder
~~~ ~~~