summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAnatoliiER <70503278+AnatoliiER@users.noreply.github.com>2020-10-05 17:32:35 +0300
committerGitHub <noreply@github.com>2020-10-05 17:32:35 +0300
commitb4c2c8569f77d737384d4f93467e299ad81b33fa (patch)
treeb3f4067e781546e7d131d5bda61164d6835ded7d
parentcc67e747f7242c8f4b4147fd401828efb28874b3 (diff)
downloadcve-checker-b4c2c8569f77d737384d4f93467e299ad81b33fa.tar.gz
cve-checker-b4c2c8569f77d737384d4f93467e299ad81b33fa.zip
Update README.md
Add Usage
-rw-r--r--README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md
index 8dd1e66..13f4be9 100644
--- a/README.md
+++ b/README.md
@@ -8,3 +8,20 @@ vulners
# Install and dependencies:
- Python 3.7+
- MongoDB 4.2+
+
+# Usage:
+[command][option1][option2]
+--help
+--init-db - The command is required when you first run the utility
+--update-vulners-db - [date1, date2] - get updates of vulnerabilities database from date1 to date2 (only for trial, professional, etc. Vulners.com accounts)
+--update-db - get updates of vulnerabilities database (Upgrade based on free databases)
+--update-info - get information about the number of new CVEs, missing in the database. Checking is carried out on the basis of MitreCVE db.
+--start [name of file with packages information, (This is the output of the command: apt list --installed)
+ Code name of Debian version on which VyOS is based (for example: Stretch, Buster)]
+For example:
+cve.checker.py --help
+cve.checker.py --init-db
+cve.checker.py --update-vulners-db 01.01.2020 30.09.2020
+cve.checker.py --update-db
+cve.checker.py --update-info
+cve.checker.py --start /tmp/packages.txt Buster