This repository is no longer maintained. This is because our API is still testable using curl and postman. And furthermore the effort to perform the necessary updates and to test them exceeds the benefit.
cc-cli interacts with the Swiss Covid Certificate API.
It was created for testing and demo purposes only.
The model where created from the API specification using openapi-typescript-codegen.
They can be regenerated with npm run generate-api. The implementation is in generate-api.js and the API Spec located at api-doc.json.
cc-cli uses debug.
Enable API interaction tracing with DEBUG=cc-cli:api or use the --debug flag.
$ npm install -g swiss-admin-covid-certificate-api-cli
$ cc-cli COMMAND
running command...
$ cc-cli (-v|--version|version)
swiss-admin-covid-certificate-api-cli/1.4.1 darwin-x64 node-v14.17.0
$ cc-cli --help [COMMAND]
USAGE
$ cc-cli COMMAND
...cc-cli create-recoverycc-cli create-testcc-cli create-vaccinationcc-cli help [COMMAND]cc-cli pm-update FILEcc-cli sign FILE
create a recovery certificate
USAGE
$ cc-cli create-recovery
OPTIONS
-d, --debug enable debug output.
--baseUrl=https://ws.covidcertificate-a.bag.admin.ch/ (required) the url of the REST API
--certificateFile=~/a0000-cc-cli-TEST.cer (required) path to PEM encoded certificate
--countryOfTest=CH (required) the country in which the covid certificate owner has
been tested. Format: string (2 chars according to ISO 3166
Country Codes).
--dateOfBirth=1964-03-14 (required) birthdate of the covid certificate owner. Format:
ISO 8601 date without time.
--dateOfFirstPositiveTestResult=2020-01-01 (required) date when the sample for the test was collected.
Format: ISO 8601 date without time.
--familyName=Rochat (required) family name of the covid certificate owner
--givenName=Céline (required) given name of the covid certificate owner
--keyFile=~/a0000-cc-cli-TEST.encrypted.key (required) path to PEM encoded private key
--keyPassphrase=abcdefghijklmnopqrstuvwxyz passphrase to decrypt the private key
--language=fr [default: de] Accepted languages are: de, it, fr, rm
--local adds additional headers required to mock the WSG
--otp=a.b.c (required) the otp secret
--outDir=out (required) [default:
/var/folders/hv/73dvbzz14ms96bgl5xlyxgww0000gn/T] output
directory
EXAMPLE
export CC_CLI_OTP="a.b.c"
export CC_CLI_KEY_PASSPHRASE="secret"
export CC_CLI_BASE_URL="https://ws.covidcertificate-a.bag.admin.ch/"
export CC_CLI_CERTIFICATE_FILE="ZH-spital-A-t.bit.admin.ch.cer"
export CC_CLI_KEY_FILE="ZH-spital-A-t.bit.admin.ch.encrypted.key"
export CC_CLI_OUT_DIR="out"
cc-cli create-recovery \
--language="it" \
--familyName="Rossi" \
--givenName="Giulia" \
--dateOfBirth="1964-03-14" \
--dateOfFirstPositiveTestResult="2020-01-01" \
--countryOfTest="CH"
See code: src/commands/create-recovery.ts
create a test certificate
USAGE
$ cc-cli create-test
OPTIONS
-d, --debug enable debug output.
--baseUrl=https://ws.covidcertificate-a.bag.admin.ch/ (required) the url of the REST API
--certificateFile=~/a0000-cc-cli-TEST.cer (required) path to PEM encoded certificate
--dateOfBirth=1964-03-14 (required) birthdate of the covid certificate owner. Format:
ISO 8601 date without time.
--familyName=Rochat (required) family name of the covid certificate owner
--givenName=Céline (required) given name of the covid certificate owner
--keyFile=~/a0000-cc-cli-TEST.encrypted.key (required) path to PEM encoded private key
--keyPassphrase=abcdefghijklmnopqrstuvwxyz passphrase to decrypt the private key
--language=fr [default: de] Accepted languages are: de, it, fr, rm
--local adds additional headers required to mock the WSG
--manufacturerCode=1304 test manufacturer code. This should only be sent when it is not
a PCR test
--memberStateOfTest=CH (required) the country in which the covid certificate owner has
been tested. Format: string (2 chars according to ISO 3166
Country Codes).
--otp=a.b.c (required) the otp secret
--outDir=out (required) [default:
/var/folders/hv/73dvbzz14ms96bgl5xlyxgww0000gn/T] output
directory
--sampleDateTime=2021-05-22T11:12:85Z (required) date and time of the test sample collection. Format:
ISO 8601 date incl. time.
--testingCentreOrFacility=Walk-in-Lyss AG (required) name of centre or facility.
--typeCode=LP217198-3 type of test. This field is only mandatory when it is a PCR
test.
EXAMPLE
export CC_CLI_OTP="a.b.c"
export CC_CLI_KEY_PASSPHRASE="secret"
export CC_CLI_BASE_URL="https://ws.covidcertificate-a.bag.admin.ch/"
export CC_CLI_CERTIFICATE_FILE="ZH-spital-A-t.bit.admin.ch.cer"
export CC_CLI_KEY_FILE="ZH-spital-A-t.bit.admin.ch.encrypted.key"
export CC_CLI_OUT_DIR="out"
cc-cli create-test \
--language="de" \
--familyName="Rochat" \
--givenName="Céline" \
--dateOfBirth="1964-03-14" \
--typeCode="LP6464-4" \
--sampleDateTime="2020-01-01T17:29:41.063Z" \
--testingCentreOrFacility="Walk-in-Lyss AG" \
--memberStateOfTest="CH"
See code: src/commands/create-test.ts
create a vaccination certificate
USAGE
$ cc-cli create-vaccination
OPTIONS
-d, --debug enable debug output.
--baseUrl=https://ws.covidcertificate-a.bag.admin.ch/ (required) the url of the REST API
--certificateFile=~/a0000-cc-cli-TEST.cer (required) path to PEM encoded certificate
--countryOfVaccination=CH (required) the country in which the covid certificate owner has
been vaccinated. Format: string (2 chars according to ISO 3166
Country Codes).
--dateOfBirth=1964-03-14 (required) birthdate of the covid certificate owner. Format:
ISO 8601 date without time.
--familyName=Rochat (required) family name of the covid certificate owner
--givenName=Céline (required) given name of the covid certificate owner
--keyFile=~/a0000-cc-cli-TEST.encrypted.key (required) path to PEM encoded private key
--keyPassphrase=abcdefghijklmnopqrstuvwxyz passphrase to decrypt the private key
--language=fr [default: de] Accepted languages are: de, it, fr, rm
--local adds additional headers required to mock the WSG
--medicinalProductCode=EU/1/20/1507 (required) name of the medicinal product as registered in the
country.
--numberOfDoses=2 (required) number in a series of doses
--otp=a.b.c (required) the otp secret
--outDir=out (required) [default:
/var/folders/hv/73dvbzz14ms96bgl5xlyxgww0000gn/T] output
directory
--totalNumberOfDoses=2 (required) number in a series of doses
--vaccinationDate=2020-01-01 (required) date of vaccination. Format: ISO 8601 date without
time. Range: can be between 1900-01-01 and 2099-12-31
EXAMPLE
export CC_CLI_OTP="a.b.c"
export CC_CLI_KEY_PASSPHRASE="secret"
export CC_CLI_BASE_URL="https://ws.covidcertificate-a.bag.admin.ch/"
export CC_CLI_CERTIFICATE_FILE="ZH-spital-A-t.bit.admin.ch.cer"
export CC_CLI_KEY_FILE="ZH-spital-A-t.bit.admin.ch.encrypted.key"
export CC_CLI_OUT_DIR="out"
cc-cli create-vaccination \
--language="fr" \
--familyName="Céline" \
--givenName="Rochat" \
--dateOfBirth="1964-03-14" \
--medicinalProductCode="EU/1/20/1507" \
--numberOfDoses="2" \
--totalNumberOfDoses="2" \
--vaccinationDate="2020-01-01" \
--countryOfVaccination="CH"
See code: src/commands/create-vaccination.ts
display help for cc-cli
USAGE
$ cc-cli help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
See code: @oclif/plugin-help
updates otp values and signatures in a Postman collection
USAGE
$ cc-cli pm-update FILE
ARGUMENTS
FILE path to Postman collection
OPTIONS
-h, --help show CLI help
--keyFile=~/a0000-cc-cli-TEST.encrypted.key (required) path to PEM encoded private key
--keyPassphrase=abcdefghijklmnopqrstuvwxyz passphrase to decrypt the private key
--otp=a.b.c (required) the otp secret
See code: src/commands/pm-update.ts
reads a utf8 encoded text file, signs the text and writes the base64 encoded signature to stdout
USAGE
$ cc-cli sign FILE
ARGUMENTS
FILE input file, should be JSON
OPTIONS
-h, --help show CLI help
--keyFile=~/a0000-cc-cli-TEST.encrypted.key (required) path to PEM encoded private key
--keyPassphrase=abcdefghijklmnopqrstuvwxyz passphrase to decrypt the private key
See code: src/commands/sign.ts