[DX-329] Implemented reference documentation for ably-cli tool#3307
Open
[DX-329] Implemented reference documentation for ably-cli tool#3307
Conversation
Contributor
sacOO7
commented
Apr 1, 2026
sacOO7
commented
- Fixed https://ably.atlassian.net/browse/DX-329
- Added reference documentation for ably-cli
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
sacOO7
force-pushed
the
feature/ably-cli-reference-documentation
branch
from
66fc5d9 to
fa194d7
Compare
3 tasks
sacOO7
changed the title
…ronment. This gives Node.js 8GB of heap space instead of the default ~4GB, which should handle the additional CLI doc pages comfortably on the xlarge runner.
sacOO7
force-pushed
the
feature/ably-cli-reference-documentation
branch
from
5f06b43 to
ef019c9
Compare
sacOO7
added
review-app
- Added navigation footers to generated CLI command pages
Contributor
Author
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
There was a problem hiding this comment.
Pull request overview
This PR adds a comprehensive Ably CLI command reference under /docs/cli, and exposes it in the Platform navigation, alongside a CI tweak intended to reduce build-time Node memory pressure.
Changes:
- Added MDX reference pages for many
ablycommands and command groups (accounts, apps, auth, channels, logs, push, rooms, spaces, etc.), including examples and global flag references. - Added a new navigation entry to surface the CLI reference in the Platform “API references” section.
- Updated CircleCI build job environment with a higher Node heap limit.
Reviewed changes
Copilot reviewed 167 out of 167 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| src/pages/docs/cli/index.mdx | CLI reference landing page (global flags + command list) |
| src/pages/docs/cli/autocomplete.mdx | Docs for ably autocomplete |
| src/pages/docs/cli/help.mdx | Docs for ably help |
| src/pages/docs/cli/interactive.mdx | Docs for ably interactive |
| src/pages/docs/cli/login.mdx | Docs for ably login |
| src/pages/docs/cli/status.mdx | Docs for ably status |
| src/pages/docs/cli/version.mdx | Docs for ably version |
| src/pages/docs/cli/accounts/index.mdx | ably accounts group index |
| src/pages/docs/cli/accounts/current.mdx | Docs for ably accounts current |
| src/pages/docs/cli/accounts/list.mdx | Docs for ably accounts list |
| src/pages/docs/cli/accounts/login.mdx | Docs for ably accounts login |
| src/pages/docs/cli/accounts/logout.mdx | Docs for ably accounts logout |
| src/pages/docs/cli/accounts/switch.mdx | Docs for ably accounts switch |
| src/pages/docs/cli/apps/index.mdx | ably apps group index |
| src/pages/docs/cli/apps/create.mdx | Docs for ably apps create |
| src/pages/docs/cli/apps/current.mdx | Docs for ably apps current |
| src/pages/docs/cli/apps/delete.mdx | Docs for ably apps delete |
| src/pages/docs/cli/apps/list.mdx | Docs for ably apps list |
| src/pages/docs/cli/apps/switch.mdx | Docs for ably apps switch |
| src/pages/docs/cli/apps/update.mdx | Docs for ably apps update |
| src/pages/docs/cli/apps/rules/index.mdx | ably apps rules group index |
| src/pages/docs/cli/apps/rules/create.mdx | Docs for ably apps rules create |
| src/pages/docs/cli/apps/rules/delete.mdx | Docs for ably apps rules delete |
| src/pages/docs/cli/apps/rules/list.mdx | Docs for ably apps rules list |
| src/pages/docs/cli/apps/rules/update.mdx | Docs for ably apps rules update |
| src/pages/docs/cli/auth/index.mdx | ably auth group index |
| src/pages/docs/cli/auth/issue-ably-token.mdx | Docs for ably auth issue-ably-token |
| src/pages/docs/cli/auth/issue-jwt-token.mdx | Docs for ably auth issue-jwt-token |
| src/pages/docs/cli/auth/revoke-token.mdx | Docs for ably auth revoke-token |
| src/pages/docs/cli/auth/keys/index.mdx | ably auth keys group index |
| src/pages/docs/cli/auth/keys/create.mdx | Docs for ably auth keys create |
| src/pages/docs/cli/auth/keys/current.mdx | Docs for ably auth keys current |
| src/pages/docs/cli/auth/keys/get.mdx | Docs for ably auth keys get |
| src/pages/docs/cli/auth/keys/list.mdx | Docs for ably auth keys list |
| src/pages/docs/cli/auth/keys/revoke.mdx | Docs for ably auth keys revoke |
| src/pages/docs/cli/auth/keys/switch.mdx | Docs for ably auth keys switch |
| src/pages/docs/cli/auth/keys/update.mdx | Docs for ably auth keys update |
| src/pages/docs/cli/bench/index.mdx | ably bench group index |
| src/pages/docs/cli/bench/publisher.mdx | Docs for ably bench publisher |
| src/pages/docs/cli/bench/subscriber.mdx | Docs for ably bench subscriber |
| src/pages/docs/cli/channels/index.mdx | ably channels group index |
| src/pages/docs/cli/channels/append.mdx | Docs for ably channels append |
| src/pages/docs/cli/channels/batch-publish.mdx | Docs for ably channels batch-publish |
| src/pages/docs/cli/channels/delete.mdx | Docs for ably channels delete |
| src/pages/docs/cli/channels/history.mdx | Docs for ably channels history |
| src/pages/docs/cli/channels/inspect.mdx | Docs for ably channels inspect |
| src/pages/docs/cli/channels/list.mdx | Docs for ably channels list |
| src/pages/docs/cli/channels/publish.mdx | Docs for ably channels publish |
| src/pages/docs/cli/channels/subscribe.mdx | Docs for ably channels subscribe |
| src/pages/docs/cli/channels/update.mdx | Docs for ably channels update |
| src/pages/docs/cli/channels/annotations/index.mdx | ably channels annotations group index |
| src/pages/docs/cli/channels/annotations/publish.mdx | Docs for ably channels annotations publish |
| src/pages/docs/cli/channels/annotations/subscribe.mdx | Docs for ably channels annotations subscribe |
| src/pages/docs/cli/channels/annotations/get.mdx | Docs for ably channels annotations get |
| src/pages/docs/cli/channels/annotations/delete.mdx | Docs for ably channels annotations delete |
| src/pages/docs/cli/channels/occupancy/index.mdx | ably channels occupancy group index |
| src/pages/docs/cli/channels/occupancy/get.mdx | Docs for ably channels occupancy get |
| src/pages/docs/cli/channels/occupancy/subscribe.mdx | Docs for ably channels occupancy subscribe |
| src/pages/docs/cli/channels/presence/index.mdx | ably channels presence group index |
| src/pages/docs/cli/channels/presence/enter.mdx | Docs for ably channels presence enter |
| src/pages/docs/cli/channels/presence/get.mdx | Docs for ably channels presence get |
| src/pages/docs/cli/channels/presence/subscribe.mdx | Docs for ably channels presence subscribe |
| src/pages/docs/cli/config/index.mdx | ably config group index |
| src/pages/docs/cli/config/path.mdx | Docs for ably config path |
| src/pages/docs/cli/config/show.mdx | Docs for ably config show |
| src/pages/docs/cli/connections/index.mdx | ably connections group index |
| src/pages/docs/cli/connections/test.mdx | Docs for ably connections test |
| src/pages/docs/cli/integrations/index.mdx | ably integrations group index |
| src/pages/docs/cli/integrations/create.mdx | Docs for ably integrations create |
| src/pages/docs/cli/integrations/delete.mdx | Docs for ably integrations delete |
| src/pages/docs/cli/integrations/get.mdx | Docs for ably integrations get |
| src/pages/docs/cli/integrations/list.mdx | Docs for ably integrations list |
| src/pages/docs/cli/integrations/update.mdx | Docs for ably integrations update |
| src/pages/docs/cli/logs/index.mdx | ably logs group index |
| src/pages/docs/cli/logs/history.mdx | Docs for ably logs history |
| src/pages/docs/cli/logs/subscribe.mdx | Docs for ably logs subscribe |
| src/pages/docs/cli/logs/channel-lifecycle/index.mdx | ably logs channel-lifecycle group index |
| src/pages/docs/cli/logs/channel-lifecycle/subscribe.mdx | Docs for ably logs channel-lifecycle subscribe |
| src/pages/docs/cli/logs/connection-lifecycle/index.mdx | ably logs connection-lifecycle group index |
| src/pages/docs/cli/logs/connection-lifecycle/subscribe.mdx | Docs for ably logs connection-lifecycle subscribe |
| src/pages/docs/cli/logs/connection-lifecycle/history.mdx | Docs for ably logs connection-lifecycle history |
| src/pages/docs/cli/logs/push/index.mdx | ably logs push group index |
| src/pages/docs/cli/logs/push/subscribe.mdx | Docs for ably logs push subscribe |
| src/pages/docs/cli/logs/push/history.mdx | Docs for ably logs push history |
| src/pages/docs/cli/push/index.mdx | ably push group index |
| src/pages/docs/cli/push/publish.mdx | Docs for ably push publish |
| src/pages/docs/cli/push/batch-publish.mdx | Docs for ably push batch-publish |
| src/pages/docs/cli/push/channels/index.mdx | ably push channels group index |
| src/pages/docs/cli/push/channels/list.mdx | Docs for ably push channels list |
| src/pages/docs/cli/push/channels/list-channels.mdx | Docs for ably push channels list-channels |
| src/pages/docs/cli/push/channels/save.mdx | Docs for ably push channels save |
| src/pages/docs/cli/push/channels/remove.mdx | Docs for ably push channels remove |
| src/pages/docs/cli/push/channels/remove-where.mdx | Docs for ably push channels remove-where |
| src/pages/docs/cli/push/config/index.mdx | ably push config group index |
| src/pages/docs/cli/push/config/show.mdx | Docs for ably push config show |
| src/pages/docs/cli/push/config/set-apns.mdx | Docs for ably push config set-apns |
| src/pages/docs/cli/push/config/set-fcm.mdx | Docs for ably push config set-fcm |
| src/pages/docs/cli/push/config/clear-apns.mdx | Docs for ably push config clear-apns |
| src/pages/docs/cli/push/config/clear-fcm.mdx | Docs for ably push config clear-fcm |
| src/pages/docs/cli/push/devices/index.mdx | ably push devices group index |
| src/pages/docs/cli/push/devices/list.mdx | Docs for ably push devices list |
| src/pages/docs/cli/push/devices/get.mdx | Docs for ably push devices get |
| src/pages/docs/cli/push/devices/save.mdx | Docs for ably push devices save |
| src/pages/docs/cli/push/devices/remove.mdx | Docs for ably push devices remove |
| src/pages/docs/cli/push/devices/remove-where.mdx | Docs for ably push devices remove-where |
| src/pages/docs/cli/queues/index.mdx | ably queues group index |
| src/pages/docs/cli/queues/create.mdx | Docs for ably queues create |
| src/pages/docs/cli/queues/delete.mdx | Docs for ably queues delete |
| src/pages/docs/cli/queues/list.mdx | Docs for ably queues list |
| src/pages/docs/cli/rooms/index.mdx | ably rooms group index |
| src/pages/docs/cli/rooms/list.mdx | Docs for ably rooms list |
| src/pages/docs/cli/rooms/messages/index.mdx | ably rooms messages group index |
| src/pages/docs/cli/rooms/messages/send.mdx | Docs for ably rooms messages send |
| src/pages/docs/cli/rooms/messages/subscribe.mdx | Docs for ably rooms messages subscribe |
| src/pages/docs/cli/rooms/messages/history.mdx | Docs for ably rooms messages history |
| src/pages/docs/cli/rooms/messages/update.mdx | Docs for ably rooms messages update |
| src/pages/docs/cli/rooms/messages/delete.mdx | Docs for ably rooms messages delete |
| src/pages/docs/cli/rooms/messages/reactions/index.mdx | ably rooms messages reactions group index |
| src/pages/docs/cli/rooms/messages/reactions/send.mdx | Docs for ably rooms messages reactions send |
| src/pages/docs/cli/rooms/messages/reactions/subscribe.mdx | Docs for ably rooms messages reactions subscribe |
| src/pages/docs/cli/rooms/messages/reactions/remove.mdx | Docs for ably rooms messages reactions remove |
| src/pages/docs/cli/rooms/occupancy/index.mdx | ably rooms occupancy group index |
| src/pages/docs/cli/rooms/occupancy/get.mdx | Docs for ably rooms occupancy get |
| src/pages/docs/cli/rooms/occupancy/subscribe.mdx | Docs for ably rooms occupancy subscribe |
| src/pages/docs/cli/rooms/presence/index.mdx | ably rooms presence group index |
| src/pages/docs/cli/rooms/presence/enter.mdx | Docs for ably rooms presence enter |
| src/pages/docs/cli/rooms/presence/get.mdx | Docs for ably rooms presence get |
| src/pages/docs/cli/rooms/presence/subscribe.mdx | Docs for ably rooms presence subscribe |
| src/pages/docs/cli/rooms/reactions/index.mdx | ably rooms reactions group index |
| src/pages/docs/cli/rooms/reactions/send.mdx | Docs for ably rooms reactions send |
| src/pages/docs/cli/rooms/reactions/subscribe.mdx | Docs for ably rooms reactions subscribe |
| src/pages/docs/cli/rooms/typing/index.mdx | ably rooms typing group index |
| src/pages/docs/cli/rooms/typing/keystroke.mdx | Docs for ably rooms typing keystroke |
| src/pages/docs/cli/rooms/typing/subscribe.mdx | Docs for ably rooms typing subscribe |
| src/pages/docs/cli/spaces/index.mdx | ably spaces group index |
| src/pages/docs/cli/spaces/create.mdx | Docs for ably spaces create |
| src/pages/docs/cli/spaces/get.mdx | Docs for ably spaces get |
| src/pages/docs/cli/spaces/list.mdx | Docs for ably spaces list |
| src/pages/docs/cli/spaces/subscribe.mdx | Docs for ably spaces subscribe |
| src/pages/docs/cli/spaces/cursors/index.mdx | ably spaces cursors group index |
| src/pages/docs/cli/spaces/cursors/get.mdx | Docs for ably spaces cursors get |
| src/pages/docs/cli/spaces/cursors/set.mdx | Docs for ably spaces cursors set |
| src/pages/docs/cli/spaces/cursors/subscribe.mdx | Docs for ably spaces cursors subscribe |
| src/pages/docs/cli/spaces/locations/index.mdx | ably spaces locations group index |
| src/pages/docs/cli/spaces/locations/get.mdx | Docs for ably spaces locations get |
| src/pages/docs/cli/spaces/locations/set.mdx | Docs for ably spaces locations set |
| src/pages/docs/cli/spaces/locations/subscribe.mdx | Docs for ably spaces locations subscribe |
| src/pages/docs/cli/spaces/locks/index.mdx | ably spaces locks group index |
| src/pages/docs/cli/spaces/locks/acquire.mdx | Docs for ably spaces locks acquire |
| src/pages/docs/cli/spaces/locks/get.mdx | Docs for ably spaces locks get |
| src/pages/docs/cli/spaces/locks/subscribe.mdx | Docs for ably spaces locks subscribe |
| src/pages/docs/cli/spaces/members/index.mdx | ably spaces members group index |
| src/pages/docs/cli/spaces/members/enter.mdx | Docs for ably spaces members enter |
| src/pages/docs/cli/spaces/members/get.mdx | Docs for ably spaces members get |
| src/pages/docs/cli/spaces/members/subscribe.mdx | Docs for ably spaces members subscribe |
| src/pages/docs/cli/spaces/occupancy/index.mdx | ably spaces occupancy group index |
| src/pages/docs/cli/spaces/occupancy/get.mdx | Docs for ably spaces occupancy get |
| src/pages/docs/cli/spaces/occupancy/subscribe.mdx | Docs for ably spaces occupancy subscribe |
| src/pages/docs/cli/stats/index.mdx | ably stats group index |
| src/pages/docs/cli/stats/account.mdx | Docs for ably stats account |
| src/pages/docs/cli/stats/app.mdx | Docs for ably stats app |
| src/pages/docs/cli/support/index.mdx | ably support group index |
| src/pages/docs/cli/support/ask.mdx | Docs for ably support ask |
| src/pages/docs/cli/support/contact.mdx | Docs for ably support contact |
| src/data/nav/platform.ts | Adds nav link to the CLI reference page |
| .circleci/config.yml | Increases Node heap limit for the build job |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+29
to
+49
| | Command | Description | | ||
| | ------- | ----------- | | ||
| | [`ably accounts`](/docs/cli/accounts) | Manage Ably accounts and your configured access tokens | | ||
| | [`ably apps`](/docs/cli/apps) | Manage Ably apps | | ||
| | [`ably autocomplete`](/docs/cli/autocomplete) | Display autocomplete installation instructions | | ||
| | [`ably auth`](/docs/cli/auth) | Manage authentication, keys and tokens | | ||
| | [`ably bench`](/docs/cli/bench) | Commands for running benchmark tests | | ||
| | [`ably channels`](/docs/cli/channels) | Interact with Ably Pub/Sub channels | | ||
| | [`ably config`](/docs/cli/config) | Manage Ably CLI configuration | | ||
| | [`ably connections`](/docs/cli/connections) | Interact with Ably Pub/Sub connections | | ||
| | [`ably help`](/docs/cli/help) | Display help for ably | | ||
| | [`ably integrations`](/docs/cli/integrations) | Manage Ably integrations | | ||
| | [`ably login`](/docs/cli/login) | Log in to your Ably account (alias for "ably accounts login") | | ||
| | [`ably logs`](/docs/cli/logs) | Streaming and retrieving logs from Ably | | ||
| | [`ably push`](/docs/cli/push) | Manage push notifications | | ||
| | [`ably queues`](/docs/cli/queues) | Manage Ably Queues | | ||
| | [`ably rooms`](/docs/cli/rooms) | Interact with Ably Chat rooms | | ||
| | [`ably spaces`](/docs/cli/spaces) | Interact with Ably Spaces | | ||
| | [`ably stats`](/docs/cli/stats) | View statistics for your Ably account or apps | | ||
| | [`ably status`](/docs/cli/status) | Check the status of the Ably service | | ||
| | [`ably support`](/docs/cli/support) | Get support and help from Ably | |
There was a problem hiding this comment.
The commands table omits pages that are part of this reference set (e.g., ably interactive and ably version). As-is, those docs are orphaned/unreachable from the CLI reference landing page; please add them to this table (or otherwise link to them).
Comment on lines
+23
to
+29
| ## Flags | ||
|
|
||
| You can optionally pass the following flags to the `ably spaces occupancy get` command: | ||
|
|
||
| ## Global flags | ||
|
|
||
| The following [global flags](/docs/cli#global-flags) are also available: |
There was a problem hiding this comment.
This page has a ## Flags section that claims there are optional flags, but no command-specific flags are actually documented. This reads like an incomplete section; either document the flags or replace this with a statement like “This command has no command-specific flags” (or remove the section entirely).
Comment on lines
+12
to
+14
|
|
||
| Use the `ably logs channel-lifecycle subscribe` command to stream logs from the [meta]channel.lifecycle meta channel. | ||
|
|
There was a problem hiding this comment.
The meta channel name is written as plain text [meta]channel.lifecycle, which is easy to misread and doesn’t stand out as a literal channel identifier. Consider formatting it as inline code (e.g., [meta]channel.lifecycle) for clarity/consistency with other literal values.
…e and interactive mode
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.