CovidCertificate-Api-Cli

KO | EN

gitlite — search

#hacktoberfest #react #ai #typescript #golang #go #machine-learning #linux #docker #java #awesome-list #ios #mcp #open-source

CovidCertificate-Api-Cli

(★ 10)

No description available.

CovidCertificate-Api-Cli 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# This project is retired
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.

# CLI to use the Swiss Covid Certificate API

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
[![Version](https://img.shields.io/npm/v/swiss-admin-covid-certificate-api-cli.svg)](https://npmjs.org/package/swiss-admin-covid-certificate-api-cli)
[![Downloads/week](https://img.shields.io/npm/dw/swiss-admin-covid-certificate-api-cli.svg)](https://npmjs.org/package/swiss-admin-covid-certificate-api-cli)
[![License](https://img.shields.io/npm/l/swiss-admin-covid-certificate-api-cli.svg)](https://github.com/admin-ch/CovidCertificate-Api-Cli/blob/master/package.json)

* [CLI to use the Swiss Covid Certificate API](#cli-to-use-the-swiss-covid-certificate-api)
* [About](#about)
* [Usage](#usage)
* [Commands](#commands)

# About
`cc-cli` interacts with the [Swiss Covid Certificate API](https://github.com/admin-ch/CovidCertificate-Apidoc#readme).
It was created for testing and demo purposes only.

## OpenAPI Model Generation
The model where created from the [API specification](https://github.com/admin-ch/CovidCertificate-Apidoc/blob/main/api-doc.json) using [openapi-typescript-codegen](https://www.npmjs.com/package/openapi-typescript-codegen).

They can be regenerated with `npm run generate-api`. The implementation is in [generate-api.js](generate-api.js) and the API Spec located at [api-doc.json](api-doc.json).

## Debugging
cc-cli uses [`debug`](https://www.npmjs.com/package/debug).

Enable API interaction tracing with `DEBUG=cc-cli:api` or use the `--debug` flag.

# Usage

```sh-session
$ 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
...
```

# Commands

* [`cc-cli create-recovery`](#cc-cli-create-recovery)
* [`cc-cli create-test`](#cc-cli-create-test)
* [`cc-cli create-vaccination`](#cc-cli-create-vaccination)
* [`cc-cli help [COMMAND]`](#cc-cli-help-command)
* [`cc-cli pm-update FILE`](#cc-cli-pm-update-file)
* [`cc-cli sign FILE`](#cc-cli-sign-file)

## `cc-cli create-recovery`

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](https://github.com/admin-ch/CovidCertificate-Api-Cli/blob/v1.4.1/src/commands/create-recovery.ts)_

## `cc-cli create-test`

create a test certificate

```
USAGE
  $ cc-cli create-test