2.0.1 • Published 2 years ago
chealth v2.0.1
chealth
Certify.Health CLI
Usage
$ npm install -g chealth
$ chealth COMMAND
running command...
$ chealth (-v|--version|version)
chealth/2.0.1 linux-x64 node-v16.4.1
$ chealth --help [COMMAND]
USAGE
$ chealth COMMAND
...Commands
chealthchealth batch:download:bookingschealth batch:download:requestschealth batch:upload:all-in-onechealth batch:upload:resultschealth config:clearchealth config:getchealth config:get-folderchealth config:listchealth config:removechealth config:setchealth download:bookingschealth download:requestschealth getchealth guichealth help [COMMAND]chealth listchealth loginchealth logoutchealth profiles:addchealth profiles:clearchealth profiles:listchealth profiles:refreshchealth profiles:removechealth upload:bookingschealth upload:resultschealth utils:compare-resultschealth utils:find-unique-resultschealth utils:process-resultschealth whoami
chealth
Local Web GUI of cli
USAGE
$ chealth
OPTIONS
-c, --configFolder=configFolder Config files folder (Only user if you need portable configuration file storage)
-h, --help Display help
-s, --silent Silent mode, with no information messages
EXAMPLE
$ chealth guiSee code: src/commands/index.ts
chealth batch:download:bookings
Downloads Bookings
USAGE
$ chealth batch:download:bookings
OPTIONS
-c, --configFolder=configFolder Config files folder (Only user if you need portable configuration file storage)
-d, --dates=dates Dates
-e, --email=email Email
-f, --format=csv|json|jsonl Output Format
-h, --help Display help
-o, --output=output Output CSV
-p, --phone=phone Phone
-r, --requestId=requestId Request Id
-s, --silent Silent mode, with no information messages
--after=after After (YYYY-MM-DD)
--before=before Before (YYYY-MM-DD)
--externalId=externalId ExternalId
--limit=limit Maximum number of items to fetch. Used in paging.
--output-delimiter=output-delimiter [default: ,] Output delimiter
--serviceId=serviceId Service Id
--skip=skip Number of elements to skip before fetch. Used in paging.
--sortOn=sortOn Sort field of items. Used in paging.
--sortOrder=ASC|DESC Sort order/direction
DESCRIPTION
Note: Either Dates or After and Before parameters are required.See code: src/commands/batch/download/bookings.ts
chealth batch:download:requests
Downloads requests
USAGE
$ chealth batch:download:requests
OPTIONS
-c, --configFolder=configFolder Config files folder (Only user if you need portable configuration file storage)
-d, --dates=dates Dates
-f, --format=csv|json|jsonl Output Format
-h, --help Display help
-o, --output=output Output CSV
-s, --silent Silent mode, with no information messages
-t, --testType=testType Test Type Code
--after=after After (YYYY-MM-DD)
--before=before Before (YYYY-MM-DD)
--[no-]demo Filter is demo/no-demo
--limit=limit Maximum number of items to fetch. Used in paging.
--output-delimiter=output-delimiter [default: ,] Output delimiter
--skip=skip Number of elements to skip before fetch. Used in paging.
--sortOn=sortOn Sort field of items. Used in paging.
--sortOrder=ASC|DESC Sort order/direction
DESCRIPTION
Note: Either Dates or After and Before parameters are required.See code: src/commands/batch/download/requests.ts
chealth batch:upload:all-in-one
Uploads Simple Test Results (externalId, final).
USAGE
$ chealth batch:upload:all-in-one
OPTIONS
-c, --configFolder=configFolder Config files folder (Only user if you need portable
configuration file storage)
-d, --dates=dates Dates
-h, --help Display help
-i, --inputs=inputs Input CSV
-l, --lab-information=lab-information Lab information
-l, --locale=en|es|ca|fr|sv Locale of document
-o, --output=output Output CSV
-s, --silent Silent mode, with no information messages
-t, --testType=pcr_test|antigen_test|antibody_test|vaccination Test type
--after=after After (YYYY-MM-DD)
--before=before Before (YYYY-MM-DD)
--input-delimiter=input-delimiter [default: ,] Input CSV delimiter
--logFilePrefix=logFilePrefix Log file prefix for operation logs. For every
organization, a new log file will be created by
following format:
<logFilePrefix>.<organizationId>.json. Example:
logs.10000000-0000-0000-0000-000000000000.json
--output-delimiter=output-delimiter [default: ,] Output delimiter
--rename-fail=rename-fail Failure rename pattern
--rename-success=rename-success Success rename pattern
--sample Get sample input file
--schema Get schema of input file format
--[no-]skip Skip existing results
DESCRIPTION
Auto downloads requests in given list of dates and for testType then auto-assigne locationId and profile and finally
uploads full result files.
Note: Either Dates or After and Before parameters are required.
EXAMPLES
chealth batch:upload:results-simple -i ./pcr_short_result1.csv ./pcr_short_result2.csv -o ./results.summary.csv -l en
-t pcr_test -d 2021-08-21 2021-08-22 2021-08-23 --lab-information "lab info test" --no-skip
--logFilePath=./logs/results.summary.logs
chealth batch:upload:results-simple -i ./pcr_short_result1.csv ./pcr_short_result2.csv -o ./results.summary.csv -l en
-t pcr_test --after 2021-08-01 --before 2021-09-01 --lab-information "lab info test" --no-skip
--logFilePath=./logs/results.summary.logsSee code: src/commands/batch/upload/all-in-one.ts
chealth batch:upload:results
Uploads Results
USAGE
$ chealth batch:upload:results
OPTIONS
-c, --configFolder=configFolder Config files folder (Only user if you need portable
configuration file storage)
-h, --help Display help
-i, --inputs=inputs Input CSV
-l, --locale=en|es|ca|fr|sv Locale of document
-o, --output=output Output CSV
-s, --silent Silent mode, with no information messages
-t, --testType=pcr_test|antigen_test|antibody_test|vaccination Test type
--input-delimiter=input-delimiter [default: ,] Input CSV delimiter
--logFilePrefix=logFilePrefix Log file prefix for operation logs. For every
organization, a new log file will be created by
following format:
<logFilePrefix>.<organizationId>.json. Example:
logs.10000000-0000-0000-0000-000000000000.json
--output-delimiter=output-delimiter [default: ,] Output delimiter
--rename-fail=rename-fail Failure rename pattern
--rename-success=rename-success Success rename pattern
--sample Get sample input file
--schema Get schema of input file format
--[no-]skip Skip existing resultsSee code: src/commands/batch/upload/results.ts
chealth config:clear
Clear config values
USAGE
$ chealth config:clear
OPTIONS
-c, --configFolder=configFolder Config files folder (Only user if you need portable configuration file storage)
-h, --help Display help
-s, --silent Silent mode, with no information messages
EXAMPLE
$ chealth config:clearSee code: src/commands/config/clear.ts
chealth config:get
Get config value
USAGE
$ chealth config:get
OPTIONS
-c, --configFolder=configFolder Config files folder (Only user
if you need portable
configuration file storage)
-f, --field=apiUrl|locale|keyPath|sessionLogLevel|enableCache|delimiter|labInformation Field
-h, --help Display help
-s, --silent Silent mode, with no
information messages
EXAMPLE
$ chealth config:get -f=localeSee code: src/commands/config/get.ts
chealth config:get-folder
Get config folder
USAGE
$ chealth config:get-folder
OPTIONS
-c, --configFolder=configFolder Config files folder (Only user if you need portable configuration file storage)
-h, --help Display help
-s, --silent Silent mode, with no information messages
EXAMPLE
$ chealth config:get-folder -c=./configSee code: src/commands/config/get-folder.ts
chealth config:list
List config values
USAGE
$ chealth config:list
OPTIONS
-c, --configFolder=configFolder Config files folder (Only user if you need portable configuration file
storage)
-h, --help Display help
-o, --format=csv|json|jsonl|table|table-pivot Output Format
-s, --silent Silent mode, with no information messages
EXAMPLE
$ chealth config:listSee code: src/commands/config/list.ts
chealth config:remove
Set config value
USAGE
$ chealth config:remove
OPTIONS
-c, --configFolder=configFolder Config files folder (Only user
if you need portable
configuration file storage)
-f, --field=apiUrl|locale|keyPath|sessionLogLevel|enableCache|delimiter|labInformation Field
-h, --help Display help
-o, --format=csv|json|jsonl|table|table-pivot Output Format
-s, --silent Silent mode, with no
information messages
-v, --value=value Value
EXAMPLE
$ chealth config:remove -f=localeSee code: src/commands/config/remove.ts
chealth config:set
Set config value
USAGE
$ chealth config:set
OPTIONS
-c, --configFolder=configFolder Config files folder (Only user
if you need portable
configuration file storage)
-f, --field=apiUrl|locale|keyPath|sessionLogLevel|enableCache|delimiter|labInformation Field
-h, --help Display help
-s, --silent Silent mode, with no
information messages
-v, --value=value Value
EXAMPLE
$ chealth config:set -f=locale -v=svSee code: src/commands/config/set.ts
chealth download:bookings
List Requests from Certify.Health API
USAGE
$ chealth download:bookings
OPTIONS
-c, --configFolder=configFolder Config files folder (Only user if you need portable configuration file storage)
-d, --dates=dates Dates
-e, --email=email Email
-f, --format=csv|json|jsonl Output Format
-h, --help Display help
-o, --output=output Output CSV
-p, --phone=phone Phone
-r, --requestId=requestId Request Id
-s, --silent Silent mode, with no information messages
--after=after After (YYYY-MM-DD)
--before=before Before (YYYY-MM-DD)
--externalId=externalId ExternalId
--limit=limit Maximum number of items to fetch. Used in paging.
--output-delimiter=output-delimiter [default: ,] Output delimiter
--serviceId=serviceId Service Id
--skip=skip Number of elements to skip before fetch. Used in paging.
--sortOn=sortOn Sort field of items. Used in paging.
--sortOrder=ASC|DESC Sort order/direction
EXAMPLE
$ chealth download:requests -d=2021-06-18 -l=12276320-bbc6-11eb-b87e-7f7111c1cefa
Note: Only requests with no result will be listed by default.
If you like to have all, you can user -a flag.See code: src/commands/download/bookings.ts
chealth download:requests
Download Requests from Certify.Health API
USAGE
$ chealth download:requests
OPTIONS
-a, --all Show all requests including already having results
-c, --configFolder=configFolder Config files folder (Only user if you need portable configuration file storage)
-d, --date=date Date (YYYY-MM-DD)
-f, --format=csv|json|jsonl Output Format
-h, --help Display help
-l, --locationId=locationId Location Id
-s, --silent Silent mode, with no information messages
-t, --testTypeId=testTypeId Test Type Id
--after=after After (YYYY-MM-DD)
--before=before Before (YYYY-MM-DD)
--[no-]demo Filter is demo/no-demo
--limit=limit Maximum number of items to fetch. Used in paging.
--skip=skip Number of elements to skip before fetch. Used in paging.
--sortOn=sortOn Sort field of items. Used in paging.
--sortOrder=ASC|DESC Sort order/direction
--testType=testType Test Type Code
EXAMPLE
$ chealth download:requests -d=2021-06-18 -l=12276320-bbc6-11eb-b87e-7f7111c1cefa
Note: Only requests with no result will be listed by default.
If you like to have all, you can user -a flag.See code: src/commands/download/requests.ts
chealth get
Get Data from Certify.Health API
USAGE
$ chealth get
OPTIONS
-c, --configFolder=configFolder Config files folder (Only user if you need portable
configuration file storage)
-e, --entity=organization|location|service|product|testType Entity
-h, --help Display help
-i, --id=id id
-o, --format=csv|json|table Output Format
-s, --silent Silent mode, with no information messages
EXAMPLE
$ chealth get -e=serviceSee code: src/commands/get.ts
chealth gui
Local Web GUI of cli
USAGE
$ chealth gui
OPTIONS
-c, --configFolder=configFolder Config files folder (Only user if you need portable configuration file storage)
-h, --help Display help
-s, --silent Silent mode, with no information messages
EXAMPLE
$ chealth guiSee code: src/commands/gui.ts
chealth help [COMMAND]
display help for chealth
USAGE
$ chealth help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLISee code: @oclif/plugin-help
chealth list
List Data from Certify.Health API
USAGE
$ chealth list
OPTIONS
-c, --configFolder=configFolder Config files folder (Only user if you need portable
configuration file storage)
-e, --entity=organization|location|service|product|testType Entity
-f, --format=csv|json|jsonl|table|table-pivot Output Format
-h, --help Display help
-s, --silent Silent mode, with no information messages
EXAMPLE
$ chealth list -e=serviceSee code: src/commands/list/index.ts
chealth login
Login to Certify.Health
USAGE
$ chealth login
OPTIONS
-c, --configFolder=configFolder Config files folder (Only user if you need portable configuration file storage)
-h, --help Display help
-o, --organizationId=organizationId Organization Id
-p, --password=password Certify.Health Password
-s, --silent Silent mode, with no information messages
-u, --username=username Certify.Health Username
EXAMPLE
$ chealth login -u=user123 -p=p123See code: src/commands/login.ts
chealth logout
Logout from Certify.Health API
USAGE
$ chealth logout
OPTIONS
-c, --configFolder=configFolder Config files folder (Only user if you need portable configuration file storage)
-h, --help Display help
-s, --silent Silent mode, with no information messages
EXAMPLE
$ chealth logoutSee code: src/commands/logout.ts
chealth profiles:add
Adds a new profile
USAGE
$ chealth profiles:add
OPTIONS
-c, --configFolder=configFolder Config files folder (Only user if you need portable configuration file storage)
-h, --help Display help
-k, --keyPath=keyPath Key path
-n, --profileName=profileName Profile Name
-p, --password=password Password
-s, --silent Silent mode, with no information messages
-u, --username=username Username
--keyPassphrase=keyPassphrase Key passphraseSee code: src/commands/profiles/add.ts
chealth profiles:clear
Removes all profiles
USAGE
$ chealth profiles:clear
OPTIONS
-c, --configFolder=configFolder Config files folder (Only user if you need portable configuration file storage)
-h, --help Display help
-s, --silent Silent mode, with no information messagesSee code: src/commands/profiles/clear.ts
chealth profiles:list
Lists profiles
USAGE
$ chealth profiles:list
OPTIONS
-c, --configFolder=configFolder Config files folder (Only user if you need portable configuration file storage)
-h, --help Display help
-s, --silent Silent mode, with no information messagesSee code: src/commands/profiles/list.ts
chealth profiles:refresh
Refreshes profiles. [33mCaution: logs out current session[39m
USAGE
$ chealth profiles:refresh
OPTIONS
-c, --configFolder=configFolder Config files folder (Only user if you need portable configuration file storage)
-h, --help Display help
-s, --silent Silent mode, with no information messagesSee code: src/commands/profiles/refresh.ts
chealth profiles:remove
Removes a profile
USAGE
$ chealth profiles:remove
OPTIONS
-c, --configFolder=configFolder Config files folder (Only user if you need portable configuration file storage)
-h, --help Display help
-o, --organizationId=organizationId OrganizationId
-s, --silent Silent mode, with no information messagesSee code: src/commands/profiles/remove.ts
chealth upload:bookings
Upload Bookings to Certify.Health API
USAGE
$ chealth upload:bookings
OPTIONS
-c, --configFolder=configFolder Config files folder (Only user if you need portable configuration file storage)
-f, --filePath=filePath File Path
-h, --help Display help
-s, --silent Silent mode, with no information messages
--format=csv|json Input Format
--sample Get sample input file
--schema Get schema of input file format
EXAMPLE
$ chealth upload:booking -f=./bookings.json
or you can also send content by using pipe from standard input stream
$ cat ./bookings.json | chealth upload:booking
also you can get sample input file by using following command
$ chealth upload:booking --sample
Note1: flags:4 should be set for EU DCC requested bookings
Note2: You can export your private key under settings/keys from https://portal.certify.healthSee code: src/commands/upload/bookings.ts
chealth upload:results
Upload Results to Certify.Health
USAGE
$ chealth upload:results
OPTIONS
-c, --configFolder=configFolder Config files folder (Only user if you need portable
configuration file storage)
-d, --dryRun Execute all actions except upload (parse, generate
json, encrypt)
-f, --filePath=filePath File to encrypt
-h, --help Display help
-k, --keyPath=keyPath Path to private key file to encrypt certificates
-l, --locale=en|es|ca|fr|sv Locale of document
-p, --keyPassphrase=keyPassphrase Passphrase for private key
-s, --silent Silent mode, with no information messages
-s, --skipExistingResults Skip existing results
-t, --testType=pcr_test|antigen_test|antibody_test|vaccination Test type
--logFilePath=logFilePath Log file to operation logs
--sample Get sample input file
--schema Get schema of input file format
EXAMPLE
$ chealth upload:results -l=en -t=pct_test -f=result1.csv -k=myprivatekey.asc -p=k12345
$ chealth upload:results -sample -t=pct_testSee code: src/commands/upload/results.ts
chealth utils:compare-results
Compares two CSV files
USAGE
$ chealth utils:compare-results
OPTIONS
-c, --configFolder=configFolder Config files folder (Only user if you need portable configuration file
storage)
-h, --help Display help
-l, --left=left Left CSV
-m, --mode=(left|right|left-right|right-left) Comparison mode
-o, --output=output Output CSV
-r, --right=right Right CSV
-s, --silent Silent mode, with no information messages
--left-delimiter=left-delimiter [default: ,] Left delimiter
--output-delimiter=output-delimiter [default: ,] Output delimiter
--right-delimiter=right-delimiter [default: ,] Right delimiter
--sample Get sample input file
--schema Get schema of input file format
DESCRIPTION
Supported modes: left, right, left-right, right-left
* left: reports lines that only exist in left file
* right: reports lines that only exist in right file
* left-right: reports lines of left file that also exist in right file
* right-left: reports lines of right file that also exist in left fileSee code: src/commands/utils/compare-results.ts
chealth utils:find-unique-results
Filters unique rows by externalId
USAGE
$ chealth utils:find-unique-results
OPTIONS
-c, --configFolder=configFolder Config files folder (Only user if you need portable configuration file storage)
-h, --help Display help
-i, --inputs=inputs CSV to read
-o, --output=output CSV to write
-s, --silent Silent mode, with no information messages
--input-delimiter=input-delimiter [default: ,] Input CSV delimiter
--output-delimiter=output-delimiter [default: ,] Output delimiter
--sample Get sample input file
--schema Get schema of input file formatSee code: src/commands/utils/find-unique-results.ts
chealth utils:process-results
Processes Results
USAGE
$ chealth utils:process-results
OPTIONS
-c, --configFolder=configFolder Config files folder (Only user if you need portable configuration file storage)
-h, --help Display help
-i, --input=input Input CSV
-l, --lab-information=lab-information Lab information
-o, --output=output Output CSV
-s, --silent Silent mode, with no information messages
--file-delimiter=file-delimiter [default: ,] File CSV delimiter
--input-delimiter=input-delimiter [default: ,] Input CSV delimiter
--output-delimiter=output-delimiter [default: ,] Output delimiter
DESCRIPTION
Converts simple result files to full result files ready to uploadSee code: src/commands/utils/process-results.ts
chealth whoami
Get Session Account from Certify.Health API
USAGE
$ chealth whoami
OPTIONS
-c, --configFolder=configFolder Config files folder (Only user if you need portable configuration file storage)
-h, --help Display help
-s, --silent Silent mode, with no information messages
EXAMPLE
$ chealth whoamiSee code: src/commands/whoami.ts
1.7.1
2 years ago
2.0.1
2 years ago
2.0.0
2 years ago
1.5.2
3 years ago
1.5.1
3 years ago
1.5.0
3 years ago
1.3.2
3 years ago
1.3.1
3 years ago
1.3.0
3 years ago
1.2.0
3 years ago
1.1.0
3 years ago
0.1.27
3 years ago
0.1.24
3 years ago
0.1.25
3 years ago
0.1.26
3 years ago
0.1.23
3 years ago
0.1.22
3 years ago
0.1.21
3 years ago
0.1.20
3 years ago
0.1.19
3 years ago
0.1.18
3 years ago
0.1.17
3 years ago
0.1.16
3 years ago
0.1.15
3 years ago
0.1.14
3 years ago
0.1.13
3 years ago
0.1.12
3 years ago
0.1.11
3 years ago
0.1.10
3 years ago
0.1.9
3 years ago
0.1.8
3 years ago
0.1.7
3 years ago
0.1.6
3 years ago
0.1.5
3 years ago
0.1.4
3 years ago
0.1.3
3 years ago
0.1.2
3 years ago
0.1.1
3 years ago
0.1.0
3 years ago
0.0.1
3 years ago