Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README, _cli: Add a -S, --strict mode #146

Merged
merged 10 commits into from
Dec 1, 2021
Prev Previous commit
Next Next commit
README, _cli: Fix a small typo
woodruffw committed Nov 30, 2021

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
commit 9627575f230c598909a534d9a80529f4bf4541aa
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -34,7 +34,7 @@ usage: pip-audit [-h] [-V] [-l] [-r REQUIREMENTS]

audit the Python environment for dependencies with known vulnerabilities

optional arguments:
options:
-h, --help show this help message and exit
-V, --version show program's version number and exit
-l, --local show only results for dependencies in the local
@@ -49,8 +49,8 @@ optional arguments:
against (default: pypi)
-d, --dry-run collect all dependencies but do not perform the
auditing step (default: False)
-S, --strict fail the entire audit if dependency collection on any
dependency (default: False)
-S, --strict fail the entire audit if dependency collection fails
on any dependency (default: False)
--desc {on,off,auto} include a description for each vulnerability; `auto`
defaults to `on` for the `json` format. This flag has
no effect on the `cyclonedx-json` or `cyclonedx-xml`
2 changes: 1 addition & 1 deletion pip_audit/_cli.py
Original file line number Diff line number Diff line change
@@ -177,7 +177,7 @@ def audit() -> None:
"-S",
"--strict",
action="store_true",
help="fail the entire audit if dependency collection on any dependency",
help="fail the entire audit if dependency collection fails on any dependency",
)
parser.add_argument(
"--desc",