Skip to content

Commit

Permalink
Update document
Browse files Browse the repository at this point in the history
  • Loading branch information
opeco17 committed Mar 4, 2024
1 parent f1de1c3 commit 7583d41
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,20 +38,36 @@ pip install poetry-audit-plugin
* `--json`: Export the result in JSON format.

* `--ignore-code`: Ignore some vulnerabilities IDs. Receive a list of IDs. For example:

```bash
poetry audit --ignore-code=CVE-2022-42969,CVE-2020-10684
```

* `--ignore-package`: Ignore some packages. Receive a list of packages. For example:

```bash
poetry audit --json --ignore-package=py,ansible-tower-cli
```

* `--proxy-protocol`, `--proxy-host`, `--proxy-port`: Proxy to access Safety DB. For example:

```bash
poetry audit --proxy-protocol=http --proxy-host=localhost --proxy-port=3128
```

* `--cache-sec`: How long Safety DB can be cached locally. For example:

```bash
poetry audit --cache-sec=60
```

## Exit codes

`poetry audit` will exit with a code indicating its status.

* `0`: Vulnerabilities were not found.
* `1`: One or more vulnerabilities were found.
* Others: Something wrong happened.

## Develop poetry-audit-plugin

Expand All @@ -69,6 +85,7 @@ Once you've done it, you can start developing poetry-audit-plugin. You can use t

```sh
cd tests/assets/no_vulnerabilities
poetry shell
poetry audit
```

Expand Down

0 comments on commit 7583d41

Please sign in to comment.