Overview
For an overview of the Ably CLI, including installation instructions and feature highlights, see the Ably CLI page.
Global options
--json
Output results as compact, single-line NDJSON (Newline Delimited JSON). Each line is a self-contained JSON object, making it suitable for programmatic usage and piping into tools such as jq. Mutually exclusive with --pretty-json.
--pretty-json
Output results in colorized, pretty-printed JSON format for human-readable inspection. Mutually exclusive with --json.
--verbose | -v
Enable verbose logging. Can be combined with --json or --pretty-json.
Commands
The following top-level commands are available in the Ably CLI:
| Command | Description |
|---|---|
ably login | Log in to your Ably account (alias for "ably accounts login") |
ably accounts | Manage Ably accounts and your configured access tokens |
ably apps | Manage Ably apps |
ably auth | Manage authentication, keys and tokens |
ably channels | Interact with Ably Pub/Sub channels |
ably rooms | Interact with Ably Chat rooms |
ably spaces | Interact with Ably Spaces |
ably queues | Manage Ably Queues |
ably integrations | Manage Ably integrations |
ably push | Manage push notifications |
ably logs | Streaming and retrieving logs from Ably |
ably stats | View statistics for your Ably account or apps |
ably config | Manage Ably CLI configuration |
ably bench | Commands for running benchmark tests |
ably connections | Interact with Ably Pub/Sub connections |
ably support | Get support and help from Ably |
ably autocomplete | Display autocomplete installation instructions |
ably env | Show the reference for environment variables supported by the Ably CLI |
ably status | Check the status of the Ably service |
ably version | Display the current version of the Ably CLI |
ably help | Display help for ably |