Ably CLI

CLI discovered

Details

Command: ably
Docs: https://ably.com/docs/platform/tools/cli

Authentication

Ably CLI OAuth login oauth2 discovered $ ably login

Acquired by the CLI — running ably login opens the auth flow and stores the credential.

Ably access token bearer discovered Get token ↗

env ABLY_ACCESS_TOKEN

Create an access token from the Access tokens page in the Ably dashboard: click Create new token, choose the account, expiry, and capabilities, then copy the token immediately because the full value is only shown once. This token authenticates the Control API and can also be used by the Ably CLI.

Ably API key api_key discovered Get key ↗

env ABLY_API_KEY

Create an API key in the Ably dashboard under API Keys: click Create a new API key, name it, choose capabilities, optionally enable token revocation, and save it. Keep the full key string (appId.keyId:keySecret) secret; it is used directly for trusted-server basic auth and to sign or mint client tokens/JWTs.

Ably client JWT jwt discovered

env ABLY_TOKEN

Have your trusted server create and sign a JWT using your Ably API key secret as described in JWT authentication. The JWT must include Ably claims such as x-ably-capability, iat, and exp; clients typically obtain it from your own authUrl or authCallback endpoint rather than from Ably directly.