-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathhelp_doc.txt
35 lines (20 loc) · 1.1 KB
/
help_doc.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
gen-report - Generates and stores a Client Report, it uses Redis for storage.
FLAGS:
--help -- Displays this help text
--test -- Run the test suite to ensure correct functionality
-n [CLIENT_NAME] -- Set client name
-p [CLIENT_PHONE] -- Set client phone number
-e [CLIENT_EMAIL] -- Set Client email address
-b -- [CLIENT_BUSINESS_NAME] Set client bussiness name
-h -- [CLIENT_HOURS] Set Client Hours
-t [REPORT_KEY_TO_EDIT] -- Edits a report based on it’s Redis key
-x [REPORT_TO_EXPORT] -- Export specified report as a plain text file
-l [REPORT_REDIS_KEY] -- Display the report associated with the REPORT_REDIS_KEY.
-k -- List all stored Redis keys
-q -- Get a list of today's reports
Example Usage:
-To display help: [gen-report --help]
-To store a basic report: [gen-report -n "Bob Ross" -p "(123)456-7890" -e "[email protected]" -b "Google Inc" -h "7.4"]
-To display a report: [gen-report -l "first_last_2020-01-01"]
Author: CodeCanna
GitHub: https://github.com/CodeCanna