mirror of
https://github.com/cve-search/pyvariot.git
synced 2024-12-01 11:17:22 +00:00
new: Add CLI interface help
This commit is contained in:
parent
af60692c0c
commit
d079c2b821
2 changed files with 31 additions and 3 deletions
19
README.md
19
README.md
|
@ -12,11 +12,26 @@ pip install pyvariot
|
|||
|
||||
### Command line
|
||||
|
||||
You can use the `variot` command to query the database:
|
||||
You can use the `pyvariot` command to query the database:
|
||||
|
||||
```bash
|
||||
$ pyvariot --help
|
||||
usage: pyvariot [-h] [--url URL] [--apikey APIKEY]
|
||||
(--vulnerability_id VULNERABILITY_ID | --exploit_id EXPLOIT_ID)
|
||||
|
||||
Get a vulnerability or an exploit by ID.
|
||||
|
||||
options:
|
||||
-h, --help show this help message and exit
|
||||
--url URL URL of the instance.
|
||||
--apikey APIKEY Your personal API key.
|
||||
--vulnerability_id VULNERABILITY_ID
|
||||
ID of the vulnerability.
|
||||
--exploit_id EXPLOIT_ID
|
||||
ID of the exploit.
|
||||
|
||||
```
|
||||
|
||||
### Library
|
||||
|
||||
See [API Reference]()
|
||||
See [API Reference](https://pyvariot.readthedocs.io/en/latest/api_reference.html)
|
||||
|
|
|
@ -17,9 +17,22 @@ The package is available on PyPi, so you can install it with::
|
|||
Usage
|
||||
-----
|
||||
|
||||
You can use `variot` as a python script::
|
||||
You can use `pyvariot` as a python script::
|
||||
|
||||
$ variot -h
|
||||
usage: pyvariot [-h] [--url URL] [--apikey APIKEY]
|
||||
(--vulnerability_id VULNERABILITY_ID | --exploit_id EXPLOIT_ID)
|
||||
|
||||
Get a vulnerability or an exploit by ID.
|
||||
|
||||
options:
|
||||
-h, --help show this help message and exit
|
||||
--url URL URL of the instance.
|
||||
--apikey APIKEY Your personal API key.
|
||||
--vulnerability_id VULNERABILITY_ID
|
||||
ID of the vulnerability.
|
||||
--exploit_id EXPLOIT_ID
|
||||
ID of the exploit.
|
||||
|
||||
Or as a library:
|
||||
|
||||
|
|
Loading…
Reference in a new issue