@commercetools-frontend/checkly-cli/README.md

Internal CLI to interact with the Checkly API.

# @commercetools-frontend/checkly-cli

> This is a CLI used internally for Merchant Center applications. We do not provide any guarantees or support for the functionality.

This CLI provides useful commands to interact with the Checkly API.

## Installation

```bash
$ npm install --save @commercetools-frontend/checkly-cli
```

## Usage

> Please make sure you have Node.js v14 or higher installed as this package uses native ES modules.

### Command: `trigger`

This command triggers a CI/CD check in Checkly.

```bash
pnpm checkly-cli trigger \
  --group <number> \
  --token <string>
```

Note that `--group` and `--token` defaults to environment variables with the name `CHECKLY_GROUP` and `CHECKLY_TOKEN`.