Command Line Interpreter¶
cli¶
cli [OPTIONS] COMMAND [ARGS]...
Options
- -v, --version¶
Show the current version and exit
- -w, --where¶
Show the path where CveXplore is installed
capec¶
Query for capec specific data
cli capec [OPTIONS] COMMAND [ARGS]...
search¶
Search for capec entries by id
cli capec search [OPTIONS] COMMAND [ARGS]...
Options
- -c, --capec <capec>¶
Search for CAPEC’s (could be multiple)
- -f, --field <field>¶
Field to return (could be multiple).
* Option is mutually exclusive with the option(s): ‘field_list’. *
- -fl, --field_list¶
Return a field list for this collection.
* Option is mutually exclusive with the option(s): ‘field’. *
- -o, --output <output>¶
Set the desired output format (defaults to json)
- Options:¶
json | csv | xml | html
cpe¶
Query for cpe specific data
cli cpe [OPTIONS] COMMAND [ARGS]...
search¶
Search for cpe entries by name, vendor or title. Results are sorted ASCENDING by default
cli cpe search [OPTIONS] COMMAND [ARGS]...
Options
- -n, --name¶
Search by name.
* Option is mutually exclusive with the option(s): ‘field, cpe, title, vendor, field_list’. *
- -t, --title¶
Search by title (default).
* Option is mutually exclusive with the option(s): ‘field, cpe, name, vendor, field_list’. *
- -v, --vendor¶
Search by vendor.
* Option is mutually exclusive with the option(s): ‘field, cpe, name, title, field_list’. *
- -c, --cpe <cpe>¶
Search for CPE’s (could be multiple) by id.
* Option is mutually exclusive with the option(s): ‘name, title, vendor’. *
- -f, --field <field>¶
Field to return (could be multiple).
* Option is mutually exclusive with the option(s): ‘field_list, name, title, vendor’. *
- -fl, --field_list¶
Return a field list for this collection.
* Option is mutually exclusive with the option(s): ‘field, name, title, vendor’. *
- -m, --match <match>¶
Use match for searching.
* Option is mutually exclusive with the option(s): ‘regex’. *
- -r, --regex <regex>¶
Use regex for searching.
* Option is mutually exclusive with the option(s): ‘match’. *
- -d, --deprecated¶
Filter deprecated cpe’s
- -rc, --related_cve¶
Add related CVE’s
- -p, --product_search¶
Let CveXplore search for vulnerable products and not for vulnerable configurations
- -l, --limit <limit>¶
Search limit
- -s, --sort¶
Sort DESCENDING
- -o, --output <output>¶
Set the desired output format (defaults to json)
- Options:¶
json | csv | xml | html
cve¶
Query for cve specific data
cli cve [OPTIONS] COMMAND [ARGS]...
last¶
Query the last L (-l) amount of cve entries
cli cve last [OPTIONS] COMMAND [ARGS]...
Options
- -l, --limit <limit>¶
Query limit
- -o, --output <output>¶
Set the desired output format (defaults to json)
- Options:¶
json | csv | xml | html
search¶
Search for cve entries by id
cli cve search [OPTIONS] COMMAND [ARGS]...
Options
- -c, --cve <cve>¶
Search for CVE’s (could be multiple)
- -f, --field <field>¶
Field to return (could be multiple).
* Option is mutually exclusive with the option(s): ‘field_list’. *
- -fl, --field_list¶
Return a field list for this collection.
* Option is mutually exclusive with the option(s): ‘field’. *
- -o, --output <output>¶
Set the desired output format (defaults to json)
- Options:¶
json | csv | xml | html
cwe¶
Query for cwe specific data
cli cwe [OPTIONS] COMMAND [ARGS]...
search¶
Search for cwe entries by id
cli cwe search [OPTIONS] COMMAND [ARGS]...
Options
- -c, --cwe <cwe>¶
Search for CWE’s (could be multiple)
- -f, --field <field>¶
Field to return (could be multiple).
* Option is mutually exclusive with the option(s): ‘field_list’. *
- -fl, --field_list¶
Return a field list for this collection.
* Option is mutually exclusive with the option(s): ‘field’. *
- -o, --output <output>¶
Set the desired output format (defaults to json)
- Options:¶
json | csv | xml | html
database¶
Database update / populate commands
cli database [OPTIONS] COMMAND [ARGS]...
initialize¶
Initialize the database
cli database initialize [OPTIONS] COMMAND [ARGS]...
sources¶
Database source management
cli database sources [OPTIONS] COMMAND [ARGS]...
reset¶
Set sources
cli database sources reset [OPTIONS] COMMAND [ARGS]...
set¶
Set sources
cli database sources set [OPTIONS] COMMAND [ARGS]...
Options
- -v, --value <value>¶
Set the source key value
show¶
Show sources
cli database sources show [OPTIONS] COMMAND [ARGS]...
update¶
Update the database
cli database update [OPTIONS] COMMAND [ARGS]...
find¶
Perform find queries on a single collection
cli find [OPTIONS] COMMAND [ARGS]...
Options
- -c, --collection <collection>¶
Required Collection to query
- Options:¶
capec | cpe | cwe | via4 | cves
- -f, --field <field>¶
Required Field to query
- -v, --value <value>¶
Required Value to query
- -m, --match¶
Use match for searching (default).
* Option is mutually exclusive with the option(s): ‘regex’. *
- -r, --regex¶
Use regex for searching.
* Option is mutually exclusive with the option(s): ‘match’. *
- -l, --limit <limit>¶
Query limit
- -lf, --limit-field <limit_field>¶
Limit the return the this field(s) (could be multiple)
- -s, --sort¶
Sort DESCENDING (for match and regex only)
- -o, --output <output>¶
Set the desired output format (defaults to json)
- Options:¶
json | csv | xml | html
stats¶
Show datasource statistics
cli stats [OPTIONS] COMMAND [ARGS]...
tasks¶
Perform task related operations.
cli tasks [OPTIONS] COMMAND [ARGS]...
create¶
Perform action on tasks that are currently scheduled.
cli tasks create [OPTIONS] COMMAND [ARGS]...
Options
- -n, --number <number>¶
Required Create new task of type referred to by task id (id taken from ‘cvexplore tasks list’ command).
- -s, --slug <slug>¶
Required Slug of the task to create.
- -i, --interval <interval>¶
Use interval as tasks schedule; interval is in seconds..
* Option is mutually exclusive with the option(s): ‘crontab’. *
- -c, --crontab <crontab>¶
Use crontab as tasks schedule; use csv value in format ‘minute,hour,day_of_week,day_of_month,month_of_year’The crontab entry will be processed from left to right (from minute to month_of_year) with a ‘*’ as a default entry. That means that is you only need to set the minute value to every minute -c */1 will suffice..
* Option is mutually exclusive with the option(s): ‘interval’. *
list¶
List the available tasks that can be scheduled.
cli tasks list [OPTIONS] COMMAND [ARGS]...
scheduled¶
Perform action on tasks that are currently scheduled.
cli tasks scheduled [OPTIONS] COMMAND [ARGS]...
Options
- -l, --list¶
List tasks that are scheduled.
- -d, --delete <delete>¶
Delete scheduled tasks by task id (id taken from -l / –list command).
- -t, --toggle <toggle>¶
Toggle scheduled tasks by task id (id taken from -l / –list command) between the enabled and disabled states.
- -p, --purge <purge>¶
Purge the scheduled tasks results by task id (id taken from -l / –list command).
- -r, --results <results>¶
Show the (last 10) scheduled task results by task id (id taken from -l / –list command).