vulnerability-lookup/pyvariot
13
1
Fork 0
mirror of https://github.com/cve-search/pyvariot.git synced 2024-11-23 07:17:21 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

new: Add CLI interface help

Browse source
This commit is contained in:
Raphaël Vinot 2024-06-07 16:16:16 +02:00
parent af60692c0c
commit d079c2b821
2 changed files with 31 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -12,11 +12,26 @@ pip install pyvariot
### Command line ### Command line
You can use the `variot` command to query the database: You can use the `pyvariot` command to query the database:
```bash ```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 ### Library
See [API Reference]() See [API Reference](https://pyvariot.readthedocs.io/en/latest/api_reference.html)

15
docs/source/index.rst
View file

@ -17,9 +17,22 @@ The package is available on PyPi, so you can install it with::
Usage Usage
----- -----
You can use `variot` as a python script:: You can use `pyvariot` as a python script::
$ variot -h $ 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: Or as a library: