Skip to content

Commit 9fc5ed6

Browse files
committed
Update README.md
1 parent 52210f3 commit 9fc5ed6

1 file changed

Lines changed: 18 additions & 3 deletions

File tree

README.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ Create a `config.json` file in one of the following locations with your API keys
9090
## 🚀 Usage
9191

9292
```shell
93-
$ sploitscan
93+
$ sploitscan.py -h
9494

9595
███████╗██████╗ ██╗ ██████╗ ██╗████████╗███████╗ ██████╗ █████╗ ███╗ ██╗
9696
██╔════╝██╔══██╗██║ ██╔═══██╗██║╚══██╔══╝██╔════╝██╔════╝██╔══██╗████╗ ██║
@@ -100,7 +100,22 @@ $ sploitscan
100100
╚══════╝╚═╝ ╚══════╝ ╚═════╝ ╚═╝ ╚═╝ ╚══════╝ ╚═════╝╚═╝ ╚═╝╚═╝ ╚═══╝
101101
v0.9 / Alexander Hagenah / @xaitax / ah@primepage.de
102102

103-
❌ No CVE IDs provided. Please provide CVE IDs or an import file and type.
103+
usage: sploitscan.py [-h] [-e {json,JSON,csv,CSV,html,HTML}] [-t {nessus,nexpose,openvas,docker}] [-i IMPORT_FILE] [cve_ids ...]
104+
105+
SploitScan: Retrieve and display vulnerability data as well as public exploits for given CVE ID(s).
106+
107+
positional arguments:
108+
cve_ids Enter one or more CVE IDs to fetch data. Separate multiple CVE IDs with spaces. Format for each ID: CVE-YYYY-NNNNN. This argument is optional if an import file is provided
109+
using the -n option.
110+
111+
options:
112+
-h, --help show this help message and exit
113+
-e {json,JSON,csv,CSV,html,HTML}, --export {json,JSON,csv,CSV,html,HTML}
114+
Optional: Export the results to a JSON, CSV, or HTML file. Specify the format: 'json', 'csv', or 'html'.
115+
-t {nessus,nexpose,openvas,docker}, --type {nessus,nexpose,openvas,docker}
116+
Specify the type of the import file: 'nessus', 'nexpose', 'openvas' or 'docker'.
117+
-i IMPORT_FILE, --import-file IMPORT_FILE
118+
Path to an import file from a vulnerability scanner. If used, CVE IDs can be omitted from the command line arguments.
104119
```
105120
106121
### Single CVE Query
@@ -163,7 +178,7 @@ SploitScan integrates with OpenAI to provide a comprehensive AI-powered risk ass
163178
164179
### Example output
165180
166-
```shell
181+
```text
167182

168183
$ sploitscan.py CVE-2024-21413
169184

0 commit comments

Comments
 (0)