@controlplane/cli/README.md

Control Plane Corporation CLI

<p align="center">
  <a href="https://controlplane.com/"><img src="https://controlplane.com/icons/logo.svg" height="140"></a>
</p>

## Description

The Control Plane CLI is used to perform actions against the Control Plane API. <a href="https://docs.controlplane.com/reference/cli" target="_blank">Visit our documentation</a> for more information on how to use the Control Plane CLI.

## Installation

Globally install the Control Plane CLI using npm

```bash
npm i -g @controlplane/cli
```

## Autocompletions

After installing, activate autocompletions

```bash
cpln misc install-completion
```

## Debug

If something went wrong, add the following options to your cpln command

### Enable verbose output to stderr

```bash
--verbose, -v
```

### Show all HTTP communications

```bash
--debug, -d
```

## Release Notes

See <a href="https://docs.controlplane.com/release-notes" target="_blank">documentation</a> for release notes.