Skip to content

Commit

Permalink
new: Add CLI interface help
Browse files Browse the repository at this point in the history
  • Loading branch information
Rafiot committed Jun 7, 2024
1 parent af60692 commit d079c2b
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 3 deletions.
19 changes: 17 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
15 changes: 14 additions & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down

0 comments on commit d079c2b

Please sign in to comment.