# Ably CLI

[![npm version](https://badge.fury.io/js/@ably%2Fcli.svg)](https://badge.fury.io/js/@ably%2Fcli)
[![Node](https://img.shields.io/node/v/%40ably%2Fcli)](https://nodejs.org)
[![License](https://img.shields.io/npm/l/%40ably%2Fcli)](https://github.com/ably/ably-cli/blob/main/LICENSE)

The Ably CLI brings the full power of Ably to your terminal. You can use it to manage your Ably account and its resources, and to explore Ably's APIs and features.

The Ably CLI interacts with:

* The [Control API](https://ably.com/docs/platform/account/control-api) to manage your Ably account and applications.
* [Pub/Sub](https://ably.com/docs/basics) to publish and subscribe to messages in realtime.
* [Chat](https://ably.com/docs/chat) to send messages, display typing indicators and react to what's happening in a chat room.
* [Spaces](https://ably.com/docs/spaces) to enter spaces and register member locations.

## Installation

The Ably CLI is available as an NPM package. Install it using:

```shell
npm install -g @ably/cli
```

## Usage

For a list of all available commands, run:

```shell
ably help
```

Visit [the official Ably documentation](https://ably.com/docs/platform/tools/cli) for CLI login, features, and usage.

## Contributing

Please see [`CONTRIBUTING.md`](CONTRIBUTING.md) for the development workflow, testing requirements, and release process.

For development standards and coding conventions, see [`AGENTS.md`](AGENTS.md).