From 231633bcfdc62ca7bb4443dd38420c0048e8ff43 Mon Sep 17 00:00:00 2001 From: sacOO7 Date: Wed, 1 Apr 2026 17:22:56 +0530 Subject: [PATCH 1/9] Implemented reference documentation for ably-cli tool --- src/pages/docs/cli/accounts/current.mdx | 41 ++++++ src/pages/docs/cli/accounts/index.mdx | 17 +++ src/pages/docs/cli/accounts/list.mdx | 41 ++++++ src/pages/docs/cli/accounts/login.mdx | 67 +++++++++ src/pages/docs/cli/accounts/logout.mdx | 63 +++++++++ src/pages/docs/cli/accounts/switch.mdx | 47 +++++++ src/pages/docs/cli/apps/create.mdx | 51 +++++++ src/pages/docs/cli/apps/current.mdx | 39 ++++++ src/pages/docs/cli/apps/delete.mdx | 71 ++++++++++ src/pages/docs/cli/apps/index.mdx | 28 ++++ src/pages/docs/cli/apps/list.mdx | 47 +++++++ src/pages/docs/cli/apps/rules/create.mdx | 107 +++++++++++++++ src/pages/docs/cli/apps/rules/delete.mdx | 59 ++++++++ src/pages/docs/cli/apps/rules/index.mdx | 16 +++ src/pages/docs/cli/apps/rules/list.mdx | 51 +++++++ src/pages/docs/cli/apps/rules/update.mdx | 115 ++++++++++++++++ src/pages/docs/cli/apps/switch.mdx | 47 +++++++ src/pages/docs/cli/apps/update.mdx | 59 ++++++++ src/pages/docs/cli/auth/index.mdx | 28 ++++ src/pages/docs/cli/auth/issue-ably-token.mdx | 89 ++++++++++++ src/pages/docs/cli/auth/issue-jwt-token.mdx | 73 ++++++++++ src/pages/docs/cli/auth/keys/create.mdx | 57 ++++++++ src/pages/docs/cli/auth/keys/current.mdx | 49 +++++++ src/pages/docs/cli/auth/keys/get.mdx | 57 ++++++++ src/pages/docs/cli/auth/keys/index.mdx | 19 +++ src/pages/docs/cli/auth/keys/list.mdx | 53 ++++++++ src/pages/docs/cli/auth/keys/revoke.mdx | 61 +++++++++ src/pages/docs/cli/auth/keys/switch.mdx | 55 ++++++++ src/pages/docs/cli/auth/keys/update.mdx | 65 +++++++++ src/pages/docs/cli/auth/revoke-token.mdx | 61 +++++++++ src/pages/docs/cli/bench/index.mdx | 14 ++ src/pages/docs/cli/bench/publisher.mdx | 83 ++++++++++++ src/pages/docs/cli/bench/subscriber.mdx | 51 +++++++ .../docs/cli/channels/annotations/delete.mdx | 67 +++++++++ .../docs/cli/channels/annotations/get.mdx | 59 ++++++++ .../docs/cli/channels/annotations/index.mdx | 16 +++ .../docs/cli/channels/annotations/publish.mdx | 87 ++++++++++++ .../cli/channels/annotations/subscribe.mdx | 75 +++++++++++ src/pages/docs/cli/channels/append.mdx | 83 ++++++++++++ src/pages/docs/cli/channels/batch-publish.mdx | 79 +++++++++++ src/pages/docs/cli/channels/delete.mdx | 63 +++++++++ src/pages/docs/cli/channels/history.mdx | 87 ++++++++++++ src/pages/docs/cli/channels/index.mdx | 53 ++++++++ src/pages/docs/cli/channels/inspect.mdx | 47 +++++++ src/pages/docs/cli/channels/list.mdx | 59 ++++++++ src/pages/docs/cli/channels/occupancy/get.mdx | 51 +++++++ .../docs/cli/channels/occupancy/index.mdx | 14 ++ .../docs/cli/channels/occupancy/subscribe.mdx | 59 ++++++++ .../docs/cli/channels/presence/enter.mdx | 79 +++++++++++ src/pages/docs/cli/channels/presence/get.mdx | 55 ++++++++ .../docs/cli/channels/presence/index.mdx | 15 +++ .../docs/cli/channels/presence/subscribe.mdx | 59 ++++++++ src/pages/docs/cli/channels/publish.mdx | 103 ++++++++++++++ src/pages/docs/cli/channels/subscribe.mdx | 99 ++++++++++++++ src/pages/docs/cli/channels/update.mdx | 75 +++++++++++ src/pages/docs/cli/config/index.mdx | 14 ++ src/pages/docs/cli/config/path.mdx | 31 +++++ src/pages/docs/cli/config/show.mdx | 39 ++++++ src/pages/docs/cli/connections/index.mdx | 13 ++ src/pages/docs/cli/connections/test.mdx | 59 ++++++++ src/pages/docs/cli/help.mdx | 49 +++++++ src/pages/docs/cli/index.mdx | 90 +++++++++++++ src/pages/docs/cli/integrations/create.mdx | 79 +++++++++++ src/pages/docs/cli/integrations/delete.mdx | 59 ++++++++ src/pages/docs/cli/integrations/get.mdx | 55 ++++++++ src/pages/docs/cli/integrations/index.mdx | 17 +++ src/pages/docs/cli/integrations/list.mdx | 51 +++++++ src/pages/docs/cli/integrations/update.mdx | 87 ++++++++++++ src/pages/docs/cli/interactive.mdx | 35 +++++ src/pages/docs/cli/login.mdx | 65 +++++++++ .../docs/cli/logs/channel-lifecycle/index.mdx | 13 ++ .../cli/logs/channel-lifecycle/subscribe.mdx | 55 ++++++++ .../cli/logs/connection-lifecycle/history.mdx | 59 ++++++++ .../cli/logs/connection-lifecycle/index.mdx | 14 ++ .../logs/connection-lifecycle/subscribe.mdx | 55 ++++++++ src/pages/docs/cli/logs/history.mdx | 67 +++++++++ src/pages/docs/cli/logs/index.mdx | 37 +++++ src/pages/docs/cli/logs/push/history.mdx | 59 ++++++++ src/pages/docs/cli/logs/push/index.mdx | 14 ++ src/pages/docs/cli/logs/push/subscribe.mdx | 55 ++++++++ src/pages/docs/cli/logs/subscribe.mdx | 67 +++++++++ src/pages/docs/cli/push/batch-publish.mdx | 63 +++++++++ src/pages/docs/cli/push/channels/index.mdx | 17 +++ .../docs/cli/push/channels/list-channels.mdx | 39 ++++++ src/pages/docs/cli/push/channels/list.mdx | 59 ++++++++ .../docs/cli/push/channels/remove-where.mdx | 59 ++++++++ src/pages/docs/cli/push/channels/remove.mdx | 59 ++++++++ src/pages/docs/cli/push/channels/save.mdx | 55 ++++++++ src/pages/docs/cli/push/config/clear-apns.mdx | 51 +++++++ src/pages/docs/cli/push/config/clear-fcm.mdx | 51 +++++++ src/pages/docs/cli/push/config/index.mdx | 17 +++ src/pages/docs/cli/push/config/set-apns.mdx | 75 +++++++++++ src/pages/docs/cli/push/config/set-fcm.mdx | 43 ++++++ src/pages/docs/cli/push/config/show.mdx | 47 +++++++ src/pages/docs/cli/push/devices/get.mdx | 39 ++++++ src/pages/docs/cli/push/devices/index.mdx | 17 +++ src/pages/docs/cli/push/devices/list.mdx | 59 ++++++++ .../docs/cli/push/devices/remove-where.mdx | 55 ++++++++ src/pages/docs/cli/push/devices/remove.mdx | 55 ++++++++ src/pages/docs/cli/push/devices/save.mdx | 95 +++++++++++++ src/pages/docs/cli/push/index.mdx | 47 +++++++ src/pages/docs/cli/push/publish.mdx | 127 ++++++++++++++++++ src/pages/docs/cli/queues/create.mdx | 71 ++++++++++ src/pages/docs/cli/queues/delete.mdx | 59 ++++++++ src/pages/docs/cli/queues/index.mdx | 15 +++ src/pages/docs/cli/queues/list.mdx | 51 +++++++ src/pages/docs/cli/rooms/index.mdx | 66 +++++++++ src/pages/docs/cli/rooms/list.mdx | 51 +++++++ src/pages/docs/cli/rooms/messages/delete.mdx | 63 +++++++++ src/pages/docs/cli/rooms/messages/history.mdx | 87 ++++++++++++ src/pages/docs/cli/rooms/messages/index.mdx | 17 +++ .../cli/rooms/messages/reactions/index.mdx | 15 +++ .../cli/rooms/messages/reactions/remove.mdx | 67 +++++++++ .../cli/rooms/messages/reactions/send.mdx | 79 +++++++++++ .../rooms/messages/reactions/subscribe.mdx | 63 +++++++++ src/pages/docs/cli/rooms/messages/send.mdx | 83 ++++++++++++ .../docs/cli/rooms/messages/subscribe.mdx | 75 +++++++++++ src/pages/docs/cli/rooms/messages/update.mdx | 83 ++++++++++++ src/pages/docs/cli/rooms/occupancy/get.mdx | 51 +++++++ src/pages/docs/cli/rooms/occupancy/index.mdx | 14 ++ .../docs/cli/rooms/occupancy/subscribe.mdx | 59 ++++++++ src/pages/docs/cli/rooms/presence/enter.mdx | 79 +++++++++++ src/pages/docs/cli/rooms/presence/get.mdx | 55 ++++++++ src/pages/docs/cli/rooms/presence/index.mdx | 15 +++ .../docs/cli/rooms/presence/subscribe.mdx | 59 ++++++++ src/pages/docs/cli/rooms/reactions/index.mdx | 14 ++ src/pages/docs/cli/rooms/reactions/send.mdx | 63 +++++++++ .../docs/cli/rooms/reactions/subscribe.mdx | 59 ++++++++ src/pages/docs/cli/rooms/typing/index.mdx | 14 ++ src/pages/docs/cli/rooms/typing/keystroke.mdx | 63 +++++++++ src/pages/docs/cli/rooms/typing/subscribe.mdx | 59 ++++++++ src/pages/docs/cli/spaces/create.mdx | 55 ++++++++ src/pages/docs/cli/spaces/cursors/get.mdx | 51 +++++++ src/pages/docs/cli/spaces/cursors/index.mdx | 15 +++ src/pages/docs/cli/spaces/cursors/set.mdx | 83 ++++++++++++ .../docs/cli/spaces/cursors/subscribe.mdx | 59 ++++++++ src/pages/docs/cli/spaces/get.mdx | 51 +++++++ src/pages/docs/cli/spaces/index.mdx | 60 +++++++++ src/pages/docs/cli/spaces/list.mdx | 59 ++++++++ src/pages/docs/cli/spaces/locations/get.mdx | 51 +++++++ src/pages/docs/cli/spaces/locations/index.mdx | 15 +++ src/pages/docs/cli/spaces/locations/set.mdx | 63 +++++++++ .../docs/cli/spaces/locations/subscribe.mdx | 59 ++++++++ src/pages/docs/cli/spaces/locks/acquire.mdx | 75 +++++++++++ src/pages/docs/cli/spaces/locks/get.mdx | 55 ++++++++ src/pages/docs/cli/spaces/locks/index.mdx | 15 +++ src/pages/docs/cli/spaces/locks/subscribe.mdx | 59 ++++++++ src/pages/docs/cli/spaces/members/enter.mdx | 71 ++++++++++ src/pages/docs/cli/spaces/members/get.mdx | 51 +++++++ src/pages/docs/cli/spaces/members/index.mdx | 15 +++ .../docs/cli/spaces/members/subscribe.mdx | 59 ++++++++ src/pages/docs/cli/spaces/occupancy/get.mdx | 51 +++++++ src/pages/docs/cli/spaces/occupancy/index.mdx | 14 ++ .../docs/cli/spaces/occupancy/subscribe.mdx | 59 ++++++++ src/pages/docs/cli/spaces/subscribe.mdx | 59 ++++++++ src/pages/docs/cli/stats/account.mdx | 95 +++++++++++++ src/pages/docs/cli/stats/app.mdx | 95 +++++++++++++ src/pages/docs/cli/stats/index.mdx | 14 ++ src/pages/docs/cli/status.mdx | 47 +++++++ src/pages/docs/cli/support/ask.mdx | 63 +++++++++ src/pages/docs/cli/support/contact.mdx | 23 ++++ src/pages/docs/cli/support/index.mdx | 14 ++ src/pages/docs/cli/version.mdx | 31 +++++ 163 files changed, 8667 insertions(+) create mode 100644 src/pages/docs/cli/accounts/current.mdx create mode 100644 src/pages/docs/cli/accounts/index.mdx create mode 100644 src/pages/docs/cli/accounts/list.mdx create mode 100644 src/pages/docs/cli/accounts/login.mdx create mode 100644 src/pages/docs/cli/accounts/logout.mdx create mode 100644 src/pages/docs/cli/accounts/switch.mdx create mode 100644 src/pages/docs/cli/apps/create.mdx create mode 100644 src/pages/docs/cli/apps/current.mdx create mode 100644 src/pages/docs/cli/apps/delete.mdx create mode 100644 src/pages/docs/cli/apps/index.mdx create mode 100644 src/pages/docs/cli/apps/list.mdx create mode 100644 src/pages/docs/cli/apps/rules/create.mdx create mode 100644 src/pages/docs/cli/apps/rules/delete.mdx create mode 100644 src/pages/docs/cli/apps/rules/index.mdx create mode 100644 src/pages/docs/cli/apps/rules/list.mdx create mode 100644 src/pages/docs/cli/apps/rules/update.mdx create mode 100644 src/pages/docs/cli/apps/switch.mdx create mode 100644 src/pages/docs/cli/apps/update.mdx create mode 100644 src/pages/docs/cli/auth/index.mdx create mode 100644 src/pages/docs/cli/auth/issue-ably-token.mdx create mode 100644 src/pages/docs/cli/auth/issue-jwt-token.mdx create mode 100644 src/pages/docs/cli/auth/keys/create.mdx create mode 100644 src/pages/docs/cli/auth/keys/current.mdx create mode 100644 src/pages/docs/cli/auth/keys/get.mdx create mode 100644 src/pages/docs/cli/auth/keys/index.mdx create mode 100644 src/pages/docs/cli/auth/keys/list.mdx create mode 100644 src/pages/docs/cli/auth/keys/revoke.mdx create mode 100644 src/pages/docs/cli/auth/keys/switch.mdx create mode 100644 src/pages/docs/cli/auth/keys/update.mdx create mode 100644 src/pages/docs/cli/auth/revoke-token.mdx create mode 100644 src/pages/docs/cli/bench/index.mdx create mode 100644 src/pages/docs/cli/bench/publisher.mdx create mode 100644 src/pages/docs/cli/bench/subscriber.mdx create mode 100644 src/pages/docs/cli/channels/annotations/delete.mdx create mode 100644 src/pages/docs/cli/channels/annotations/get.mdx create mode 100644 src/pages/docs/cli/channels/annotations/index.mdx create mode 100644 src/pages/docs/cli/channels/annotations/publish.mdx create mode 100644 src/pages/docs/cli/channels/annotations/subscribe.mdx create mode 100644 src/pages/docs/cli/channels/append.mdx create mode 100644 src/pages/docs/cli/channels/batch-publish.mdx create mode 100644 src/pages/docs/cli/channels/delete.mdx create mode 100644 src/pages/docs/cli/channels/history.mdx create mode 100644 src/pages/docs/cli/channels/index.mdx create mode 100644 src/pages/docs/cli/channels/inspect.mdx create mode 100644 src/pages/docs/cli/channels/list.mdx create mode 100644 src/pages/docs/cli/channels/occupancy/get.mdx create mode 100644 src/pages/docs/cli/channels/occupancy/index.mdx create mode 100644 src/pages/docs/cli/channels/occupancy/subscribe.mdx create mode 100644 src/pages/docs/cli/channels/presence/enter.mdx create mode 100644 src/pages/docs/cli/channels/presence/get.mdx create mode 100644 src/pages/docs/cli/channels/presence/index.mdx create mode 100644 src/pages/docs/cli/channels/presence/subscribe.mdx create mode 100644 src/pages/docs/cli/channels/publish.mdx create mode 100644 src/pages/docs/cli/channels/subscribe.mdx create mode 100644 src/pages/docs/cli/channels/update.mdx create mode 100644 src/pages/docs/cli/config/index.mdx create mode 100644 src/pages/docs/cli/config/path.mdx create mode 100644 src/pages/docs/cli/config/show.mdx create mode 100644 src/pages/docs/cli/connections/index.mdx create mode 100644 src/pages/docs/cli/connections/test.mdx create mode 100644 src/pages/docs/cli/help.mdx create mode 100644 src/pages/docs/cli/index.mdx create mode 100644 src/pages/docs/cli/integrations/create.mdx create mode 100644 src/pages/docs/cli/integrations/delete.mdx create mode 100644 src/pages/docs/cli/integrations/get.mdx create mode 100644 src/pages/docs/cli/integrations/index.mdx create mode 100644 src/pages/docs/cli/integrations/list.mdx create mode 100644 src/pages/docs/cli/integrations/update.mdx create mode 100644 src/pages/docs/cli/interactive.mdx create mode 100644 src/pages/docs/cli/login.mdx create mode 100644 src/pages/docs/cli/logs/channel-lifecycle/index.mdx create mode 100644 src/pages/docs/cli/logs/channel-lifecycle/subscribe.mdx create mode 100644 src/pages/docs/cli/logs/connection-lifecycle/history.mdx create mode 100644 src/pages/docs/cli/logs/connection-lifecycle/index.mdx create mode 100644 src/pages/docs/cli/logs/connection-lifecycle/subscribe.mdx create mode 100644 src/pages/docs/cli/logs/history.mdx create mode 100644 src/pages/docs/cli/logs/index.mdx create mode 100644 src/pages/docs/cli/logs/push/history.mdx create mode 100644 src/pages/docs/cli/logs/push/index.mdx create mode 100644 src/pages/docs/cli/logs/push/subscribe.mdx create mode 100644 src/pages/docs/cli/logs/subscribe.mdx create mode 100644 src/pages/docs/cli/push/batch-publish.mdx create mode 100644 src/pages/docs/cli/push/channels/index.mdx create mode 100644 src/pages/docs/cli/push/channels/list-channels.mdx create mode 100644 src/pages/docs/cli/push/channels/list.mdx create mode 100644 src/pages/docs/cli/push/channels/remove-where.mdx create mode 100644 src/pages/docs/cli/push/channels/remove.mdx create mode 100644 src/pages/docs/cli/push/channels/save.mdx create mode 100644 src/pages/docs/cli/push/config/clear-apns.mdx create mode 100644 src/pages/docs/cli/push/config/clear-fcm.mdx create mode 100644 src/pages/docs/cli/push/config/index.mdx create mode 100644 src/pages/docs/cli/push/config/set-apns.mdx create mode 100644 src/pages/docs/cli/push/config/set-fcm.mdx create mode 100644 src/pages/docs/cli/push/config/show.mdx create mode 100644 src/pages/docs/cli/push/devices/get.mdx create mode 100644 src/pages/docs/cli/push/devices/index.mdx create mode 100644 src/pages/docs/cli/push/devices/list.mdx create mode 100644 src/pages/docs/cli/push/devices/remove-where.mdx create mode 100644 src/pages/docs/cli/push/devices/remove.mdx create mode 100644 src/pages/docs/cli/push/devices/save.mdx create mode 100644 src/pages/docs/cli/push/index.mdx create mode 100644 src/pages/docs/cli/push/publish.mdx create mode 100644 src/pages/docs/cli/queues/create.mdx create mode 100644 src/pages/docs/cli/queues/delete.mdx create mode 100644 src/pages/docs/cli/queues/index.mdx create mode 100644 src/pages/docs/cli/queues/list.mdx create mode 100644 src/pages/docs/cli/rooms/index.mdx create mode 100644 src/pages/docs/cli/rooms/list.mdx create mode 100644 src/pages/docs/cli/rooms/messages/delete.mdx create mode 100644 src/pages/docs/cli/rooms/messages/history.mdx create mode 100644 src/pages/docs/cli/rooms/messages/index.mdx create mode 100644 src/pages/docs/cli/rooms/messages/reactions/index.mdx create mode 100644 src/pages/docs/cli/rooms/messages/reactions/remove.mdx create mode 100644 src/pages/docs/cli/rooms/messages/reactions/send.mdx create mode 100644 src/pages/docs/cli/rooms/messages/reactions/subscribe.mdx create mode 100644 src/pages/docs/cli/rooms/messages/send.mdx create mode 100644 src/pages/docs/cli/rooms/messages/subscribe.mdx create mode 100644 src/pages/docs/cli/rooms/messages/update.mdx create mode 100644 src/pages/docs/cli/rooms/occupancy/get.mdx create mode 100644 src/pages/docs/cli/rooms/occupancy/index.mdx create mode 100644 src/pages/docs/cli/rooms/occupancy/subscribe.mdx create mode 100644 src/pages/docs/cli/rooms/presence/enter.mdx create mode 100644 src/pages/docs/cli/rooms/presence/get.mdx create mode 100644 src/pages/docs/cli/rooms/presence/index.mdx create mode 100644 src/pages/docs/cli/rooms/presence/subscribe.mdx create mode 100644 src/pages/docs/cli/rooms/reactions/index.mdx create mode 100644 src/pages/docs/cli/rooms/reactions/send.mdx create mode 100644 src/pages/docs/cli/rooms/reactions/subscribe.mdx create mode 100644 src/pages/docs/cli/rooms/typing/index.mdx create mode 100644 src/pages/docs/cli/rooms/typing/keystroke.mdx create mode 100644 src/pages/docs/cli/rooms/typing/subscribe.mdx create mode 100644 src/pages/docs/cli/spaces/create.mdx create mode 100644 src/pages/docs/cli/spaces/cursors/get.mdx create mode 100644 src/pages/docs/cli/spaces/cursors/index.mdx create mode 100644 src/pages/docs/cli/spaces/cursors/set.mdx create mode 100644 src/pages/docs/cli/spaces/cursors/subscribe.mdx create mode 100644 src/pages/docs/cli/spaces/get.mdx create mode 100644 src/pages/docs/cli/spaces/index.mdx create mode 100644 src/pages/docs/cli/spaces/list.mdx create mode 100644 src/pages/docs/cli/spaces/locations/get.mdx create mode 100644 src/pages/docs/cli/spaces/locations/index.mdx create mode 100644 src/pages/docs/cli/spaces/locations/set.mdx create mode 100644 src/pages/docs/cli/spaces/locations/subscribe.mdx create mode 100644 src/pages/docs/cli/spaces/locks/acquire.mdx create mode 100644 src/pages/docs/cli/spaces/locks/get.mdx create mode 100644 src/pages/docs/cli/spaces/locks/index.mdx create mode 100644 src/pages/docs/cli/spaces/locks/subscribe.mdx create mode 100644 src/pages/docs/cli/spaces/members/enter.mdx create mode 100644 src/pages/docs/cli/spaces/members/get.mdx create mode 100644 src/pages/docs/cli/spaces/members/index.mdx create mode 100644 src/pages/docs/cli/spaces/members/subscribe.mdx create mode 100644 src/pages/docs/cli/spaces/occupancy/get.mdx create mode 100644 src/pages/docs/cli/spaces/occupancy/index.mdx create mode 100644 src/pages/docs/cli/spaces/occupancy/subscribe.mdx create mode 100644 src/pages/docs/cli/spaces/subscribe.mdx create mode 100644 src/pages/docs/cli/stats/account.mdx create mode 100644 src/pages/docs/cli/stats/app.mdx create mode 100644 src/pages/docs/cli/stats/index.mdx create mode 100644 src/pages/docs/cli/status.mdx create mode 100644 src/pages/docs/cli/support/ask.mdx create mode 100644 src/pages/docs/cli/support/contact.mdx create mode 100644 src/pages/docs/cli/support/index.mdx create mode 100644 src/pages/docs/cli/version.mdx diff --git a/src/pages/docs/cli/accounts/current.mdx b/src/pages/docs/cli/accounts/current.mdx new file mode 100644 index 0000000000..a9e01e3a2d --- /dev/null +++ b/src/pages/docs/cli/accounts/current.mdx @@ -0,0 +1,41 @@ +--- +title: "ably accounts current" +meta_description: "Show the current Ably account using the CLI." +meta_keywords: "ably cli, cli, accounts, current account, ably accounts current" +--- + +Use the `ably accounts current` command to show details of the currently active Ably account. + +## Synopsis + + +```shell +ably accounts current [flags] +``` + + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Display the current account: + + +```shell +ably accounts current +``` + + +Display the current account in JSON format: + + +```shell +ably accounts current --json +``` + diff --git a/src/pages/docs/cli/accounts/index.mdx b/src/pages/docs/cli/accounts/index.mdx new file mode 100644 index 0000000000..63d1a629d0 --- /dev/null +++ b/src/pages/docs/cli/accounts/index.mdx @@ -0,0 +1,17 @@ +--- +title: "ably accounts" +meta_description: "Manage Ably accounts and configured access tokens using the CLI." +meta_keywords: "ably cli, cli, accounts, authentication, account management, ably accounts" +--- + +Use the `ably accounts` command group to manage your Ably accounts and configured access tokens. These commands enable you to log in, switch between accounts, view account information, and log out. + +## Subcommands + +| Command | Description | +| ------- | ----------- | +| [`ably accounts current`](/docs/cli/accounts/current) | Show the current Ably account. | +| [`ably accounts list`](/docs/cli/accounts/list) | List all locally configured Ably accounts. | +| [`ably accounts login`](/docs/cli/accounts/login) | Log in to an Ably account. | +| [`ably accounts logout`](/docs/cli/accounts/logout) | Log out from an Ably account. | +| [`ably accounts switch`](/docs/cli/accounts/switch) | Switch to a different Ably account. | diff --git a/src/pages/docs/cli/accounts/list.mdx b/src/pages/docs/cli/accounts/list.mdx new file mode 100644 index 0000000000..71ca8f366d --- /dev/null +++ b/src/pages/docs/cli/accounts/list.mdx @@ -0,0 +1,41 @@ +--- +title: "ably accounts list" +meta_description: "List all locally configured Ably accounts using the CLI." +meta_keywords: "ably cli, cli, accounts, list accounts, ably accounts list" +--- + +Use the `ably accounts list` command to list all locally configured Ably accounts. + +## Synopsis + + +```shell +ably accounts list [flags] +``` + + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +List all configured accounts: + + +```shell +ably accounts list +``` + + +List all configured accounts in JSON format: + + +```shell +ably accounts list --json +``` + diff --git a/src/pages/docs/cli/accounts/login.mdx b/src/pages/docs/cli/accounts/login.mdx new file mode 100644 index 0000000000..6710009248 --- /dev/null +++ b/src/pages/docs/cli/accounts/login.mdx @@ -0,0 +1,67 @@ +--- +title: "ably accounts login" +meta_description: "Log in to your Ably account using the CLI." +meta_keywords: "ably cli, cli, accounts, login, authentication, ably accounts login" +--- + +Use the `ably accounts login` command to log in to your Ably account. By default, this opens a browser window to authenticate. You can optionally provide an access token directly. + +## Synopsis + + +```shell +ably accounts login [token] [flags] +``` + + +## Arguments + +### `token` + +An optional access token to use for authentication. If not provided, the CLI opens a browser window to authenticate interactively. + +## Flags + +You can optionally pass the following flags to the `ably accounts login` command: + +### `--alias | -a` + +Set an alias name for this account. This enables you to easily switch between multiple accounts. + +### `--no-browser` + +Prevent the CLI from automatically opening a browser window for authentication. The CLI displays a URL that you can manually open instead. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Log in to your Ably account using the browser: + + +```shell +ably accounts login +``` + + +Log in and set an alias for the account: + + +```shell +ably accounts login --alias work +``` + + +Log in without opening a browser: + + +```shell +ably accounts login --no-browser +``` + diff --git a/src/pages/docs/cli/accounts/logout.mdx b/src/pages/docs/cli/accounts/logout.mdx new file mode 100644 index 0000000000..7fbb0baa04 --- /dev/null +++ b/src/pages/docs/cli/accounts/logout.mdx @@ -0,0 +1,63 @@ +--- +title: "ably accounts logout" +meta_description: "Log out from an Ably account using the CLI." +meta_keywords: "ably cli, cli, accounts, logout, authentication, ably accounts logout" +--- + +Use the `ably accounts logout` command to log out from an Ably account. By default, this logs out from the current account and prompts for confirmation. + +## Synopsis + + +```shell +ably accounts logout [alias] [flags] +``` + + +## Arguments + +### `alias` + +An optional account alias to log out from. If not provided, the CLI logs out from the current account. + +## Flags + +You can optionally pass the following flags to the `ably accounts logout` command: + +### `--force | -f` + +Skip the confirmation prompt and log out immediately. Required when using `--json`. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Log out from the current account: + + +```shell +ably accounts logout +``` + + +Log out from a specific account by alias: + + +```shell +ably accounts logout work +``` + + +Log out without confirmation: + + +```shell +ably accounts logout --force +``` + diff --git a/src/pages/docs/cli/accounts/switch.mdx b/src/pages/docs/cli/accounts/switch.mdx new file mode 100644 index 0000000000..6e5d09f086 --- /dev/null +++ b/src/pages/docs/cli/accounts/switch.mdx @@ -0,0 +1,47 @@ +--- +title: "ably accounts switch" +meta_description: "Switch to a different Ably account using the CLI." +meta_keywords: "ably cli, cli, accounts, switch account, ably accounts switch" +--- + +Use the `ably accounts switch` command to switch to a different locally configured Ably account. If no alias is provided, the CLI presents an interactive list of available accounts. + +## Synopsis + + +```shell +ably accounts switch [alias] +``` + + +## Arguments + +### `alias` + +An optional account alias to switch to. If not provided, the CLI displays an interactive prompt to select from available accounts. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Switch accounts interactively: + + +```shell +ably accounts switch +``` + + +Switch to a specific account by alias: + + +```shell +ably accounts switch work +``` + diff --git a/src/pages/docs/cli/apps/create.mdx b/src/pages/docs/cli/apps/create.mdx new file mode 100644 index 0000000000..f3a88153ec --- /dev/null +++ b/src/pages/docs/cli/apps/create.mdx @@ -0,0 +1,51 @@ +--- +title: "ably apps create" +meta_description: "Create a new Ably application using the CLI." +meta_keywords: "ably cli, cli, apps, create, new application, ably apps create" +--- + + +```shell +ably apps create --name [flags] +``` + + +Use the `ably apps create` command to create a new Ably application in your account. + +## Flags + +You can pass the following flags to the `ably apps create` command: + +### `--name` + +The name of the application to create. This flag is required. + +### `--tls-only` + +Restrict the application to TLS connections only. When enabled, all connections to this app must use TLS encryption. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Create a new application: + + +```shell +ably apps create --name "my-app" +``` + + +Create an application restricted to TLS connections only: + + +```shell +ably apps create --name "secure-app" --tls-only +``` + diff --git a/src/pages/docs/cli/apps/current.mdx b/src/pages/docs/cli/apps/current.mdx new file mode 100644 index 0000000000..91ad7d2f8b --- /dev/null +++ b/src/pages/docs/cli/apps/current.mdx @@ -0,0 +1,39 @@ +--- +title: "ably apps current" +meta_description: "Show the currently selected Ably application using the CLI." +meta_keywords: "ably cli, cli, apps, current, selected app, ably apps current" +--- + + +```shell +ably apps current +``` + + +Use the `ably apps current` command to display information about the currently selected Ably application. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Show the currently selected app: + + +```shell +ably apps current +``` + + +Show the currently selected app in JSON format: + + +```shell +ably apps current --json +``` + diff --git a/src/pages/docs/cli/apps/delete.mdx b/src/pages/docs/cli/apps/delete.mdx new file mode 100644 index 0000000000..2521a4ff6a --- /dev/null +++ b/src/pages/docs/cli/apps/delete.mdx @@ -0,0 +1,71 @@ +--- +title: "ably apps delete" +meta_description: "Permanently delete an Ably application using the CLI." +meta_keywords: "ably cli, cli, apps, delete, remove application, ably apps delete" +--- + + +```shell +ably apps delete [id] [flags] +``` + + +Use the `ably apps delete` command to permanently delete an Ably application. + + + +## Arguments + +Pass the following arguments to the `ably apps delete` command: + +### `[id]` + +The ID of the application to delete. If not specified, the currently selected app is used. + +## Flags + +You can optionally pass the following flags to the `ably apps delete` command: + +### `--app` + +The app ID to delete. This flag overrides both the `[id]` argument and the currently selected app. + +### `--force | -f` + +Skip the confirmation prompt and delete the application immediately. Required when using `--json`. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Delete the currently selected app: + + +```shell +ably apps delete +``` + + +Delete a specific app by ID: + + +```shell +ably apps delete aBcDe1 +``` + + +Delete an app without a confirmation prompt: + + +```shell +ably apps delete aBcDe1 --force +``` + diff --git a/src/pages/docs/cli/apps/index.mdx b/src/pages/docs/cli/apps/index.mdx new file mode 100644 index 0000000000..b00490fef5 --- /dev/null +++ b/src/pages/docs/cli/apps/index.mdx @@ -0,0 +1,28 @@ +--- +title: "ably apps" +meta_description: "Manage your Ably applications using the CLI." +meta_keywords: "ably cli, cli, apps, applications, app management, ably apps" +--- + +Use the `ably apps` command group to manage your Ably applications. These commands enable you to create, update, delete, list, and switch between apps, as well as manage channel rules for your apps. + +## App management commands + +| Command | Description | +| ------- | ----------- | +| [`ably apps create`](/docs/cli/apps/create) | Create a new Ably application. | +| [`ably apps current`](/docs/cli/apps/current) | Show the currently selected app. | +| [`ably apps delete`](/docs/cli/apps/delete) | Permanently delete an Ably application. | +| [`ably apps list`](/docs/cli/apps/list) | List all apps in the current account. | +| [`ably apps switch`](/docs/cli/apps/switch) | Switch to a different Ably app. | +| [`ably apps update`](/docs/cli/apps/update) | Update an app's configuration. | + +## Rule management commands + +| Command | Description | +| ------- | ----------- | +| [`ably apps rules`](/docs/cli/apps/rules) | Manage channel rules (namespaces) for apps. | +| [`ably apps rules create`](/docs/cli/apps/rules/create) | Create a channel rule for an app. | +| [`ably apps rules delete`](/docs/cli/apps/rules/delete) | Delete a channel rule from an app. | +| [`ably apps rules list`](/docs/cli/apps/rules/list) | List channel rules for an app. | +| [`ably apps rules update`](/docs/cli/apps/rules/update) | Update a channel rule for an app. | diff --git a/src/pages/docs/cli/apps/list.mdx b/src/pages/docs/cli/apps/list.mdx new file mode 100644 index 0000000000..4a3a40969b --- /dev/null +++ b/src/pages/docs/cli/apps/list.mdx @@ -0,0 +1,47 @@ +--- +title: "ably apps list" +meta_description: "List all Ably applications in the current account using the CLI." +meta_keywords: "ably cli, cli, apps, list, applications, ably apps list" +--- + + +```shell +ably apps list [flags] +``` + + +Use the `ably apps list` command to list all applications in the current account. + +## Flags + +You can optionally pass the following flags to the `ably apps list` command: + +### `--limit` + +The maximum number of results to return. Defaults to `100`. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +List all apps in the current account: + + +```shell +ably apps list +``` + + +List apps in JSON format: + + +```shell +ably apps list --json +``` + diff --git a/src/pages/docs/cli/apps/rules/create.mdx b/src/pages/docs/cli/apps/rules/create.mdx new file mode 100644 index 0000000000..0d643fd8a5 --- /dev/null +++ b/src/pages/docs/cli/apps/rules/create.mdx @@ -0,0 +1,107 @@ +--- +title: "ably apps rules create" +meta_description: "Create a channel rule for an Ably application using the CLI." +meta_keywords: "ably cli, cli, apps, rules, create, channel rule, namespace, ably apps rules create" +--- + + +```shell +ably apps rules create --name [flags] +``` + + +Use the `ably apps rules create` command to create a new channel rule for an Ably application. Channel rules define behavior for channels matching a specific namespace. + +## Flags + +You can pass the following flags to the `ably apps rules create` command: + +### `--app` + +The app ID to create the rule for. Uses the currently selected app if not specified. + +### `--name` + +The name of the channel rule to create. This flag is required. The name defines the namespace that matching channels belong to. + +### `--persisted` + +Enable message persistence for matching channels. Defaults to `false`. + +### `--push-enabled` + +Enable push notifications for matching channels. Defaults to `false`. + +### `--authenticated` + +Require authentication for operations on matching channels. + +### `--tls-only` + +Restrict matching channels to TLS connections only. + +### `--persist-last` + +Persist only the last message on matching channels. + +### `--populate-channel-registry` + +Populate the channel registry for matching channels, enabling channel enumeration. + +### `--mutable-messages` + +Enable message update and delete functionality on matching channels. Enabling this flag automatically enables message persistence. + +### `--batching-enabled` + +Enable message batching for matching channels. + +### `--batching-interval` + +The batching interval in milliseconds for matching channels. Only applicable when `--batching-enabled` is set. + +### `--conflation-enabled` + +Enable message conflation for matching channels. + +### `--conflation-interval` + +The conflation interval in milliseconds for matching channels. Only applicable when `--conflation-enabled` is set. + +### `--conflation-key` + +The conflation key for matching channels. Only applicable when `--conflation-enabled` is set. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Create a channel rule with message persistence enabled: + + +```shell +ably apps rules create --name "chat" --persisted +``` + + +Create a channel rule with mutable messages enabled: + + +```shell +ably apps rules create --name "updates" --mutable-messages +``` + + +Create a channel rule with push notifications enabled: + + +```shell +ably apps rules create --name "alerts" --push-enabled +``` + diff --git a/src/pages/docs/cli/apps/rules/delete.mdx b/src/pages/docs/cli/apps/rules/delete.mdx new file mode 100644 index 0000000000..55ea6455eb --- /dev/null +++ b/src/pages/docs/cli/apps/rules/delete.mdx @@ -0,0 +1,59 @@ +--- +title: "ably apps rules delete" +meta_description: "Delete a channel rule from an Ably application using the CLI." +meta_keywords: "ably cli, cli, apps, rules, delete, remove, channel rule, ably apps rules delete" +--- + + +```shell +ably apps rules delete [flags] +``` + + +Use the `ably apps rules delete` command to delete a channel rule from an Ably application. + +## Arguments + +Pass the following arguments to the `ably apps rules delete` command: + +### `` + +The name or ID of the channel rule to delete. This argument is required. + +## Flags + +You can optionally pass the following flags to the `ably apps rules delete` command: + +### `--app` + +The app ID to delete the rule from. Uses the currently selected app if not specified. + +### `--force | -f` + +Skip the confirmation prompt and delete the rule immediately. Required when using `--json`. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Delete a channel rule by name: + + +```shell +ably apps rules delete "chat" +``` + + +Delete a channel rule without a confirmation prompt: + + +```shell +ably apps rules delete "chat" --force +``` + diff --git a/src/pages/docs/cli/apps/rules/index.mdx b/src/pages/docs/cli/apps/rules/index.mdx new file mode 100644 index 0000000000..1b47e8ce9b --- /dev/null +++ b/src/pages/docs/cli/apps/rules/index.mdx @@ -0,0 +1,16 @@ +--- +title: "ably apps rules" +meta_description: "Manage channel rules for Ably applications using the CLI." +meta_keywords: "ably cli, cli, apps, rules, namespaces, channel rules, ably apps rules" +--- + +Use the `ably apps rules` command group to manage channel rules (namespaces) for your Ably applications. Channel rules enable you to configure behavior for channels matching a specific namespace. + +## Subcommands + +| Command | Description | +| ------- | ----------- | +| [`ably apps rules create`](/docs/cli/apps/rules/create) | Create a channel rule for an app. | +| [`ably apps rules delete`](/docs/cli/apps/rules/delete) | Delete a channel rule from an app. | +| [`ably apps rules list`](/docs/cli/apps/rules/list) | List channel rules for an app. | +| [`ably apps rules update`](/docs/cli/apps/rules/update) | Update a channel rule for an app. | diff --git a/src/pages/docs/cli/apps/rules/list.mdx b/src/pages/docs/cli/apps/rules/list.mdx new file mode 100644 index 0000000000..04cd240214 --- /dev/null +++ b/src/pages/docs/cli/apps/rules/list.mdx @@ -0,0 +1,51 @@ +--- +title: "ably apps rules list" +meta_description: "List channel rules for an Ably application using the CLI." +meta_keywords: "ably cli, cli, apps, rules, list, channel rules, namespaces, ably apps rules list" +--- + + +```shell +ably apps rules list [flags] +``` + + +Use the `ably apps rules list` command to list all channel rules configured for an Ably application. + +## Flags + +You can optionally pass the following flags to the `ably apps rules list` command: + +### `--app` + +The app ID to list rules for. Uses the currently selected app if not specified. + +### `--limit` + +The maximum number of results to return. Defaults to `100`. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +List all channel rules for the current app: + + +```shell +ably apps rules list +``` + + +List channel rules for a specific app: + + +```shell +ably apps rules list --app aBcDe1 +``` + diff --git a/src/pages/docs/cli/apps/rules/update.mdx b/src/pages/docs/cli/apps/rules/update.mdx new file mode 100644 index 0000000000..bbfc1ead1a --- /dev/null +++ b/src/pages/docs/cli/apps/rules/update.mdx @@ -0,0 +1,115 @@ +--- +title: "ably apps rules update" +meta_description: "Update a channel rule for an Ably application using the CLI." +meta_keywords: "ably cli, cli, apps, rules, update, modify, channel rule, ably apps rules update" +--- + + +```shell +ably apps rules update [flags] +``` + + +Use the `ably apps rules update` command to update an existing channel rule for an Ably application. + +## Arguments + +Pass the following arguments to the `ably apps rules update` command: + +### `` + +The name or ID of the channel rule to update. This argument is required. + +## Flags + +You can optionally pass the following flags to the `ably apps rules update` command: + + + +### `--app` + +The app ID that owns the rule to update. Uses the currently selected app if not specified. + +### `--persisted` + +Enable message persistence for matching channels. + +### `--push-enabled` + +Enable push notifications for matching channels. + +### `--authenticated` + +Require authentication for operations on matching channels. + +### `--tls-only` + +Restrict matching channels to TLS connections only. + +### `--persist-last` + +Persist only the last message on matching channels. + +### `--populate-channel-registry` + +Populate the channel registry for matching channels, enabling channel enumeration. + +### `--mutable-messages` + +Enable message update and delete functionality on matching channels. Enabling this flag automatically enables message persistence. + +### `--batching-enabled` + +Enable message batching for matching channels. + +### `--batching-interval` + +The batching interval in milliseconds for matching channels. Only applicable when `--batching-enabled` is set. + +### `--conflation-enabled` + +Enable message conflation for matching channels. + +### `--conflation-interval` + +The conflation interval in milliseconds for matching channels. Only applicable when `--conflation-enabled` is set. + +### `--conflation-key` + +The conflation key for matching channels. Only applicable when `--conflation-enabled` is set. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Enable message persistence on a channel rule: + + +```shell +ably apps rules update "chat" --persisted +``` + + +Disable push notifications on a channel rule: + + +```shell +ably apps rules update "alerts" --no-push-enabled +``` + + +Update a channel rule and output the result as JSON: + + +```shell +ably apps rules update "chat" --persisted --json +``` + diff --git a/src/pages/docs/cli/apps/switch.mdx b/src/pages/docs/cli/apps/switch.mdx new file mode 100644 index 0000000000..570963f5a0 --- /dev/null +++ b/src/pages/docs/cli/apps/switch.mdx @@ -0,0 +1,47 @@ +--- +title: "ably apps switch" +meta_description: "Switch to a different Ably application using the CLI." +meta_keywords: "ably cli, cli, apps, switch, change app, ably apps switch" +--- + + +```shell +ably apps switch [id] +``` + + +Use the `ably apps switch` command to switch to a different Ably application. The selected app is used as the default for subsequent commands. + +## Arguments + +Pass the following arguments to the `ably apps switch` command: + +### `[id]` + +The ID of the application to switch to. If not specified, the CLI will display an interactive prompt to select an app. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Switch to an app using the interactive prompt: + + +```shell +ably apps switch +``` + + +Switch to a specific app by ID: + + +```shell +ably apps switch aBcDe1 +``` + diff --git a/src/pages/docs/cli/apps/update.mdx b/src/pages/docs/cli/apps/update.mdx new file mode 100644 index 0000000000..f98586193c --- /dev/null +++ b/src/pages/docs/cli/apps/update.mdx @@ -0,0 +1,59 @@ +--- +title: "ably apps update" +meta_description: "Update an Ably application's configuration using the CLI." +meta_keywords: "ably cli, cli, apps, update, modify application, ably apps update" +--- + + +```shell +ably apps update [flags] +``` + + +Use the `ably apps update` command to update the configuration of an existing Ably application. + +## Arguments + +Pass the following arguments to the `ably apps update` command: + +### `` + +The ID of the application to update. This argument is required. + +## Flags + +You can optionally pass the following flags to the `ably apps update` command: + +### `--name` + +The new name for the application. + +### `--tls-only` + +Restrict the application to TLS connections only. When enabled, all connections to this app must use TLS encryption. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Update an application's name: + + +```shell +ably apps update aBcDe1 --name "new-app-name" +``` + + +Restrict an application to TLS connections only: + + +```shell +ably apps update aBcDe1 --tls-only +``` + diff --git a/src/pages/docs/cli/auth/index.mdx b/src/pages/docs/cli/auth/index.mdx new file mode 100644 index 0000000000..31895c938c --- /dev/null +++ b/src/pages/docs/cli/auth/index.mdx @@ -0,0 +1,28 @@ +--- +title: "ably auth" +meta_description: "Manage authentication, API keys, and tokens using the CLI." +meta_keywords: "ably cli, cli, auth, authentication, api keys, tokens, ably auth" +--- + +Use the `ably auth` command group to manage authentication, API keys, and tokens. These commands enable you to issue and revoke tokens, and manage API keys for your apps. + +## Token management commands + +| Command | Description | +| ------- | ----------- | +| [`ably auth issue-ably-token`](/docs/cli/auth/issue-ably-token) | Create an Ably Token with specified capabilities. | +| [`ably auth issue-jwt-token`](/docs/cli/auth/issue-jwt-token) | Create an Ably JWT token with specified capabilities. | +| [`ably auth revoke-token`](/docs/cli/auth/revoke-token) | Revoke an Ably token. | + +## Key management commands + +| Command | Description | +| ------- | ----------- | +| [`ably auth keys`](/docs/cli/auth/keys) | Manage API keys for Ably apps. | +| [`ably auth keys create`](/docs/cli/auth/keys/create) | Create a new API key for an app. | +| [`ably auth keys current`](/docs/cli/auth/keys/current) | Show the current API key for the selected app. | +| [`ably auth keys get`](/docs/cli/auth/keys/get) | Get details for a specific API key. | +| [`ably auth keys list`](/docs/cli/auth/keys/list) | List all API keys for an app. | +| [`ably auth keys revoke`](/docs/cli/auth/keys/revoke) | Permanently revoke an API key. | +| [`ably auth keys switch`](/docs/cli/auth/keys/switch) | Switch to a different API key for the current app. | +| [`ably auth keys update`](/docs/cli/auth/keys/update) | Update an API key's properties. | diff --git a/src/pages/docs/cli/auth/issue-ably-token.mdx b/src/pages/docs/cli/auth/issue-ably-token.mdx new file mode 100644 index 0000000000..8acbf2af36 --- /dev/null +++ b/src/pages/docs/cli/auth/issue-ably-token.mdx @@ -0,0 +1,89 @@ +--- +title: "ably auth issue-ably-token" +meta_description: "Create an Ably Token with specified capabilities using the CLI." +meta_keywords: "ably cli, cli, auth, token, issue token, ably token, ably auth issue-ably-token" +--- + +Use the `ably auth issue-ably-token` command to create an Ably Token with specified capabilities. + +## Synopsis + + +```shell +ably auth issue-ably-token [flags] +``` + + +## Flags + +You can optionally pass the following flags to the `ably auth issue-ably-token` command: + +### `--app` + +The app ID to issue the token for. Uses the currently selected app if not specified. + +### `--capability` + +A JSON string specifying the [capabilities](/docs/auth/capabilities) for the token. Defaults to `'{"*":["*"]}'`. + +### `--client-id` + +The client ID to associate with the token. Use `"none"` to issue a token with no client ID. + +### `--ttl` + +The time to live for the token in seconds. Defaults to `3600`. + +### `--token-only` + +Output only the token string, without any additional information. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Issue a default Ably Token: + + +```shell +ably auth issue-ably-token +``` + + +Issue a token with specific capabilities: + + +```shell +ably auth issue-ably-token --capability '{"my-channel":["publish","subscribe"]}' +``` + + +Issue a token with a specific client ID: + + +```shell +ably auth issue-ably-token --client-id "user-123" +``` + + +Output only the token string for scripting: + + +```shell +ably auth issue-ably-token --token-only +``` + + +Pipe the token to another command: + + +```shell +ably auth issue-ably-token --token-only | pbcopy +``` + diff --git a/src/pages/docs/cli/auth/issue-jwt-token.mdx b/src/pages/docs/cli/auth/issue-jwt-token.mdx new file mode 100644 index 0000000000..03f04d2ce1 --- /dev/null +++ b/src/pages/docs/cli/auth/issue-jwt-token.mdx @@ -0,0 +1,73 @@ +--- +title: "ably auth issue-jwt-token" +meta_description: "Create an Ably JWT token with specified capabilities using the CLI." +meta_keywords: "ably cli, cli, auth, jwt, jwt token, issue jwt token, ably auth issue-jwt-token" +--- + +Use the `ably auth issue-jwt-token` command to create an Ably JWT token with specified capabilities. + +## Synopsis + + +```shell +ably auth issue-jwt-token [flags] +``` + + +## Flags + +You can optionally pass the following flags to the `ably auth issue-jwt-token` command: + +### `--app` + +The app ID to issue the token for. Uses the currently selected app if not specified. + +### `--capability` + +A JSON string specifying the [capabilities](/docs/auth/capabilities) for the token. Defaults to `'{"*":["*"]}'`. + +### `--client-id` + +The client ID to associate with the token. Use `"none"` to issue a token with no client ID. + +### `--ttl` + +The time to live for the token in seconds. Defaults to `3600`. + +### `--token-only` + +Output only the token string, without any additional information. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Issue a default Ably JWT token: + + +```shell +ably auth issue-jwt-token +``` + + +Issue a JWT token with specific capabilities: + + +```shell +ably auth issue-jwt-token --capability '{"my-channel":["publish","subscribe"]}' +``` + + +Output only the token string: + + +```shell +ably auth issue-jwt-token --token-only +``` + diff --git a/src/pages/docs/cli/auth/keys/create.mdx b/src/pages/docs/cli/auth/keys/create.mdx new file mode 100644 index 0000000000..8e57c832df --- /dev/null +++ b/src/pages/docs/cli/auth/keys/create.mdx @@ -0,0 +1,57 @@ +--- +title: "ably auth keys create" +meta_description: "Create a new API key for an Ably app using the CLI." +meta_keywords: "ably cli, cli, auth, keys, create key, api key, ably auth keys create" +--- + +Use the `ably auth keys create` command to create a new API key for an app. + +## Synopsis + + +```shell +ably auth keys create --name [flags] +``` + + +## Flags + +You can optionally pass the following flags to the `ably auth keys create` command: + +### `--app` + +The app ID to create the key for. Uses the currently selected app if not specified. + +### `--name` + +Required. The name for the new API key. + +### `--capabilities` + +A JSON string specifying the [capabilities](/docs/auth/capabilities) for the key. Defaults to `'{"*":["*"]}'`. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Create a basic API key: + + +```shell +ably auth keys create --name "My API Key" +``` + + +Create a key with specific capabilities: + + +```shell +ably auth keys create --name "Publish Only" --capabilities '{"my-channel":["publish"]}' +``` + diff --git a/src/pages/docs/cli/auth/keys/current.mdx b/src/pages/docs/cli/auth/keys/current.mdx new file mode 100644 index 0000000000..e9df12fe2c --- /dev/null +++ b/src/pages/docs/cli/auth/keys/current.mdx @@ -0,0 +1,49 @@ +--- +title: "ably auth keys current" +meta_description: "Show the current API key for the selected Ably app using the CLI." +meta_keywords: "ably cli, cli, auth, keys, current key, api key, ably auth keys current" +--- + +Use the `ably auth keys current` command to show the current API key for the selected app. + +## Synopsis + + +```shell +ably auth keys current [flags] +``` + + +## Flags + +You can optionally pass the following flags to the `ably auth keys current` command: + +### `--app` + +The app ID to show the current key for. Uses the currently selected app if not specified. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Show the current API key: + + +```shell +ably auth keys current +``` + + +Show the current key for a specific app: + + +```shell +ably auth keys current --app "aBcDeF" +``` + diff --git a/src/pages/docs/cli/auth/keys/get.mdx b/src/pages/docs/cli/auth/keys/get.mdx new file mode 100644 index 0000000000..51b4fb48e2 --- /dev/null +++ b/src/pages/docs/cli/auth/keys/get.mdx @@ -0,0 +1,57 @@ +--- +title: "ably auth keys get" +meta_description: "Get details for a specific API key using the CLI." +meta_keywords: "ably cli, cli, auth, keys, get key, api key details, ably auth keys get" +--- + +Use the `ably auth keys get` command to get details for a specific API key. + +## Synopsis + + +```shell +ably auth keys get [flags] +``` + + +## Arguments + +Pass the following arguments to the `ably auth keys get` command: + +### `key-name-or-value` + +The identifier for the API key to retrieve. This can be a key name (`APP_ID.KEY_ID`), a key ID, a key label, or the full key value. + +## Flags + +You can optionally pass the following flags to the `ably auth keys get` command: + +### `--app` + +The app ID the key belongs to. Uses the currently selected app if not specified. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Get a key by its key name: + + +```shell +ably auth keys get "aBcDeF.gHiJkL" +``` + + +Get a key by its label: + + +```shell +ably auth keys get "My API Key" +``` + diff --git a/src/pages/docs/cli/auth/keys/index.mdx b/src/pages/docs/cli/auth/keys/index.mdx new file mode 100644 index 0000000000..ba7b2622c2 --- /dev/null +++ b/src/pages/docs/cli/auth/keys/index.mdx @@ -0,0 +1,19 @@ +--- +title: "ably auth keys" +meta_description: "Manage API keys for Ably apps using the CLI." +meta_keywords: "ably cli, cli, auth, keys, api keys, key management, ably auth keys" +--- + +Use the `ably auth keys` command group to manage API keys for Ably apps. These commands enable you to create, list, update, revoke, and switch between API keys. + +## Subcommands + +| Command | Description | +| ------- | ----------- | +| [`ably auth keys create`](/docs/cli/auth/keys/create) | Create a new API key for an app. | +| [`ably auth keys current`](/docs/cli/auth/keys/current) | Show the current API key for the selected app. | +| [`ably auth keys get`](/docs/cli/auth/keys/get) | Get details for a specific API key. | +| [`ably auth keys list`](/docs/cli/auth/keys/list) | List all API keys for an app. | +| [`ably auth keys revoke`](/docs/cli/auth/keys/revoke) | Permanently revoke an API key. | +| [`ably auth keys switch`](/docs/cli/auth/keys/switch) | Switch to a different API key for the current app. | +| [`ably auth keys update`](/docs/cli/auth/keys/update) | Update an API key's properties. | diff --git a/src/pages/docs/cli/auth/keys/list.mdx b/src/pages/docs/cli/auth/keys/list.mdx new file mode 100644 index 0000000000..5e2ab473f1 --- /dev/null +++ b/src/pages/docs/cli/auth/keys/list.mdx @@ -0,0 +1,53 @@ +--- +title: "ably auth keys list" +meta_description: "List all API keys for an Ably app using the CLI." +meta_keywords: "ably cli, cli, auth, keys, list keys, api keys, ably auth keys list" +--- + +Use the `ably auth keys list` command to list all API keys for an app. + +## Synopsis + + +```shell +ably auth keys list [flags] +``` + + +## Flags + +You can optionally pass the following flags to the `ably auth keys list` command: + +### `--app` + +The app ID to list keys for. Uses the currently selected app if not specified. + +### `--limit` + +The maximum number of keys to return. Defaults to `100`. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +List all API keys for the current app: + + +```shell +ably auth keys list +``` + + +List keys for a specific app: + + +```shell +ably auth keys list --app "aBcDeF" +``` + diff --git a/src/pages/docs/cli/auth/keys/revoke.mdx b/src/pages/docs/cli/auth/keys/revoke.mdx new file mode 100644 index 0000000000..9fea1e788b --- /dev/null +++ b/src/pages/docs/cli/auth/keys/revoke.mdx @@ -0,0 +1,61 @@ +--- +title: "ably auth keys revoke" +meta_description: "Permanently revoke an API key using the CLI." +meta_keywords: "ably cli, cli, auth, keys, revoke key, api key revocation, ably auth keys revoke" +--- + +Use the `ably auth keys revoke` command to permanently revoke an API key. + +## Synopsis + + +```shell +ably auth keys revoke [flags] +``` + + +## Arguments + +Pass the following arguments to the `ably auth keys revoke` command: + +### `key-name` + +The key name (`APP_ID.KEY_ID`) of the API key to revoke. + +## Flags + +You can optionally pass the following flags to the `ably auth keys revoke` command: + +### `--app` + +The app ID the key belongs to. Uses the currently selected app if not specified. + +### `--force` + +Skip the confirmation prompt and revoke the key immediately. Required when using `--json`. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Revoke an API key: + + +```shell +ably auth keys revoke "aBcDeF.gHiJkL" +``` + + +Force revoke without confirmation: + + +```shell +ably auth keys revoke "aBcDeF.gHiJkL" --force +``` + diff --git a/src/pages/docs/cli/auth/keys/switch.mdx b/src/pages/docs/cli/auth/keys/switch.mdx new file mode 100644 index 0000000000..c56da23b82 --- /dev/null +++ b/src/pages/docs/cli/auth/keys/switch.mdx @@ -0,0 +1,55 @@ +--- +title: "ably auth keys switch" +meta_description: "Switch to a different API key for the current Ably app using the CLI." +meta_keywords: "ably cli, cli, auth, keys, switch key, api key, ably auth keys switch" +--- + +Use the `ably auth keys switch` command to switch to a different API key for the current app. If no key identifier is provided, the CLI presents an interactive list of available keys. + +## Synopsis + + +```shell +ably auth keys switch [key-name-or-value] [flags] +``` + + +## Arguments + +### `key-name-or-value` + +An optional identifier for the API key to switch to. This can be a key name (`APP_ID.KEY_ID`), a key ID, a key label, or the full key value. If not provided, the CLI displays an interactive prompt to select from available keys. + +## Flags + +You can optionally pass the following flags to the `ably auth keys switch` command: + +### `--app` + +The app ID to switch keys for. Uses the currently selected app if not specified. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Switch keys interactively: + + +```shell +ably auth keys switch +``` + + +Switch to a specific key: + + +```shell +ably auth keys switch "aBcDeF.gHiJkL" +``` + diff --git a/src/pages/docs/cli/auth/keys/update.mdx b/src/pages/docs/cli/auth/keys/update.mdx new file mode 100644 index 0000000000..660f844686 --- /dev/null +++ b/src/pages/docs/cli/auth/keys/update.mdx @@ -0,0 +1,65 @@ +--- +title: "ably auth keys update" +meta_description: "Update an API key's properties using the CLI." +meta_keywords: "ably cli, cli, auth, keys, update key, api key, ably auth keys update" +--- + +Use the `ably auth keys update` command to update an API key's properties. + +## Synopsis + + +```shell +ably auth keys update [flags] +``` + + +## Arguments + +Pass the following arguments to the `ably auth keys update` command: + +### `key-name` + +The key name (`APP_ID.KEY_ID`) of the API key to update. + +## Flags + +You can optionally pass the following flags to the `ably auth keys update` command: + +### `--app` + +The app ID the key belongs to. Uses the currently selected app if not specified. + +### `--name` + +The new name for the API key. + +### `--capabilities` + +A comma-separated list of new [capabilities](/docs/auth/capabilities) for the key, for example: `publish,subscribe`. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Rename an API key: + + +```shell +ably auth keys update "aBcDeF.gHiJkL" --name "Production Key" +``` + + +Update the capabilities for a key: + + +```shell +ably auth keys update "aBcDeF.gHiJkL" --capabilities "publish,subscribe" +``` + diff --git a/src/pages/docs/cli/auth/revoke-token.mdx b/src/pages/docs/cli/auth/revoke-token.mdx new file mode 100644 index 0000000000..2449adde78 --- /dev/null +++ b/src/pages/docs/cli/auth/revoke-token.mdx @@ -0,0 +1,61 @@ +--- +title: "ably auth revoke-token" +meta_description: "Revoke an Ably token using the CLI." +meta_keywords: "ably cli, cli, auth, revoke token, token revocation, ably auth revoke-token" +--- + +Use the `ably auth revoke-token` command to revoke an Ably token. + +## Synopsis + + +```shell +ably auth revoke-token [flags] +``` + + +## Arguments + +Pass the following arguments to the `ably auth revoke-token` command: + +### `token` + +The token to revoke. + +## Flags + +You can optionally pass the following flags to the `ably auth revoke-token` command: + +### `--app` + +The app ID the token belongs to. Uses the currently selected app if not specified. + +### `--client-id | -c` + +The client ID to revoke tokens for. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Revoke a specific token: + + +```shell +ably auth revoke-token "xVLyHw.DRE6hQ..." +``` + + +Revoke tokens for a specific client ID: + + +```shell +ably auth revoke-token "xVLyHw.DRE6hQ..." --client-id "user-123" +``` + diff --git a/src/pages/docs/cli/bench/index.mdx b/src/pages/docs/cli/bench/index.mdx new file mode 100644 index 0000000000..00bce3b022 --- /dev/null +++ b/src/pages/docs/cli/bench/index.mdx @@ -0,0 +1,14 @@ +--- +title: "ably bench" +meta_description: "Performance benchmarking commands." +meta_keywords: "ably cli, cli, bench, benchmark, performance, ably bench" +--- + +Use the `ably bench` command group to run performance benchmarking tests. These commands enable you to measure publishing and subscribing throughput on Ably channels. + +## Subcommands + +| Command | Description | +| ------- | ----------- | +| [`ably bench publisher`](/docs/cli/bench/publisher) | Run a publisher benchmark test. | +| [`ably bench subscriber`](/docs/cli/bench/subscriber) | Run a subscriber benchmark test. | diff --git a/src/pages/docs/cli/bench/publisher.mdx b/src/pages/docs/cli/bench/publisher.mdx new file mode 100644 index 0000000000..7d1c3d7e41 --- /dev/null +++ b/src/pages/docs/cli/bench/publisher.mdx @@ -0,0 +1,83 @@ +--- +title: "ably bench publisher" +meta_description: "Run a publisher benchmark test using the Ably CLI." +meta_keywords: "ably cli, cli, bench, publisher, benchmark, performance, ably bench publisher" +--- + + +```shell +ably bench publisher [flags] +``` + + +Use the `ably bench publisher` command to run a publisher benchmark test on an Ably channel. + +## Arguments + +Pass the following arguments to the `ably bench publisher` command: + +### `` + +The name of the channel to publish messages to. This argument is required. + +## Flags + +You can optionally pass the following flags to the `ably bench publisher` command: + +### `--message-size` + +The size of each message in bytes. The default value is `100`. + +### `--messages | -m` + +The number of messages to publish. The default value is `1000`. The maximum value is `10000`. + +### `--rate | -r` + +The rate of messages per second. The default value is `15`. The maximum value is `20`. + +### `--transport | -t` + +The transport protocol to use for publishing. Valid options are `rest` or `realtime`. The default value is `realtime`. + +### `--wait-for-subscribers` + +Wait for subscribers to connect before publishing. The default value is `false`. + +### `--client-id` + +The client ID to use for the benchmark. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Run a basic publisher benchmark: + + +```shell +ably bench publisher my-channel +``` + + +Run a benchmark with custom message count and rate: + + +```shell +ably bench publisher my-channel --messages 5000 --rate 20 +``` + + +Run a benchmark using the REST transport: + + +```shell +ably bench publisher my-channel --transport rest +``` + diff --git a/src/pages/docs/cli/bench/subscriber.mdx b/src/pages/docs/cli/bench/subscriber.mdx new file mode 100644 index 0000000000..9fabde774f --- /dev/null +++ b/src/pages/docs/cli/bench/subscriber.mdx @@ -0,0 +1,51 @@ +--- +title: "ably bench subscriber" +meta_description: "Run a subscriber benchmark test using the Ably CLI." +meta_keywords: "ably cli, cli, bench, subscriber, benchmark, performance, ably bench subscriber" +--- + + +```shell +ably bench subscriber [flags] +``` + + +Use the `ably bench subscriber` command to run a subscriber benchmark test on an Ably channel. + +## Arguments + +Pass the following arguments to the `ably bench subscriber` command: + +### `` + +The name of the channel to subscribe to. This argument is required. + +## Flags + +You can optionally pass the following flags to the `ably bench subscriber` command: + +### `--duration | -D` + +The duration of the subscriber benchmark in seconds. + +### `--client-id` + +The client ID to use for the benchmark. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Run a basic subscriber benchmark: + + +```shell +ably bench subscriber my-channel +``` + diff --git a/src/pages/docs/cli/channels/annotations/delete.mdx b/src/pages/docs/cli/channels/annotations/delete.mdx new file mode 100644 index 0000000000..4260bc20d9 --- /dev/null +++ b/src/pages/docs/cli/channels/annotations/delete.mdx @@ -0,0 +1,67 @@ +--- +title: "ably channels annotations delete" +meta_description: "Delete an annotation from an Ably Pub/Sub channel message using the CLI." +meta_keywords: "ably cli, cli, channels, annotations, delete, reactions, ably channels annotations delete" +--- + + +```shell +ably channels annotations delete [flags] +``` + + +Use the `ably channels annotations delete` command to delete an annotation from a channel message. + +## Arguments + +Pass the following arguments to the `ably channels annotations delete` command: + +### `` + +The name of the channel containing the message. + +### `` + +The serial of the message to delete the annotation from. + +### `` + +The annotation type to delete. + +## Flags + +You can optionally pass the following flags to the `ably channels annotations delete` command: + +### `--name | -n` + +The annotation name to delete. Use this to target a specific annotation when multiple annotations of the same type exist. + +### `--client-id` + +A client ID to use when deleting the annotation. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Delete a receipt annotation: + + +```shell +ably channels annotations delete my-channel "01a2b3c4d5@1234567890000-0" "receipts:unique.v1" +``` + + +Delete a reaction by name: + + +```shell +ably channels annotations delete my-channel "01a2b3c4d5@1234567890000-0" "reactions:unique.v1" --name thumbsup +``` + diff --git a/src/pages/docs/cli/channels/annotations/get.mdx b/src/pages/docs/cli/channels/annotations/get.mdx new file mode 100644 index 0000000000..25e1a06608 --- /dev/null +++ b/src/pages/docs/cli/channels/annotations/get.mdx @@ -0,0 +1,59 @@ +--- +title: "ably channels annotations get" +meta_description: "Get annotations for an Ably Pub/Sub channel message using the CLI." +meta_keywords: "ably cli, cli, channels, annotations, get, reactions, ably channels annotations get" +--- + + +```shell +ably channels annotations get [flags] +``` + + +Use the `ably channels annotations get` command to get annotations for a channel message. + +## Arguments + +Pass the following arguments to the `ably channels annotations get` command: + +### `` + +The name of the channel containing the message. + +### `` + +The serial of the message to get annotations for. + +## Flags + +You can optionally pass the following flags to the `ably channels annotations get` command: + +### `--limit` + +The maximum number of annotations to return. Defaults to `100`. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Get annotations for a message: + + +```shell +ably channels annotations get my-channel "01a2b3c4d5@1234567890000-0" +``` + + +Get annotations with a limit: + + +```shell +ably channels annotations get my-channel "01a2b3c4d5@1234567890000-0" --limit 10 +``` + diff --git a/src/pages/docs/cli/channels/annotations/index.mdx b/src/pages/docs/cli/channels/annotations/index.mdx new file mode 100644 index 0000000000..2b48439126 --- /dev/null +++ b/src/pages/docs/cli/channels/annotations/index.mdx @@ -0,0 +1,16 @@ +--- +title: "ably channels annotations" +meta_description: "Manage annotations on Ably Pub/Sub channel messages using the CLI." +meta_keywords: "ably cli, cli, channels, annotations, reactions, metrics, ably channels annotations" +--- + +Use the `ably channels annotations` command group to manage annotations on Ably Pub/Sub channel messages. These commands enable you to publish, subscribe to, get, and delete annotations. + +## Subcommands + +| Command | Description | +| ------- | ----------- | +| [`ably channels annotations publish`](/docs/cli/channels/annotations/publish) | Publish an annotation on a channel message. | +| [`ably channels annotations subscribe`](/docs/cli/channels/annotations/subscribe) | Subscribe to annotations on a channel. | +| [`ably channels annotations get`](/docs/cli/channels/annotations/get) | Get annotations for a channel message. | +| [`ably channels annotations delete`](/docs/cli/channels/annotations/delete) | Delete an annotation from a channel message. | diff --git a/src/pages/docs/cli/channels/annotations/publish.mdx b/src/pages/docs/cli/channels/annotations/publish.mdx new file mode 100644 index 0000000000..3953256129 --- /dev/null +++ b/src/pages/docs/cli/channels/annotations/publish.mdx @@ -0,0 +1,87 @@ +--- +title: "ably channels annotations publish" +meta_description: "Publish an annotation on an Ably Pub/Sub channel message using the CLI." +meta_keywords: "ably cli, cli, channels, annotations, publish, reactions, ably channels annotations publish" +--- + + +```shell +ably channels annotations publish [flags] +``` + + +Use the `ably channels annotations publish` command to publish an annotation on a channel message. + +## Arguments + +Pass the following arguments to the `ably channels annotations publish` command: + +### `` + +The name of the channel containing the message. + +### `` + +The serial of the message to annotate. + +### `` + +The annotation type. For example, `reactions:unique.v1` or `metrics:total.v1`. + +## Flags + +You can optionally pass the following flags to the `ably channels annotations publish` command: + +### `--name | -n` + +The annotation name. For example, an emoji name such as `thumbsup`. + +### `--count` + +The count value for the annotation. Used with `multiple.v1` type annotations. + +### `--data` + +A JSON payload to include with the annotation. + +### `--encoding | -e` + +The encoding of the annotation data. + +### `--client-id` + +A client ID to use when publishing the annotation. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Publish a simple annotation: + + +```shell +ably channels annotations publish my-channel "01a2b3c4d5@1234567890000-0" "reactions:unique.v1" +``` + + +Publish a reaction with a name: + + +```shell +ably channels annotations publish my-channel "01a2b3c4d5@1234567890000-0" "reactions:unique.v1" --name thumbsup +``` + + +Publish an annotation with a count: + + +```shell +ably channels annotations publish my-channel "01a2b3c4d5@1234567890000-0" "metrics:multiple.v1" --name views --count 5 +``` + diff --git a/src/pages/docs/cli/channels/annotations/subscribe.mdx b/src/pages/docs/cli/channels/annotations/subscribe.mdx new file mode 100644 index 0000000000..eccd1f8d84 --- /dev/null +++ b/src/pages/docs/cli/channels/annotations/subscribe.mdx @@ -0,0 +1,75 @@ +--- +title: "ably channels annotations subscribe" +meta_description: "Subscribe to annotations on an Ably Pub/Sub channel using the CLI." +meta_keywords: "ably cli, cli, channels, annotations, subscribe, reactions, ably channels annotations subscribe" +--- + + +```shell +ably channels annotations subscribe [flags] +``` + + +Use the `ably channels annotations subscribe` command to subscribe to annotations on an Ably Pub/Sub channel. + +## Arguments + +Pass the following arguments to the `ably channels annotations subscribe` command: + +### `` + +The name of the channel to subscribe to annotations on. + +## Flags + +You can optionally pass the following flags to the `ably channels annotations subscribe` command: + +### `--type` + +Filter annotations by type. + +### `--duration | -D` + +The duration in seconds to subscribe for before automatically unsubscribing. + +### `--rewind` + +The number of annotations to rewind when subscribing. Defaults to `0`. + +### `--client-id` + +A client ID to use when subscribing. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Subscribe to all annotations on a channel: + + +```shell +ably channels annotations subscribe my-channel +``` + + +Subscribe to annotations filtered by type: + + +```shell +ably channels annotations subscribe my-channel --type "reactions:unique.v1" +``` + + +Subscribe for a specific duration: + + +```shell +ably channels annotations subscribe my-channel --duration 60 +``` + diff --git a/src/pages/docs/cli/channels/append.mdx b/src/pages/docs/cli/channels/append.mdx new file mode 100644 index 0000000000..8821c524af --- /dev/null +++ b/src/pages/docs/cli/channels/append.mdx @@ -0,0 +1,83 @@ +--- +title: "ably channels append" +meta_description: "Append data to a message on an Ably Pub/Sub channel using the CLI." +meta_keywords: "ably cli, cli, channels, append, message, pub/sub, ably channels append" +--- + + +```shell +ably channels append [flags] +``` + + +Use the `ably channels append` command to append data to a message on an Ably Pub/Sub channel. + +## Arguments + +Pass the following arguments to the `ably channels append` command: + +### `` + +The name of the channel containing the message. + +### `` + +The serial of the message to append data to. + +### `` + +The data to append. This can be plain text or JSON. + +## Flags + +You can optionally pass the following flags to the `ably channels append` command: + +### `--description` + +A description for the appended data. + +### `--encoding | -e` + +The encoding of the message, such as `json/utf-8`. + +### `--name | -n` + +The event name for the appended message. + +### `--client-id` + +A client ID to use when appending the message. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Append data to a message: + + +```shell +ably channels append my-channel "01a2b3c4d5@1234567890000-0" '{"extra": "data"}' +``` + + +Append with an event name: + + +```shell +ably channels append my-channel "01a2b3c4d5@1234567890000-0" "additional info" --name update +``` + + +Append with a description: + + +```shell +ably channels append my-channel "01a2b3c4d5@1234567890000-0" '{"note": "correction"}' --description "Added correction" +``` + diff --git a/src/pages/docs/cli/channels/batch-publish.mdx b/src/pages/docs/cli/channels/batch-publish.mdx new file mode 100644 index 0000000000..859d052d33 --- /dev/null +++ b/src/pages/docs/cli/channels/batch-publish.mdx @@ -0,0 +1,79 @@ +--- +title: "ably channels batch-publish" +meta_description: "Publish a message to multiple Ably Pub/Sub channels at once using the CLI." +meta_keywords: "ably cli, cli, channels, batch-publish, batch, publish, pub/sub, ably channels batch-publish" +--- + + +```shell +ably channels batch-publish [message] [flags] +``` + + +Use the `ably channels batch-publish` command to publish a message to multiple Ably Pub/Sub channels at once. + +## Arguments + +Pass the following arguments to the `ably channels batch-publish` command: + +### `[message]` + +The message to publish. This is optional when using the `--spec` flag. + +## Flags + +You can optionally pass the following flags to the `ably channels batch-publish` command: + +### `--channels` + +A comma-separated list of channel names to publish to. This flag is mutually exclusive with `--channels-json` and `--spec`. + +### `--channels-json` + +A JSON array of channel names to publish to. This flag is mutually exclusive with `--channels` and `--spec`. + +### `--spec` + +A complete batch spec as a JSON string. This flag is mutually exclusive with `--channels` and `--channels-json`. + +### `--encoding | -e` + +The encoding of the message, such as `json/utf-8`. + +### `--name | -n` + +The event name for the message. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Publish to multiple channels: + + +```shell +ably channels batch-publish "Hello, everyone!" --channels "channel-1,channel-2,channel-3" +``` + + +Publish using a JSON array of channels: + + +```shell +ably channels batch-publish "Hello!" --channels-json '["channel-1", "channel-2"]' +``` + + +Publish using a complete batch spec: + + +```shell +ably channels batch-publish --spec '{"channels": ["channel-1", "channel-2"], "messages": [{"data": "Hello!"}]}' +``` + diff --git a/src/pages/docs/cli/channels/delete.mdx b/src/pages/docs/cli/channels/delete.mdx new file mode 100644 index 0000000000..306ea4da62 --- /dev/null +++ b/src/pages/docs/cli/channels/delete.mdx @@ -0,0 +1,63 @@ +--- +title: "ably channels delete" +meta_description: "Delete a message on an Ably Pub/Sub channel using the CLI." +meta_keywords: "ably cli, cli, channels, delete, message, pub/sub, ably channels delete" +--- + + +```shell +ably channels delete [flags] +``` + + +Use the `ably channels delete` command to delete a message on an Ably Pub/Sub channel. + +## Arguments + +Pass the following arguments to the `ably channels delete` command: + +### `` + +The name of the channel containing the message. + +### `` + +The serial of the message to delete. + +## Flags + +You can optionally pass the following flags to the `ably channels delete` command: + +### `--description` + +A description for the deletion. + +### `--client-id` + +A client ID to use when deleting the message. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Delete a message: + + +```shell +ably channels delete my-channel "01a2b3c4d5@1234567890000-0" +``` + + +Delete a message with a description: + + +```shell +ably channels delete my-channel "01a2b3c4d5@1234567890000-0" --description "Removed inappropriate content" +``` + diff --git a/src/pages/docs/cli/channels/history.mdx b/src/pages/docs/cli/channels/history.mdx new file mode 100644 index 0000000000..892c8ff9a7 --- /dev/null +++ b/src/pages/docs/cli/channels/history.mdx @@ -0,0 +1,87 @@ +--- +title: "ably channels history" +meta_description: "Retrieve message history for an Ably Pub/Sub channel using the CLI." +meta_keywords: "ably cli, cli, channels, history, messages, pub/sub, ably channels history" +--- + + +```shell +ably channels history [flags] +``` + + +Use the `ably channels history` command to retrieve message history for an Ably Pub/Sub channel. + +## Arguments + +Pass the following arguments to the `ably channels history` command: + +### `` + +The name of the channel to retrieve history for. + +## Flags + +You can optionally pass the following flags to the `ably channels history` command: + +### `--cipher` + +A decryption key to use for decrypting messages in the history. + +### `--direction` + +The direction to retrieve messages in. Options are `backwards` or `forwards`. Defaults to `backwards`. + +### `--start` + +The start of the time range to retrieve messages from. Accepts ISO 8601, Unix milliseconds, or relative time formats. + +### `--end` + +The end of the time range to retrieve messages from. Accepts ISO 8601, Unix milliseconds, or relative time formats. + +### `--limit` + +The maximum number of messages to retrieve. Defaults to `50`. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Retrieve message history for a channel: + + +```shell +ably channels history my-channel +``` + + +Retrieve history within a time range: + + +```shell +ably channels history my-channel --start "2025-01-01T00:00:00Z" --end "2025-01-02T00:00:00Z" +``` + + +Retrieve a limited number of messages: + + +```shell +ably channels history my-channel --limit 10 +``` + + +Retrieve history in forwards direction: + + +```shell +ably channels history my-channel --direction forwards +``` + diff --git a/src/pages/docs/cli/channels/index.mdx b/src/pages/docs/cli/channels/index.mdx new file mode 100644 index 0000000000..0d25f8e796 --- /dev/null +++ b/src/pages/docs/cli/channels/index.mdx @@ -0,0 +1,53 @@ +--- +title: "ably channels" +meta_description: "Interact with Ably Pub/Sub channels using the CLI." +meta_keywords: "ably cli, cli, channels, pub/sub, publish, subscribe, presence, occupancy, ably channels" +--- + +Use the `ably channels` command group to interact with Ably Pub/Sub channels. These commands enable you to publish and subscribe to messages, manage presence, monitor occupancy, and work with annotations. + +## Publishing and subscribing + +| Command | Description | +| ------- | ----------- | +| [`ably channels subscribe`](/docs/cli/channels/subscribe) | Subscribe to messages on one or more channels. | +| [`ably channels publish`](/docs/cli/channels/publish) | Publish a message to a channel. | +| [`ably channels batch-publish`](/docs/cli/channels/batch-publish) | Publish a message to multiple channels at once. | +| [`ably channels history`](/docs/cli/channels/history) | Retrieve message history for a channel. | +| [`ably channels append`](/docs/cli/channels/append) | Append data to a message on a channel. | +| [`ably channels update`](/docs/cli/channels/update) | Update a message on a channel. | +| [`ably channels delete`](/docs/cli/channels/delete) | Delete a message on a channel. | + +## Annotations + +| Command | Description | +| ------- | ----------- | +| [`ably channels annotations`](/docs/cli/channels/annotations) | Manage annotations on channel messages. | +| [`ably channels annotations publish`](/docs/cli/channels/annotations/publish) | Publish an annotation on a channel message. | +| [`ably channels annotations subscribe`](/docs/cli/channels/annotations/subscribe) | Subscribe to annotations on a channel. | +| [`ably channels annotations get`](/docs/cli/channels/annotations/get) | Get annotations for a channel message. | +| [`ably channels annotations delete`](/docs/cli/channels/annotations/delete) | Delete an annotation from a channel message. | + +## Presence + +| Command | Description | +| ------- | ----------- | +| [`ably channels presence`](/docs/cli/channels/presence) | Manage presence on channels. | +| [`ably channels presence enter`](/docs/cli/channels/presence/enter) | Enter presence on a channel. | +| [`ably channels presence get`](/docs/cli/channels/presence/get) | Get current presence members on a channel. | +| [`ably channels presence subscribe`](/docs/cli/channels/presence/subscribe) | Subscribe to presence events on a channel. | + +## Occupancy + +| Command | Description | +| ------- | ----------- | +| [`ably channels occupancy`](/docs/cli/channels/occupancy) | Monitor channel occupancy. | +| [`ably channels occupancy get`](/docs/cli/channels/occupancy/get) | Get current occupancy for a channel. | +| [`ably channels occupancy subscribe`](/docs/cli/channels/occupancy/subscribe) | Subscribe to occupancy updates on a channel. | + +## Channel management + +| Command | Description | +| ------- | ----------- | +| [`ably channels list`](/docs/cli/channels/list) | List active channels. | +| [`ably channels inspect`](/docs/cli/channels/inspect) | Open the Ably dashboard to inspect a channel. | diff --git a/src/pages/docs/cli/channels/inspect.mdx b/src/pages/docs/cli/channels/inspect.mdx new file mode 100644 index 0000000000..adc87181d9 --- /dev/null +++ b/src/pages/docs/cli/channels/inspect.mdx @@ -0,0 +1,47 @@ +--- +title: "ably channels inspect" +meta_description: "Open the Ably dashboard to inspect a specific channel using the CLI." +meta_keywords: "ably cli, cli, channels, inspect, dashboard, pub/sub, ably channels inspect" +--- + + +```shell +ably channels inspect [flags] +``` + + +Use the `ably channels inspect` command to open the Ably dashboard to inspect a specific channel. + +## Arguments + +Pass the following arguments to the `ably channels inspect` command: + +### `` + +The name of the channel to inspect. + +## Flags + +You can optionally pass the following flags to the `ably channels inspect` command: + +### `--app` + +The app ID or name to inspect the channel for. Overrides the currently selected app. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Inspect a channel in the Ably dashboard: + + +```shell +ably channels inspect my-channel +``` + diff --git a/src/pages/docs/cli/channels/list.mdx b/src/pages/docs/cli/channels/list.mdx new file mode 100644 index 0000000000..6c8fb972ab --- /dev/null +++ b/src/pages/docs/cli/channels/list.mdx @@ -0,0 +1,59 @@ +--- +title: "ably channels list" +meta_description: "List active channels using the Ably CLI." +meta_keywords: "ably cli, cli, channels, list, active channels, enumeration, ably channels list" +--- + + +```shell +ably channels list [flags] +``` + + +Use the `ably channels list` command to list active channels using the channel enumeration API. + +## Flags + +You can optionally pass the following flags to the `ably channels list` command: + +### `--limit` + +The maximum number of channels to return. Defaults to `100`. + +### `--prefix | -p` + +Filter channels by a name prefix. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +List all active channels: + + +```shell +ably channels list +``` + + +List channels with a specific prefix: + + +```shell +ably channels list --prefix "chat:" +``` + + +List channels with a limit: + + +```shell +ably channels list --limit 10 +``` + diff --git a/src/pages/docs/cli/channels/occupancy/get.mdx b/src/pages/docs/cli/channels/occupancy/get.mdx new file mode 100644 index 0000000000..e0198987e6 --- /dev/null +++ b/src/pages/docs/cli/channels/occupancy/get.mdx @@ -0,0 +1,51 @@ +--- +title: "ably channels occupancy get" +meta_description: "Get current occupancy for an Ably Pub/Sub channel using the CLI." +meta_keywords: "ably cli, cli, channels, occupancy, get, connections, subscribers, ably channels occupancy get" +--- + + +```shell +ably channels occupancy get [flags] +``` + + +Use the `ably channels occupancy get` command to get the current occupancy for an Ably Pub/Sub channel. + +## Arguments + +Pass the following arguments to the `ably channels occupancy get` command: + +### `` + +The name of the channel to get occupancy for. + +## Flags + +You can optionally pass the following flags to the `ably channels occupancy get` command: + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Get the current occupancy for a channel: + + +```shell +ably channels occupancy get my-channel +``` + + +Get occupancy in JSON format: + + +```shell +ably channels occupancy get my-channel --json +``` + diff --git a/src/pages/docs/cli/channels/occupancy/index.mdx b/src/pages/docs/cli/channels/occupancy/index.mdx new file mode 100644 index 0000000000..9fe90bbce0 --- /dev/null +++ b/src/pages/docs/cli/channels/occupancy/index.mdx @@ -0,0 +1,14 @@ +--- +title: "ably channels occupancy" +meta_description: "Monitor channel occupancy using the Ably CLI." +meta_keywords: "ably cli, cli, channels, occupancy, connections, subscribers, ably channels occupancy" +--- + +Use the `ably channels occupancy` command group to monitor occupancy on Ably Pub/Sub channels. + +## Subcommands + +| Command | Description | +| ------- | ----------- | +| [`ably channels occupancy get`](/docs/cli/channels/occupancy/get) | Get current occupancy for a channel. | +| [`ably channels occupancy subscribe`](/docs/cli/channels/occupancy/subscribe) | Subscribe to occupancy updates on a channel. | diff --git a/src/pages/docs/cli/channels/occupancy/subscribe.mdx b/src/pages/docs/cli/channels/occupancy/subscribe.mdx new file mode 100644 index 0000000000..bd5c1ed3d7 --- /dev/null +++ b/src/pages/docs/cli/channels/occupancy/subscribe.mdx @@ -0,0 +1,59 @@ +--- +title: "ably channels occupancy subscribe" +meta_description: "Subscribe to occupancy updates on an Ably Pub/Sub channel using the CLI." +meta_keywords: "ably cli, cli, channels, occupancy, subscribe, connections, subscribers, ably channels occupancy subscribe" +--- + + +```shell +ably channels occupancy subscribe [flags] +``` + + +Use the `ably channels occupancy subscribe` command to subscribe to occupancy updates on an Ably Pub/Sub channel. + +## Arguments + +Pass the following arguments to the `ably channels occupancy subscribe` command: + +### `` + +The name of the channel to subscribe to occupancy updates on. + +## Flags + +You can optionally pass the following flags to the `ably channels occupancy subscribe` command: + +### `--duration | -D` + +The duration in seconds to subscribe for before automatically unsubscribing. + +### `--client-id` + +A client ID to use when subscribing. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Subscribe to occupancy updates: + + +```shell +ably channels occupancy subscribe my-channel +``` + + +Subscribe for a specific duration: + + +```shell +ably channels occupancy subscribe my-channel --duration 60 +``` + diff --git a/src/pages/docs/cli/channels/presence/enter.mdx b/src/pages/docs/cli/channels/presence/enter.mdx new file mode 100644 index 0000000000..811f3842e6 --- /dev/null +++ b/src/pages/docs/cli/channels/presence/enter.mdx @@ -0,0 +1,79 @@ +--- +title: "ably channels presence enter" +meta_description: "Enter presence on an Ably Pub/Sub channel using the CLI." +meta_keywords: "ably cli, cli, channels, presence, enter, members, ably channels presence enter" +--- + + +```shell +ably channels presence enter [flags] +``` + + +Use the `ably channels presence enter` command to enter presence on a channel and remain present until terminated. + +## Arguments + +Pass the following arguments to the `ably channels presence enter` command: + +### `` + +The name of the channel to enter presence on. + +## Flags + +You can optionally pass the following flags to the `ably channels presence enter` command: + +### `--data` + +JSON data to associate with the presence member. + +### `--show-others` + +Display presence events from other members on the channel. Defaults to `false`. + +### `--sequence-numbers` + +Display sequence numbers for presence events. Defaults to `false`. + +### `--duration | -D` + +The duration in seconds to remain present before automatically leaving. + +### `--client-id` + +A client ID to use when entering presence. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Enter presence on a channel: + + +```shell +ably channels presence enter my-channel +``` + + +Enter presence with data: + + +```shell +ably channels presence enter my-channel --data '{"status": "online"}' +``` + + +Enter presence and show other members' events: + + +```shell +ably channels presence enter my-channel --show-others +``` + diff --git a/src/pages/docs/cli/channels/presence/get.mdx b/src/pages/docs/cli/channels/presence/get.mdx new file mode 100644 index 0000000000..3ad007baf0 --- /dev/null +++ b/src/pages/docs/cli/channels/presence/get.mdx @@ -0,0 +1,55 @@ +--- +title: "ably channels presence get" +meta_description: "Get all current presence members on an Ably Pub/Sub channel using the CLI." +meta_keywords: "ably cli, cli, channels, presence, get, members, ably channels presence get" +--- + + +```shell +ably channels presence get [flags] +``` + + +Use the `ably channels presence get` command to get all current presence members on a channel. + +## Arguments + +Pass the following arguments to the `ably channels presence get` command: + +### `` + +The name of the channel to get presence members for. + +## Flags + +You can optionally pass the following flags to the `ably channels presence get` command: + +### `--limit` + +The maximum number of presence members to return. Defaults to `100`. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Get all presence members on a channel: + + +```shell +ably channels presence get my-channel +``` + + +Get presence members with a limit: + + +```shell +ably channels presence get my-channel --limit 10 +``` + diff --git a/src/pages/docs/cli/channels/presence/index.mdx b/src/pages/docs/cli/channels/presence/index.mdx new file mode 100644 index 0000000000..4550033c6a --- /dev/null +++ b/src/pages/docs/cli/channels/presence/index.mdx @@ -0,0 +1,15 @@ +--- +title: "ably channels presence" +meta_description: "Manage presence on Ably Pub/Sub channels using the CLI." +meta_keywords: "ably cli, cli, channels, presence, members, ably channels presence" +--- + +Use the `ably channels presence` command group to manage presence on Ably Pub/Sub channels. + +## Subcommands + +| Command | Description | +| ------- | ----------- | +| [`ably channels presence enter`](/docs/cli/channels/presence/enter) | Enter presence on a channel. | +| [`ably channels presence get`](/docs/cli/channels/presence/get) | Get current presence members on a channel. | +| [`ably channels presence subscribe`](/docs/cli/channels/presence/subscribe) | Subscribe to presence events on a channel. | diff --git a/src/pages/docs/cli/channels/presence/subscribe.mdx b/src/pages/docs/cli/channels/presence/subscribe.mdx new file mode 100644 index 0000000000..97d43d9463 --- /dev/null +++ b/src/pages/docs/cli/channels/presence/subscribe.mdx @@ -0,0 +1,59 @@ +--- +title: "ably channels presence subscribe" +meta_description: "Subscribe to presence events on an Ably Pub/Sub channel using the CLI." +meta_keywords: "ably cli, cli, channels, presence, subscribe, events, members, ably channels presence subscribe" +--- + + +```shell +ably channels presence subscribe [flags] +``` + + +Use the `ably channels presence subscribe` command to subscribe to presence events on a channel. + +## Arguments + +Pass the following arguments to the `ably channels presence subscribe` command: + +### `` + +The name of the channel to subscribe to presence events on. + +## Flags + +You can optionally pass the following flags to the `ably channels presence subscribe` command: + +### `--duration | -D` + +The duration in seconds to subscribe for before automatically unsubscribing. + +### `--client-id` + +A client ID to use when subscribing. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Subscribe to presence events: + + +```shell +ably channels presence subscribe my-channel +``` + + +Subscribe for a specific duration: + + +```shell +ably channels presence subscribe my-channel --duration 60 +``` + diff --git a/src/pages/docs/cli/channels/publish.mdx b/src/pages/docs/cli/channels/publish.mdx new file mode 100644 index 0000000000..64eedc6ccc --- /dev/null +++ b/src/pages/docs/cli/channels/publish.mdx @@ -0,0 +1,103 @@ +--- +title: "ably channels publish" +meta_description: "Publish a message to an Ably Pub/Sub channel using the CLI." +meta_keywords: "ably cli, cli, channels, publish, message, pub/sub, ably channels publish" +--- + + +```shell +ably channels publish [flags] +``` + + +Use the `ably channels publish` command to publish a message to an Ably Pub/Sub channel. + +## Arguments + +Pass the following arguments to the `ably channels publish` command: + +### `` + +The name of the channel to publish to. + +### `` + +The message to publish. This can be plain text or JSON. Supports `{{.Count}}` and `{{.Timestamp}}` interpolation when publishing multiple messages. + +## Flags + +You can optionally pass the following flags to the `ably channels publish` command: + +### `--count | -c` + +The number of messages to publish. Defaults to `1`. + +### `--delay | -d` + +The delay between messages in milliseconds when publishing multiple messages. Defaults to `40`. + +### `--encoding | -e` + +The encoding of the message, such as `json/utf-8`. + +### `--name | -n` + +The event name for the message. + +### `--transport` + +The transport to use for publishing. Options are `rest` or `realtime`. + +### `--client-id` + +A client ID to use when publishing the message. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Publish a plain text message: + + +```shell +ably channels publish my-channel "Hello, world!" +``` + + +Publish a JSON message: + + +```shell +ably channels publish my-channel '{"key": "value"}' +``` + + +Publish multiple messages with interpolation: + + +```shell +ably channels publish my-channel "Message {{.Count}} at {{.Timestamp}}" --count 10 +``` + + +Publish with an event name: + + +```shell +ably channels publish my-channel "Hello" --name greeting +``` + + +Publish using the realtime transport: + + +```shell +ably channels publish my-channel "Hello" --transport realtime +``` + diff --git a/src/pages/docs/cli/channels/subscribe.mdx b/src/pages/docs/cli/channels/subscribe.mdx new file mode 100644 index 0000000000..008aea9e4f --- /dev/null +++ b/src/pages/docs/cli/channels/subscribe.mdx @@ -0,0 +1,99 @@ +--- +title: "ably channels subscribe" +meta_description: "Subscribe to messages on one or more Ably Pub/Sub channels using the CLI." +meta_keywords: "ably cli, cli, channels, subscribe, messages, pub/sub, ably channels subscribe" +--- + + +```shell +ably channels subscribe [flags] +``` + + +Use the `ably channels subscribe` command to subscribe to messages on one or more Ably Pub/Sub channels. + +## Arguments + +Pass the following arguments to the `ably channels subscribe` command: + +### `` + +One or more channel names to subscribe to. + +## Flags + +You can optionally pass the following flags to the `ably channels subscribe` command: + +### `--cipher` + +A decryption key to use for decrypting messages on the channel. + +### `--delta` + +Enable delta compression for messages. Defaults to `false`. + +### `--sequence-numbers` + +Display sequence numbers for messages. Defaults to `false`. + +### `--duration | -D` + +The duration in seconds to subscribe for before automatically unsubscribing. + +### `--rewind` + +The number of messages to rewind when subscribing. Defaults to `0`. + +### `--client-id` + +A client ID to use when subscribing. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Subscribe to a single channel: + + +```shell +ably channels subscribe my-channel +``` + + +Subscribe to multiple channels: + + +```shell +ably channels subscribe my-channel another-channel +``` + + +Subscribe for a specific duration: + + +```shell +ably channels subscribe my-channel --duration 60 +``` + + +Subscribe with rewind to receive recent messages: + + +```shell +ably channels subscribe my-channel --rewind 10 +``` + + +Subscribe with a cipher key for encrypted messages: + + +```shell +ably channels subscribe my-channel --cipher "my-secret-key" +``` + diff --git a/src/pages/docs/cli/channels/update.mdx b/src/pages/docs/cli/channels/update.mdx new file mode 100644 index 0000000000..3fe59ce798 --- /dev/null +++ b/src/pages/docs/cli/channels/update.mdx @@ -0,0 +1,75 @@ +--- +title: "ably channels update" +meta_description: "Update a message on an Ably Pub/Sub channel using the CLI." +meta_keywords: "ably cli, cli, channels, update, message, pub/sub, ably channels update" +--- + + +```shell +ably channels update [flags] +``` + + +Use the `ably channels update` command to update a message on an Ably Pub/Sub channel. + +## Arguments + +Pass the following arguments to the `ably channels update` command: + +### `` + +The name of the channel containing the message. + +### `` + +The serial of the message to update. + +### `` + +The new message content. This can be plain text or JSON. + +## Flags + +You can optionally pass the following flags to the `ably channels update` command: + +### `--description` + +A description for the update. + +### `--encoding | -e` + +The encoding of the message, such as `json/utf-8`. + +### `--name | -n` + +The event name for the updated message. + +### `--client-id` + +A client ID to use when updating the message. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Update a message: + + +```shell +ably channels update my-channel "01a2b3c4d5@1234567890000-0" "Updated message content" +``` + + +Update a message with a description: + + +```shell +ably channels update my-channel "01a2b3c4d5@1234567890000-0" '{"key": "new-value"}' --description "Fixed typo" +``` + diff --git a/src/pages/docs/cli/config/index.mdx b/src/pages/docs/cli/config/index.mdx new file mode 100644 index 0000000000..cac7bc1f7b --- /dev/null +++ b/src/pages/docs/cli/config/index.mdx @@ -0,0 +1,14 @@ +--- +title: "ably config" +meta_description: "Manage Ably CLI configuration." +meta_keywords: "ably cli, cli, config, configuration, ably config" +--- + +Use the `ably config` command group to manage your Ably CLI configuration. These commands enable you to view and locate the CLI configuration file. + +## Subcommands + +| Command | Description | +| ------- | ----------- | +| [`ably config path`](/docs/cli/config/path) | Print the path to the Ably CLI config file. | +| [`ably config show`](/docs/cli/config/show) | Display the contents of the Ably CLI config file. | diff --git a/src/pages/docs/cli/config/path.mdx b/src/pages/docs/cli/config/path.mdx new file mode 100644 index 0000000000..39ae40b6f9 --- /dev/null +++ b/src/pages/docs/cli/config/path.mdx @@ -0,0 +1,31 @@ +--- +title: "ably config path" +meta_description: "Print the path to the Ably CLI config file." +meta_keywords: "ably cli, cli, config, path, configuration file, ably config path" +--- + + +```shell +ably config path +``` + + +Use the `ably config path` command to print the path to the Ably CLI config file. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Print the config file path: + + +```shell +ably config path +``` + diff --git a/src/pages/docs/cli/config/show.mdx b/src/pages/docs/cli/config/show.mdx new file mode 100644 index 0000000000..80e70734a5 --- /dev/null +++ b/src/pages/docs/cli/config/show.mdx @@ -0,0 +1,39 @@ +--- +title: "ably config show" +meta_description: "Display the contents of the Ably CLI config file." +meta_keywords: "ably cli, cli, config, show, configuration, ably config show" +--- + + +```shell +ably config show +``` + + +Use the `ably config show` command to display the contents of the Ably CLI config file. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Display the config file contents: + + +```shell +ably config show +``` + + +Display the config file contents in JSON format: + + +```shell +ably config show --json +``` + diff --git a/src/pages/docs/cli/connections/index.mdx b/src/pages/docs/cli/connections/index.mdx new file mode 100644 index 0000000000..2c2d1b64ae --- /dev/null +++ b/src/pages/docs/cli/connections/index.mdx @@ -0,0 +1,13 @@ +--- +title: "ably connections" +meta_description: "Test connections to Ably." +meta_keywords: "ably cli, cli, connections, test, connectivity, ably connections" +--- + +Use the `ably connections` command group to test connections to Ably. These commands enable you to verify connectivity using different transport protocols. + +## Subcommands + +| Command | Description | +| ------- | ----------- | +| [`ably connections test`](/docs/cli/connections/test) | Test connection to Ably. | diff --git a/src/pages/docs/cli/connections/test.mdx b/src/pages/docs/cli/connections/test.mdx new file mode 100644 index 0000000000..e71b8a8b3d --- /dev/null +++ b/src/pages/docs/cli/connections/test.mdx @@ -0,0 +1,59 @@ +--- +title: "ably connections test" +meta_description: "Test connection to Ably." +meta_keywords: "ably cli, cli, connections, test, connectivity, transport, ably connections test" +--- + + +```shell +ably connections test [flags] +``` + + +Use the `ably connections test` command to test your connection to Ably using different transport protocols. + +## Flags + +You can optionally pass the following flags to the `ably connections test` command: + +### `--transport` + +The transport protocol to test. Valid options are `ws` (WebSocket), `xhr` (HTTP), or `all`. The default value is `all`. + +### `--client-id` + +The client ID to use for the connection test. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Test all transport protocols: + + +```shell +ably connections test +``` + + +Test WebSocket connectivity only: + + +```shell +ably connections test --transport ws +``` + + +Test HTTP connectivity only: + + +```shell +ably connections test --transport xhr +``` + diff --git a/src/pages/docs/cli/help.mdx b/src/pages/docs/cli/help.mdx new file mode 100644 index 0000000000..30f282fcfe --- /dev/null +++ b/src/pages/docs/cli/help.mdx @@ -0,0 +1,49 @@ +--- +title: "ably help" +meta_description: "Display help information for Ably CLI commands." +meta_keywords: "ably cli, cli, help, command help, ably help" +--- + + +```shell +ably help [command] +``` + + +Use the `ably help` command to display help information for Ably CLI commands. When run without arguments, it shows the main help with all available command groups. When run with a specific command, it shows detailed help for that command. + +## Arguments + +Pass the following arguments to the `ably help` command: + +### `[command]` + +The command to display help for, for example: `ably help channels publish`. + +If no command is specified, the main help with all available command groups is displayed. + +## Examples + +Display the main help: + + +```shell +ably help +``` + + +Display help for a specific command: + + +```shell +ably help channels publish +``` + + +Display help for a command group: + + +```shell +ably help channels +``` + diff --git a/src/pages/docs/cli/index.mdx b/src/pages/docs/cli/index.mdx new file mode 100644 index 0000000000..8ab8477726 --- /dev/null +++ b/src/pages/docs/cli/index.mdx @@ -0,0 +1,90 @@ +--- +title: "Ably CLI" +meta_description: "Command-line interface for the Ably realtime messaging platform." +meta_keywords: "ably cli, cli, command line, realtime messaging, pub/sub, chat, spaces" +--- + +The Ably CLI provides a command-line interface for interacting with the Ably realtime messaging platform. Use it to manage your accounts, apps, channels, authentication, and more. + +## Installation + +Install the Ably CLI using npm: + + +```shell +npm install -g @ably/cli +``` + + +## Authentication + +Before using the CLI, authenticate with your Ably account: + + +```shell +ably login +``` + + +## Global flags + +The following global flags are available on most CLI commands: + +### `--json` + +Output results in JSON format. + +### `--pretty-json` + +Output results in colorized JSON format. + +### `--verbose | -v` + +Enable verbose logging. + +## Command groups + +### Account and app management + +| Command Group | Description | +| ------------- | ----------- | +| [`ably accounts`](/docs/cli/accounts) | Manage Ably accounts and configured access tokens | +| [`ably apps`](/docs/cli/apps) | Manage Ably applications | +| [`ably auth`](/docs/cli/auth) | Manage authentication, API keys, and tokens | + +### Realtime communication + +| Command Group | Description | +| ------------- | ----------- | +| [`ably channels`](/docs/cli/channels) | Interact with Ably Pub/Sub channels | +| [`ably rooms`](/docs/cli/rooms) | Interact with Ably Chat rooms | +| [`ably spaces`](/docs/cli/spaces) | Interact with Ably Spaces | + +### Infrastructure and monitoring + +| Command Group | Description | +| ------------- | ----------- | +| [`ably connections`](/docs/cli/connections) | Test connections to Ably | +| [`ably integrations`](/docs/cli/integrations) | Manage Ably integrations with external services | +| [`ably logs`](/docs/cli/logs) | Stream and retrieve logs from Ably | +| [`ably push`](/docs/cli/push) | Manage push notifications | +| [`ably queues`](/docs/cli/queues) | Manage Ably queues | +| [`ably stats`](/docs/cli/stats) | View account and app statistics | + +### Utilities and tools + +| Command Group | Description | +| ------------- | ----------- | +| [`ably bench`](/docs/cli/bench) | Performance benchmarking commands | +| [`ably config`](/docs/cli/config) | Manage CLI configuration | +| [`ably support`](/docs/cli/support) | Get support and help from Ably | + +## Standalone commands + +| Command | Description | +| ------- | ----------- | +| [`ably help`](/docs/cli/help) | Display help for Ably CLI commands | +| [`ably interactive`](/docs/cli/interactive) | Launch interactive Ably shell | +| [`ably login`](/docs/cli/login) | Log in to your Ably account | +| [`ably status`](/docs/cli/status) | Check the status of Ably services | +| [`ably version`](/docs/cli/version) | Display the CLI version | diff --git a/src/pages/docs/cli/integrations/create.mdx b/src/pages/docs/cli/integrations/create.mdx new file mode 100644 index 0000000000..b0b3068499 --- /dev/null +++ b/src/pages/docs/cli/integrations/create.mdx @@ -0,0 +1,79 @@ +--- +title: "ably integrations create" +meta_description: "Create an integration rule using the Ably CLI." +meta_keywords: "ably cli, cli, integrations, create, rule, webhook, ably integrations create" +--- + + +```shell +ably integrations create --rule-type --source-type [flags] +``` + + +Use the `ably integrations create` command to create an integration rule for your Ably application. + +## Flags + +You can pass the following flags to the `ably integrations create` command: + +### `--rule-type` + +The type of integration rule to create. This flag is required. Valid options are `http`, `amqp`, `kinesis`, `firehose`, `pulsar`, `kafka`, `azure`, `azure-functions`, `mqtt`, or `cloudmqtt`. + +### `--source-type` + +The source type for the integration rule. This flag is required. Valid options are `channel.message`, `channel.presence`, `channel.lifecycle`, or `presence.message`. + +### `--app` + +The app ID to create the integration rule for. If not specified, the currently selected app is used. + +### `--channel-filter` + +A channel name filter to apply to the integration rule. + +### `--target-url` + +The target URL for the integration rule. This flag is required for `http` rule types. + +### `--request-mode` + +The request mode for the integration rule. Valid options are `single` or `batch`. The default value is `single`. + +### `--status` + +The initial status of the integration rule. Valid options are `enabled` or `disabled`. The default value is `enabled`. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Create an HTTP webhook integration: + + +```shell +ably integrations create --rule-type http --source-type channel.message --target-url https://example.com/webhook +``` + + +Create an AMQP integration with a channel filter: + + +```shell +ably integrations create --rule-type amqp --source-type channel.message --channel-filter "^notifications" +``` + + +Create a disabled integration rule: + + +```shell +ably integrations create --rule-type http --source-type channel.message --target-url https://example.com/webhook --status disabled +``` + diff --git a/src/pages/docs/cli/integrations/delete.mdx b/src/pages/docs/cli/integrations/delete.mdx new file mode 100644 index 0000000000..4c895bd382 --- /dev/null +++ b/src/pages/docs/cli/integrations/delete.mdx @@ -0,0 +1,59 @@ +--- +title: "ably integrations delete" +meta_description: "Delete an integration rule using the Ably CLI." +meta_keywords: "ably cli, cli, integrations, delete, rule, ably integrations delete" +--- + + +```shell +ably integrations delete [flags] +``` + + +Use the `ably integrations delete` command to delete an integration rule. + +## Arguments + +Pass the following arguments to the `ably integrations delete` command: + +### `` + +The ID of the integration rule to delete. This argument is required. + +## Flags + +You can optionally pass the following flags to the `ably integrations delete` command: + +### `--app` + +The app ID that the integration rule belongs to. If not specified, the currently selected app is used. + +### `--force | -f` + +Skip the confirmation prompt and delete the integration rule immediately. Required when using `--json`. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Delete an integration rule by ID: + + +```shell +ably integrations delete aBcDe1 +``` + + +Delete an integration rule without a confirmation prompt: + + +```shell +ably integrations delete aBcDe1 --force +``` + diff --git a/src/pages/docs/cli/integrations/get.mdx b/src/pages/docs/cli/integrations/get.mdx new file mode 100644 index 0000000000..2be17f1f1e --- /dev/null +++ b/src/pages/docs/cli/integrations/get.mdx @@ -0,0 +1,55 @@ +--- +title: "ably integrations get" +meta_description: "Get an integration rule by ID using the Ably CLI." +meta_keywords: "ably cli, cli, integrations, get, rule, ably integrations get" +--- + + +```shell +ably integrations get [flags] +``` + + +Use the `ably integrations get` command to retrieve the details of an integration rule by its ID. + +## Arguments + +Pass the following arguments to the `ably integrations get` command: + +### `` + +The ID of the integration rule to retrieve. This argument is required. + +## Flags + +You can optionally pass the following flags to the `ably integrations get` command: + +### `--app` + +The app ID that the integration rule belongs to. If not specified, the currently selected app is used. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Get an integration rule: + + +```shell +ably integrations get aBcDe1 +``` + + +Get an integration rule in JSON format: + + +```shell +ably integrations get aBcDe1 --json +``` + diff --git a/src/pages/docs/cli/integrations/index.mdx b/src/pages/docs/cli/integrations/index.mdx new file mode 100644 index 0000000000..8017416423 --- /dev/null +++ b/src/pages/docs/cli/integrations/index.mdx @@ -0,0 +1,17 @@ +--- +title: "ably integrations" +meta_description: "Manage Ably integrations with external services." +meta_keywords: "ably cli, cli, integrations, rules, webhooks, ably integrations" +--- + +Use the `ably integrations` command group to manage your Ably integrations with external services. These commands enable you to create, list, update, and delete integration rules. + +## Subcommands + +| Command | Description | +| ------- | ----------- | +| [`ably integrations create`](/docs/cli/integrations/create) | Create an integration rule. | +| [`ably integrations delete`](/docs/cli/integrations/delete) | Delete an integration rule. | +| [`ably integrations get`](/docs/cli/integrations/get) | Get an integration rule by ID. | +| [`ably integrations list`](/docs/cli/integrations/list) | List all integration rules. | +| [`ably integrations update`](/docs/cli/integrations/update) | Update an integration rule. | diff --git a/src/pages/docs/cli/integrations/list.mdx b/src/pages/docs/cli/integrations/list.mdx new file mode 100644 index 0000000000..2e6d3f9538 --- /dev/null +++ b/src/pages/docs/cli/integrations/list.mdx @@ -0,0 +1,51 @@ +--- +title: "ably integrations list" +meta_description: "List all integration rules using the Ably CLI." +meta_keywords: "ably cli, cli, integrations, list, rules, ably integrations list" +--- + + +```shell +ably integrations list [flags] +``` + + +Use the `ably integrations list` command to list all integration rules for an application. + +## Flags + +You can optionally pass the following flags to the `ably integrations list` command: + +### `--app` + +The app ID to list integration rules for. If not specified, the currently selected app is used. + +### `--limit` + +The maximum number of integration rules to return. The default value is `100`. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +List all integration rules: + + +```shell +ably integrations list +``` + + +List integration rules for a specific app: + + +```shell +ably integrations list --app aBcDe1 +``` + diff --git a/src/pages/docs/cli/integrations/update.mdx b/src/pages/docs/cli/integrations/update.mdx new file mode 100644 index 0000000000..beb161923a --- /dev/null +++ b/src/pages/docs/cli/integrations/update.mdx @@ -0,0 +1,87 @@ +--- +title: "ably integrations update" +meta_description: "Update an integration rule using the Ably CLI." +meta_keywords: "ably cli, cli, integrations, update, rule, ably integrations update" +--- + + +```shell +ably integrations update [flags] +``` + + +Use the `ably integrations update` command to update an existing integration rule. + +## Arguments + +Pass the following arguments to the `ably integrations update` command: + +### `` + +The ID of the integration rule to update. This argument is required. + +## Flags + +You can optionally pass the following flags to the `ably integrations update` command: + +### `--app` + +The app ID that the integration rule belongs to. If not specified, the currently selected app is used. + +### `--channel-filter` + +Update the channel name filter for the integration rule. + +### `--request-mode` + +Update the request mode for the integration rule. Valid options are `single` or `batch`. + +### `--source` + +Update the source type for the integration rule. + +### `--status` + +Update the status of the integration rule. Valid options are `enabled` or `disabled`. + +### `--target` + +Update the target configuration for the integration rule. + +### `--target-url` + +Update the target URL for the integration rule. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Disable an integration rule: + + +```shell +ably integrations update aBcDe1 --status disabled +``` + + +Update the channel filter for an integration rule: + + +```shell +ably integrations update aBcDe1 --channel-filter "^notifications" +``` + + +Update the target URL for an integration rule: + + +```shell +ably integrations update aBcDe1 --target-url https://example.com/new-webhook +``` + diff --git a/src/pages/docs/cli/interactive.mdx b/src/pages/docs/cli/interactive.mdx new file mode 100644 index 0000000000..629b4ec263 --- /dev/null +++ b/src/pages/docs/cli/interactive.mdx @@ -0,0 +1,35 @@ +--- +title: "ably interactive" +meta_description: "Launch an interactive Ably CLI shell." +meta_keywords: "ably cli, cli, interactive, shell, ably interactive" +--- + + +```shell +ably interactive +``` + + +Use the `ably interactive` command to launch an interactive shell for the Ably CLI. This provides a REPL-like experience where you can run Ably CLI commands without prefixing them with `ably`. + + + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Launch the interactive shell: + + +```shell +ably interactive +``` + diff --git a/src/pages/docs/cli/login.mdx b/src/pages/docs/cli/login.mdx new file mode 100644 index 0000000000..8a4bcaf8ea --- /dev/null +++ b/src/pages/docs/cli/login.mdx @@ -0,0 +1,65 @@ +--- +title: "ably login" +meta_description: "Log in to your Ably account using the CLI." +meta_keywords: "ably cli, cli, login, authentication, ably login" +--- + + +```shell +ably login [token] [flags] +``` + + +Use the `ably login` command to authenticate with your Ably account. + + + +## Arguments + +Pass the following arguments to the `ably login` command: + +### `[token]` + +The access token for your Ably account. + +If not provided, the CLI will prompt you to enter an access token, or open a browser window for you to obtain one from your Ably account. + +## Flags + +You can optionally pass the following flags to the `ably login` command: + +### `--alias | -a` + +An alias name for this account configuration. If not specified, this becomes the default account. + +### `--no-browser` + +Prevent the CLI from automatically opening a browser for authentication. Use this flag in headless environments. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Log in with interactive authentication: + + +```shell +ably login +``` + + +Log in with an alias for the account: + + +```shell +ably login --alias my-company +``` + diff --git a/src/pages/docs/cli/logs/channel-lifecycle/index.mdx b/src/pages/docs/cli/logs/channel-lifecycle/index.mdx new file mode 100644 index 0000000000..0818c7c851 --- /dev/null +++ b/src/pages/docs/cli/logs/channel-lifecycle/index.mdx @@ -0,0 +1,13 @@ +--- +title: "ably logs channel-lifecycle" +meta_description: "Stream logs from the channel lifecycle meta channel using the Ably CLI." +meta_keywords: "ably cli, cli, logs, channel lifecycle, meta channel, ably logs channel-lifecycle" +--- + +Use the `ably logs channel-lifecycle` command group to stream logs from the channel lifecycle meta channel. + +## Subcommands + +| Command | Description | +| ------- | ----------- | +| [`ably logs channel-lifecycle subscribe`](/docs/cli/logs/channel-lifecycle/subscribe) | Subscribe to channel lifecycle events. | diff --git a/src/pages/docs/cli/logs/channel-lifecycle/subscribe.mdx b/src/pages/docs/cli/logs/channel-lifecycle/subscribe.mdx new file mode 100644 index 0000000000..43980a7258 --- /dev/null +++ b/src/pages/docs/cli/logs/channel-lifecycle/subscribe.mdx @@ -0,0 +1,55 @@ +--- +title: "ably logs channel-lifecycle subscribe" +meta_description: "Stream logs from the channel lifecycle meta channel using the Ably CLI." +meta_keywords: "ably cli, cli, logs, channel lifecycle, subscribe, meta channel, ably logs channel-lifecycle subscribe" +--- + + +```shell +ably logs channel-lifecycle subscribe [flags] +``` + + +Use the `ably logs channel-lifecycle subscribe` command to stream logs from the [meta]channel.lifecycle meta channel. + +## Flags + +You can optionally pass the following flags to the `ably logs channel-lifecycle subscribe` command: + +### `--rewind` + +The number of messages to rewind when subscribing. Defaults to `0`. + +### `--duration | -D` + +The duration in seconds to subscribe for before automatically unsubscribing. + +### `--client-id` + +A client ID to use when subscribing. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Subscribe to channel lifecycle events: + + +```shell +ably logs channel-lifecycle subscribe +``` + + +Subscribe with rewind to receive recent events: + + +```shell +ably logs channel-lifecycle subscribe --rewind 5 +``` + diff --git a/src/pages/docs/cli/logs/connection-lifecycle/history.mdx b/src/pages/docs/cli/logs/connection-lifecycle/history.mdx new file mode 100644 index 0000000000..831630b1d8 --- /dev/null +++ b/src/pages/docs/cli/logs/connection-lifecycle/history.mdx @@ -0,0 +1,59 @@ +--- +title: "ably logs connection-lifecycle history" +meta_description: "Retrieve connection lifecycle log history using the Ably CLI." +meta_keywords: "ably cli, cli, logs, connection lifecycle, history, ably logs connection-lifecycle history" +--- + + +```shell +ably logs connection-lifecycle history [flags] +``` + + +Use the `ably logs connection-lifecycle history` command to retrieve connection lifecycle log history. + +## Flags + +You can optionally pass the following flags to the `ably logs connection-lifecycle history` command: + +### `--direction` + +The direction to retrieve logs in. Options are `backwards` or `forwards`. Defaults to `backwards`. + +### `--limit` + +The maximum number of log entries to retrieve. Defaults to `100`. + +### `--start` + +The start of the time range to retrieve logs from. Accepts ISO 8601, Unix milliseconds, or relative time formats. + +### `--end` + +The end of the time range to retrieve logs from. Accepts ISO 8601, Unix milliseconds, or relative time formats. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Retrieve recent connection lifecycle logs: + + +```shell +ably logs connection-lifecycle history +``` + + +Retrieve logs within a time range: + + +```shell +ably logs connection-lifecycle history --start "2025-01-01T00:00:00Z" --end "2025-01-02T00:00:00Z" +``` + diff --git a/src/pages/docs/cli/logs/connection-lifecycle/index.mdx b/src/pages/docs/cli/logs/connection-lifecycle/index.mdx new file mode 100644 index 0000000000..25132477a3 --- /dev/null +++ b/src/pages/docs/cli/logs/connection-lifecycle/index.mdx @@ -0,0 +1,14 @@ +--- +title: "ably logs connection-lifecycle" +meta_description: "Stream and retrieve connection lifecycle logs using the Ably CLI." +meta_keywords: "ably cli, cli, logs, connection lifecycle, subscribe, history, ably logs connection-lifecycle" +--- + +Use the `ably logs connection-lifecycle` command group to stream and retrieve connection lifecycle logs. + +## Subcommands + +| Command | Description | +| ------- | ----------- | +| [`ably logs connection-lifecycle subscribe`](/docs/cli/logs/connection-lifecycle/subscribe) | Subscribe to live connection lifecycle logs. | +| [`ably logs connection-lifecycle history`](/docs/cli/logs/connection-lifecycle/history) | Retrieve connection lifecycle log history. | diff --git a/src/pages/docs/cli/logs/connection-lifecycle/subscribe.mdx b/src/pages/docs/cli/logs/connection-lifecycle/subscribe.mdx new file mode 100644 index 0000000000..ee1d8379f0 --- /dev/null +++ b/src/pages/docs/cli/logs/connection-lifecycle/subscribe.mdx @@ -0,0 +1,55 @@ +--- +title: "ably logs connection-lifecycle subscribe" +meta_description: "Subscribe to live connection lifecycle logs using the Ably CLI." +meta_keywords: "ably cli, cli, logs, connection lifecycle, subscribe, ably logs connection-lifecycle subscribe" +--- + + +```shell +ably logs connection-lifecycle subscribe [flags] +``` + + +Use the `ably logs connection-lifecycle subscribe` command to subscribe to live connection lifecycle logs. + +## Flags + +You can optionally pass the following flags to the `ably logs connection-lifecycle subscribe` command: + +### `--rewind` + +The number of messages to rewind when subscribing. Defaults to `0`. + +### `--duration | -D` + +The duration in seconds to subscribe for before automatically unsubscribing. + +### `--client-id` + +A client ID to use when subscribing. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Subscribe to connection lifecycle logs: + + +```shell +ably logs connection-lifecycle subscribe +``` + + +Subscribe with rewind to receive recent logs: + + +```shell +ably logs connection-lifecycle subscribe --rewind 10 +``` + diff --git a/src/pages/docs/cli/logs/history.mdx b/src/pages/docs/cli/logs/history.mdx new file mode 100644 index 0000000000..d28504bb33 --- /dev/null +++ b/src/pages/docs/cli/logs/history.mdx @@ -0,0 +1,67 @@ +--- +title: "ably logs history" +meta_description: "Retrieve application log history using the Ably CLI." +meta_keywords: "ably cli, cli, logs, history, retrieve, ably logs history" +--- + + +```shell +ably logs history [flags] +``` + + +Use the `ably logs history` command to retrieve application log history. + +## Flags + +You can optionally pass the following flags to the `ably logs history` command: + +### `--direction` + +The direction to retrieve logs in. Options are `backwards` or `forwards`. Defaults to `backwards`. + +### `--limit` + +The maximum number of log entries to retrieve. Defaults to `100`. + +### `--start` + +The start of the time range to retrieve logs from. Accepts ISO 8601, Unix milliseconds, or relative time formats. + +### `--end` + +The end of the time range to retrieve logs from. Accepts ISO 8601, Unix milliseconds, or relative time formats. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Retrieve recent application logs: + + +```shell +ably logs history +``` + + +Retrieve logs within a time range: + + +```shell +ably logs history --start "2025-01-01T00:00:00Z" --end "2025-01-02T00:00:00Z" +``` + + +Retrieve logs in forwards direction: + + +```shell +ably logs history --direction forwards +``` + diff --git a/src/pages/docs/cli/logs/index.mdx b/src/pages/docs/cli/logs/index.mdx new file mode 100644 index 0000000000..239cd14f00 --- /dev/null +++ b/src/pages/docs/cli/logs/index.mdx @@ -0,0 +1,37 @@ +--- +title: "ably logs" +meta_description: "Stream and retrieve logs from Ably using the CLI." +meta_keywords: "ably cli, cli, logs, stream, subscribe, history, channel lifecycle, connection lifecycle, push, ably logs" +--- + +Use the `ably logs` command group to stream and retrieve logs from Ably. These commands enable you to subscribe to live logs, retrieve log history, and monitor channel lifecycle, connection lifecycle, and push notification events. + +## General + +| Command | Description | +| ------- | ----------- | +| [`ably logs subscribe`](/docs/cli/logs/subscribe) | Subscribe to live app logs. | +| [`ably logs history`](/docs/cli/logs/history) | Retrieve application log history. | + +## Channel lifecycle + +| Command | Description | +| ------- | ----------- | +| [`ably logs channel-lifecycle`](/docs/cli/logs/channel-lifecycle) | Stream logs from the channel lifecycle meta channel. | +| [`ably logs channel-lifecycle subscribe`](/docs/cli/logs/channel-lifecycle/subscribe) | Subscribe to channel lifecycle events. | + +## Connection lifecycle + +| Command | Description | +| ------- | ----------- | +| [`ably logs connection-lifecycle`](/docs/cli/logs/connection-lifecycle) | Stream and retrieve connection lifecycle logs. | +| [`ably logs connection-lifecycle subscribe`](/docs/cli/logs/connection-lifecycle/subscribe) | Subscribe to live connection lifecycle logs. | +| [`ably logs connection-lifecycle history`](/docs/cli/logs/connection-lifecycle/history) | Retrieve connection lifecycle log history. | + +## Push notifications + +| Command | Description | +| ------- | ----------- | +| [`ably logs push`](/docs/cli/logs/push) | Stream and retrieve push notification logs. | +| [`ably logs push subscribe`](/docs/cli/logs/push/subscribe) | Subscribe to push notification logs. | +| [`ably logs push history`](/docs/cli/logs/push/history) | Retrieve push notification log history. | diff --git a/src/pages/docs/cli/logs/push/history.mdx b/src/pages/docs/cli/logs/push/history.mdx new file mode 100644 index 0000000000..862f33ecc8 --- /dev/null +++ b/src/pages/docs/cli/logs/push/history.mdx @@ -0,0 +1,59 @@ +--- +title: "ably logs push history" +meta_description: "Retrieve push notification log history using the Ably CLI." +meta_keywords: "ably cli, cli, logs, push, history, notifications, ably logs push history" +--- + + +```shell +ably logs push history [flags] +``` + + +Use the `ably logs push history` command to retrieve push notification log history. + +## Flags + +You can optionally pass the following flags to the `ably logs push history` command: + +### `--direction` + +The direction to retrieve logs in. Options are `backwards` or `forwards`. Defaults to `backwards`. + +### `--limit` + +The maximum number of log entries to retrieve. Defaults to `100`. + +### `--start` + +The start of the time range to retrieve logs from. Accepts ISO 8601, Unix milliseconds, or relative time formats. + +### `--end` + +The end of the time range to retrieve logs from. Accepts ISO 8601, Unix milliseconds, or relative time formats. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Retrieve recent push notification logs: + + +```shell +ably logs push history +``` + + +Retrieve logs within a time range: + + +```shell +ably logs push history --start "2025-01-01T00:00:00Z" --end "2025-01-02T00:00:00Z" +``` + diff --git a/src/pages/docs/cli/logs/push/index.mdx b/src/pages/docs/cli/logs/push/index.mdx new file mode 100644 index 0000000000..dd595cfe86 --- /dev/null +++ b/src/pages/docs/cli/logs/push/index.mdx @@ -0,0 +1,14 @@ +--- +title: "ably logs push" +meta_description: "Stream and retrieve push notification logs using the Ably CLI." +meta_keywords: "ably cli, cli, logs, push, notifications, subscribe, history, ably logs push" +--- + +Use the `ably logs push` command group to stream and retrieve push notification logs. + +## Subcommands + +| Command | Description | +| ------- | ----------- | +| [`ably logs push subscribe`](/docs/cli/logs/push/subscribe) | Subscribe to push notification logs. | +| [`ably logs push history`](/docs/cli/logs/push/history) | Retrieve push notification log history. | diff --git a/src/pages/docs/cli/logs/push/subscribe.mdx b/src/pages/docs/cli/logs/push/subscribe.mdx new file mode 100644 index 0000000000..84bdb45845 --- /dev/null +++ b/src/pages/docs/cli/logs/push/subscribe.mdx @@ -0,0 +1,55 @@ +--- +title: "ably logs push subscribe" +meta_description: "Stream logs from the push notifications meta channel using the Ably CLI." +meta_keywords: "ably cli, cli, logs, push, subscribe, notifications, meta channel, ably logs push subscribe" +--- + + +```shell +ably logs push subscribe [flags] +``` + + +Use the `ably logs push subscribe` command to stream logs from the push notifications meta channel. + +## Flags + +You can optionally pass the following flags to the `ably logs push subscribe` command: + +### `--rewind` + +The number of messages to rewind when subscribing. Defaults to `0`. + +### `--duration | -D` + +The duration in seconds to subscribe for before automatically unsubscribing. + +### `--client-id` + +A client ID to use when subscribing. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Subscribe to push notification logs: + + +```shell +ably logs push subscribe +``` + + +Subscribe with rewind to receive recent logs: + + +```shell +ably logs push subscribe --rewind 5 +``` + diff --git a/src/pages/docs/cli/logs/subscribe.mdx b/src/pages/docs/cli/logs/subscribe.mdx new file mode 100644 index 0000000000..6b25c4c7cc --- /dev/null +++ b/src/pages/docs/cli/logs/subscribe.mdx @@ -0,0 +1,67 @@ +--- +title: "ably logs subscribe" +meta_description: "Subscribe to live app logs using the Ably CLI." +meta_keywords: "ably cli, cli, logs, subscribe, stream, live, ably logs subscribe" +--- + + +```shell +ably logs subscribe [flags] +``` + + +Use the `ably logs subscribe` command to subscribe to live app logs. + +## Flags + +You can optionally pass the following flags to the `ably logs subscribe` command: + +### `--type` + +Filter logs by type. Options are `channel.lifecycle`, `channel.occupancy`, `channel.presence`, `connection.lifecycle`, and `push.publish`. + +### `--duration | -D` + +The duration in seconds to subscribe for before automatically unsubscribing. + +### `--rewind` + +The number of messages to rewind when subscribing. Defaults to `0`. + +### `--client-id` + +A client ID to use when subscribing. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Subscribe to all app logs: + + +```shell +ably logs subscribe +``` + + +Filter by log type: + + +```shell +ably logs subscribe --type channel.lifecycle +``` + + +Subscribe with rewind to receive recent logs: + + +```shell +ably logs subscribe --rewind 10 +``` + diff --git a/src/pages/docs/cli/push/batch-publish.mdx b/src/pages/docs/cli/push/batch-publish.mdx new file mode 100644 index 0000000000..16c2adc5b2 --- /dev/null +++ b/src/pages/docs/cli/push/batch-publish.mdx @@ -0,0 +1,63 @@ +--- +title: "ably push batch-publish" +meta_description: "Publish push notifications to multiple recipients in a batch using the Ably CLI." +meta_keywords: "ably cli, cli, push, batch-publish, notifications, batch, ably push batch-publish" +--- + + +```shell +ably push batch-publish [payload] [flags] +``` + + +Use the `ably push batch-publish` command to publish push notifications to multiple recipients in a batch. + +## Arguments + +Pass the following arguments to the `ably push batch-publish` command: + +### `[payload]` + +A JSON array of push notification payloads. This can be provided as an inline JSON string, a file path, or `-` to read from stdin. + +## Flags + +You can optionally pass the following flags to the `ably push batch-publish` command: + +### `--force | -f` + +Skip confirmation when publishing to channels. Required when using `--json`. The default is `false`. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Publish with an inline JSON payload: + + +```shell +ably push batch-publish '[{"recipient":{"deviceId":"device1"},"notification":{"title":"Hello"}},{"recipient":{"clientId":"user1"},"notification":{"title":"Hi"}}]' +``` + + +Publish from a file: + + +```shell +ably push batch-publish @notifications.json +``` + + +Publish from stdin: + + +```shell +cat notifications.json | ably push batch-publish - +``` + diff --git a/src/pages/docs/cli/push/channels/index.mdx b/src/pages/docs/cli/push/channels/index.mdx new file mode 100644 index 0000000000..accb52c26f --- /dev/null +++ b/src/pages/docs/cli/push/channels/index.mdx @@ -0,0 +1,17 @@ +--- +title: "ably push channels" +meta_description: "Manage push notification channel subscriptions using the Ably CLI." +meta_keywords: "ably cli, cli, push, channels, subscriptions, ably push channels" +--- + +Use the `ably push channels` command group to manage push notification channel subscriptions. + +## Subcommands + +| Command | Description | +| ------- | ----------- | +| [`ably push channels list`](/docs/cli/push/channels/list) | List push channel subscriptions. | +| [`ably push channels list-channels`](/docs/cli/push/channels/list-channels) | List channels with push subscriptions. | +| [`ably push channels save`](/docs/cli/push/channels/save) | Subscribe a device or client to push notifications on a channel. | +| [`ably push channels remove`](/docs/cli/push/channels/remove) | Remove a push channel subscription. | +| [`ably push channels remove-where`](/docs/cli/push/channels/remove-where) | Remove push channel subscriptions matching filter criteria. | diff --git a/src/pages/docs/cli/push/channels/list-channels.mdx b/src/pages/docs/cli/push/channels/list-channels.mdx new file mode 100644 index 0000000000..01fa911aa3 --- /dev/null +++ b/src/pages/docs/cli/push/channels/list-channels.mdx @@ -0,0 +1,39 @@ +--- +title: "ably push channels list-channels" +meta_description: "List channels with push subscriptions using the Ably CLI." +meta_keywords: "ably cli, cli, push, channels, list-channels, subscriptions, ably push channels list-channels" +--- + + +```shell +ably push channels list-channels [flags] +``` + + +Use the `ably push channels list-channels` command to list channels with push subscriptions. + +## Flags + +You can optionally pass the following flags to the `ably push channels list-channels` command: + +### `--limit` + +The maximum number of channels to retrieve. Defaults to `100`. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +List channels with push subscriptions: + + +```shell +ably push channels list-channels +``` + diff --git a/src/pages/docs/cli/push/channels/list.mdx b/src/pages/docs/cli/push/channels/list.mdx new file mode 100644 index 0000000000..aa0fafbc1d --- /dev/null +++ b/src/pages/docs/cli/push/channels/list.mdx @@ -0,0 +1,59 @@ +--- +title: "ably push channels list" +meta_description: "List push channel subscriptions using the Ably CLI." +meta_keywords: "ably cli, cli, push, channels, list, subscriptions, ably push channels list" +--- + + +```shell +ably push channels list --channel [flags] +``` + + +Use the `ably push channels list` command to list push channel subscriptions. + +## Flags + +You can optionally pass the following flags to the `ably push channels list` command: + +### `--channel` + +The channel to list subscriptions for. Required. + +### `--device-id` + +Filter subscriptions by device ID. + +### `--client-id` + +Filter subscriptions by client ID. + +### `--limit` + +The maximum number of subscriptions to retrieve. Defaults to `100`. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +List all subscriptions for a channel: + + +```shell +ably push channels list --channel my-channel +``` + + +Filter subscriptions by device: + + +```shell +ably push channels list --channel my-channel --device-id "device123" +``` + diff --git a/src/pages/docs/cli/push/channels/remove-where.mdx b/src/pages/docs/cli/push/channels/remove-where.mdx new file mode 100644 index 0000000000..bd1b9c7c60 --- /dev/null +++ b/src/pages/docs/cli/push/channels/remove-where.mdx @@ -0,0 +1,59 @@ +--- +title: "ably push channels remove-where" +meta_description: "Remove push channel subscriptions matching filter criteria using the Ably CLI." +meta_keywords: "ably cli, cli, push, channels, remove-where, filter, ably push channels remove-where" +--- + + +```shell +ably push channels remove-where --channel [flags] +``` + + +Use the `ably push channels remove-where` command to remove push channel subscriptions matching filter criteria. + +## Flags + +You can optionally pass the following flags to the `ably push channels remove-where` command: + +### `--channel` + +The channel to remove subscriptions from. Required. + +### `--device-id` + +Filter subscriptions by device ID. + +### `--client-id` + +Filter subscriptions by client ID. + +### `--force | -f` + +Skip confirmation prompt. Required when using `--json`. The default is `false`. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Remove all subscriptions for a device on a channel: + + +```shell +ably push channels remove-where --channel my-channel --device-id "device123" +``` + + +Remove all subscriptions for a client on a channel: + + +```shell +ably push channels remove-where --channel my-channel --client-id "user456" +``` + diff --git a/src/pages/docs/cli/push/channels/remove.mdx b/src/pages/docs/cli/push/channels/remove.mdx new file mode 100644 index 0000000000..8614a5bd99 --- /dev/null +++ b/src/pages/docs/cli/push/channels/remove.mdx @@ -0,0 +1,59 @@ +--- +title: "ably push channels remove" +meta_description: "Remove a push channel subscription using the Ably CLI." +meta_keywords: "ably cli, cli, push, channels, remove, unsubscribe, ably push channels remove" +--- + + +```shell +ably push channels remove --channel [flags] +``` + + +Use the `ably push channels remove` command to remove a push channel subscription. + +## Flags + +You can optionally pass the following flags to the `ably push channels remove` command: + +### `--channel` + +The channel to remove the subscription from. Required. + +### `--device-id` + +The device ID to unsubscribe. Exclusive with `--client-id`. + +### `--client-id` + +The client ID to unsubscribe. Exclusive with `--device-id`. + +### `--force | -f` + +Skip confirmation prompt. Required when using `--json`. The default is `false`. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Remove a device subscription from a channel: + + +```shell +ably push channels remove --channel my-channel --device-id "device123" +``` + + +Remove a client subscription from a channel: + + +```shell +ably push channels remove --channel my-channel --client-id "user456" +``` + diff --git a/src/pages/docs/cli/push/channels/save.mdx b/src/pages/docs/cli/push/channels/save.mdx new file mode 100644 index 0000000000..97d4ec2f77 --- /dev/null +++ b/src/pages/docs/cli/push/channels/save.mdx @@ -0,0 +1,55 @@ +--- +title: "ably push channels save" +meta_description: "Subscribe a device or client to push notifications on a channel using the Ably CLI." +meta_keywords: "ably cli, cli, push, channels, save, subscribe, device, client, ably push channels save" +--- + + +```shell +ably push channels save --channel [flags] +``` + + +Use the `ably push channels save` command to subscribe a device or client to push notifications on a channel. + +## Flags + +You can optionally pass the following flags to the `ably push channels save` command: + +### `--channel` + +The channel to subscribe to. Required. + +### `--device-id` + +The device ID to subscribe. Exclusive with `--client-id`. + +### `--client-id` + +The client ID to subscribe. Exclusive with `--device-id`. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Subscribe a device to push notifications on a channel: + + +```shell +ably push channels save --channel my-channel --device-id "device123" +``` + + +Subscribe a client to push notifications on a channel: + + +```shell +ably push channels save --channel my-channel --client-id "user456" +``` + diff --git a/src/pages/docs/cli/push/config/clear-apns.mdx b/src/pages/docs/cli/push/config/clear-apns.mdx new file mode 100644 index 0000000000..b1ec724614 --- /dev/null +++ b/src/pages/docs/cli/push/config/clear-apns.mdx @@ -0,0 +1,51 @@ +--- +title: "ably push config clear-apns" +meta_description: "Clear APNs push notification configuration for an Ably app using the CLI." +meta_keywords: "ably cli, cli, push, config, clear-apns, apns, apple, ably push config clear-apns" +--- + + +```shell +ably push config clear-apns [flags] +``` + + +Use the `ably push config clear-apns` command to clear APNs push notification configuration for an app. + +## Flags + +You can optionally pass the following flags to the `ably push config clear-apns` command: + +### `--app` + +The app ID to clear configuration for. + +### `--force | -f` + +Skip confirmation prompt. Required when using `--json`. The default is `false`. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Clear APNs configuration with confirmation: + + +```shell +ably push config clear-apns +``` + + +Force clear APNs configuration: + + +```shell +ably push config clear-apns --force +``` + diff --git a/src/pages/docs/cli/push/config/clear-fcm.mdx b/src/pages/docs/cli/push/config/clear-fcm.mdx new file mode 100644 index 0000000000..e489a58013 --- /dev/null +++ b/src/pages/docs/cli/push/config/clear-fcm.mdx @@ -0,0 +1,51 @@ +--- +title: "ably push config clear-fcm" +meta_description: "Clear FCM push notification configuration for an Ably app using the CLI." +meta_keywords: "ably cli, cli, push, config, clear-fcm, fcm, firebase, ably push config clear-fcm" +--- + + +```shell +ably push config clear-fcm [flags] +``` + + +Use the `ably push config clear-fcm` command to clear FCM push notification configuration for an app. + +## Flags + +You can optionally pass the following flags to the `ably push config clear-fcm` command: + +### `--app` + +The app ID to clear configuration for. + +### `--force | -f` + +Skip confirmation prompt. Required when using `--json`. The default is `false`. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Clear FCM configuration with confirmation: + + +```shell +ably push config clear-fcm +``` + + +Force clear FCM configuration: + + +```shell +ably push config clear-fcm --force +``` + diff --git a/src/pages/docs/cli/push/config/index.mdx b/src/pages/docs/cli/push/config/index.mdx new file mode 100644 index 0000000000..e7432e405f --- /dev/null +++ b/src/pages/docs/cli/push/config/index.mdx @@ -0,0 +1,17 @@ +--- +title: "ably push config" +meta_description: "Manage push notification configuration using the Ably CLI." +meta_keywords: "ably cli, cli, push, config, configuration, apns, fcm, ably push config" +--- + +Use the `ably push config` command group to manage push notification configuration. + +## Subcommands + +| Command | Description | +| ------- | ----------- | +| [`ably push config show`](/docs/cli/push/config/show) | Show push notification configuration for an app. | +| [`ably push config set-apns`](/docs/cli/push/config/set-apns) | Configure APNs push notifications for an app. | +| [`ably push config set-fcm`](/docs/cli/push/config/set-fcm) | Configure FCM push notifications for an app. | +| [`ably push config clear-apns`](/docs/cli/push/config/clear-apns) | Clear APNs push notification configuration for an app. | +| [`ably push config clear-fcm`](/docs/cli/push/config/clear-fcm) | Clear FCM push notification configuration for an app. | diff --git a/src/pages/docs/cli/push/config/set-apns.mdx b/src/pages/docs/cli/push/config/set-apns.mdx new file mode 100644 index 0000000000..18e2b95c33 --- /dev/null +++ b/src/pages/docs/cli/push/config/set-apns.mdx @@ -0,0 +1,75 @@ +--- +title: "ably push config set-apns" +meta_description: "Configure APNs push notifications for an Ably app using the CLI." +meta_keywords: "ably cli, cli, push, config, set-apns, apns, apple, ios, ably push config set-apns" +--- + + +```shell +ably push config set-apns [flags] +``` + + +Use the `ably push config set-apns` command to configure APNs push notifications for an app. + +## Flags + +You can optionally pass the following flags to the `ably push config set-apns` command: + +### `--app` + +The app ID to configure. + +### `--certificate` + +The path to a P12 certificate file. Exclusive with `--key-file`. + +### `--key-file` + +The path to a P8 key file. Exclusive with `--certificate`. + +### `--key-id` + +The key ID for the P8 key. Required when using `--key-file`. + +### `--password` + +The password for the P12 certificate. + +### `--sandbox` + +Use the APNs sandbox environment. Defaults to `false`. + +### `--team-id` + +The Apple Developer team ID. Required when using `--key-file`. + +### `--topic` + +The bundle ID for the app. Required when using `--key-file`. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Configure APNs with a P12 certificate: + + +```shell +ably push config set-apns --certificate /path/to/cert.p12 --password "cert-password" +``` + + +Configure APNs with a P8 key: + + +```shell +ably push config set-apns --key-file /path/to/key.p8 --key-id "ABC123" --team-id "TEAM456" --topic "com.example.app" +``` + diff --git a/src/pages/docs/cli/push/config/set-fcm.mdx b/src/pages/docs/cli/push/config/set-fcm.mdx new file mode 100644 index 0000000000..7f1ed50590 --- /dev/null +++ b/src/pages/docs/cli/push/config/set-fcm.mdx @@ -0,0 +1,43 @@ +--- +title: "ably push config set-fcm" +meta_description: "Configure FCM push notifications for an Ably app using the CLI." +meta_keywords: "ably cli, cli, push, config, set-fcm, fcm, firebase, android, ably push config set-fcm" +--- + + +```shell +ably push config set-fcm --service-account [flags] +``` + + +Use the `ably push config set-fcm` command to configure FCM push notifications for an app. + +## Flags + +You can optionally pass the following flags to the `ably push config set-fcm` command: + +### `--app` + +The app ID to configure. + +### `--service-account` + +The path to the FCM service account JSON file. Required. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Configure FCM with a service account: + + +```shell +ably push config set-fcm --service-account /path/to/service-account.json +``` + diff --git a/src/pages/docs/cli/push/config/show.mdx b/src/pages/docs/cli/push/config/show.mdx new file mode 100644 index 0000000000..692f10b609 --- /dev/null +++ b/src/pages/docs/cli/push/config/show.mdx @@ -0,0 +1,47 @@ +--- +title: "ably push config show" +meta_description: "Show push notification configuration for an Ably app using the CLI." +meta_keywords: "ably cli, cli, push, config, show, configuration, ably push config show" +--- + + +```shell +ably push config show [flags] +``` + + +Use the `ably push config show` command to show push notification configuration for an app. + +## Flags + +You can optionally pass the following flags to the `ably push config show` command: + +### `--app` + +The app ID to show configuration for. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Show push configuration for the current app: + + +```shell +ably push config show +``` + + +Show push configuration for a specific app: + + +```shell +ably push config show --app "app-id" +``` + diff --git a/src/pages/docs/cli/push/devices/get.mdx b/src/pages/docs/cli/push/devices/get.mdx new file mode 100644 index 0000000000..eae6bfc5f0 --- /dev/null +++ b/src/pages/docs/cli/push/devices/get.mdx @@ -0,0 +1,39 @@ +--- +title: "ably push devices get" +meta_description: "Get details of a push device registration using the Ably CLI." +meta_keywords: "ably cli, cli, push, devices, get, registration, details, ably push devices get" +--- + + +```shell +ably push devices get +``` + + +Use the `ably push devices get` command to get details of a push device registration. + +## Arguments + +Pass the following arguments to the `ably push devices get` command: + +### `` + +The ID of the device to retrieve details for. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Get details of a device registration: + + +```shell +ably push devices get "device123" +``` + diff --git a/src/pages/docs/cli/push/devices/index.mdx b/src/pages/docs/cli/push/devices/index.mdx new file mode 100644 index 0000000000..ad30a3c0f4 --- /dev/null +++ b/src/pages/docs/cli/push/devices/index.mdx @@ -0,0 +1,17 @@ +--- +title: "ably push devices" +meta_description: "Manage push notification device registrations using the Ably CLI." +meta_keywords: "ably cli, cli, push, devices, registrations, ably push devices" +--- + +Use the `ably push devices` command group to manage push notification device registrations. + +## Subcommands + +| Command | Description | +| ------- | ----------- | +| [`ably push devices list`](/docs/cli/push/devices/list) | List push device registrations. | +| [`ably push devices get`](/docs/cli/push/devices/get) | Get details of a push device registration. | +| [`ably push devices save`](/docs/cli/push/devices/save) | Register or update a push device. | +| [`ably push devices remove`](/docs/cli/push/devices/remove) | Remove a push device registration. | +| [`ably push devices remove-where`](/docs/cli/push/devices/remove-where) | Remove push device registrations matching filter criteria. | diff --git a/src/pages/docs/cli/push/devices/list.mdx b/src/pages/docs/cli/push/devices/list.mdx new file mode 100644 index 0000000000..567c4cbde5 --- /dev/null +++ b/src/pages/docs/cli/push/devices/list.mdx @@ -0,0 +1,59 @@ +--- +title: "ably push devices list" +meta_description: "List push device registrations using the Ably CLI." +meta_keywords: "ably cli, cli, push, devices, list, registrations, ably push devices list" +--- + + +```shell +ably push devices list [flags] +``` + + +Use the `ably push devices list` command to list push device registrations. + +## Flags + +You can optionally pass the following flags to the `ably push devices list` command: + +### `--device-id` + +Filter registrations by device ID. + +### `--client-id` + +Filter registrations by client ID. + +### `--state` + +Filter registrations by state. Options are `ACTIVE`, `FAILING`, and `FAILED`. + +### `--limit` + +The maximum number of registrations to retrieve. Defaults to `100`. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +List all device registrations: + + +```shell +ably push devices list +``` + + +Filter by state: + + +```shell +ably push devices list --state ACTIVE +``` + diff --git a/src/pages/docs/cli/push/devices/remove-where.mdx b/src/pages/docs/cli/push/devices/remove-where.mdx new file mode 100644 index 0000000000..6f779d0a1b --- /dev/null +++ b/src/pages/docs/cli/push/devices/remove-where.mdx @@ -0,0 +1,55 @@ +--- +title: "ably push devices remove-where" +meta_description: "Remove push device registrations matching filter criteria using the Ably CLI." +meta_keywords: "ably cli, cli, push, devices, remove-where, filter, ably push devices remove-where" +--- + + +```shell +ably push devices remove-where [flags] +``` + + +Use the `ably push devices remove-where` command to remove push device registrations matching filter criteria. + +## Flags + +You can optionally pass the following flags to the `ably push devices remove-where` command: + +### `--device-id` + +Filter registrations by device ID. + +### `--client-id` + +Filter registrations by client ID. + +### `--force | -f` + +Skip confirmation prompt. Required when using `--json`. The default is `false`. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Remove registrations by device ID: + + +```shell +ably push devices remove-where --device-id "device123" +``` + + +Remove registrations by client ID: + + +```shell +ably push devices remove-where --client-id "user456" +``` + diff --git a/src/pages/docs/cli/push/devices/remove.mdx b/src/pages/docs/cli/push/devices/remove.mdx new file mode 100644 index 0000000000..ce97507914 --- /dev/null +++ b/src/pages/docs/cli/push/devices/remove.mdx @@ -0,0 +1,55 @@ +--- +title: "ably push devices remove" +meta_description: "Remove a push device registration using the Ably CLI." +meta_keywords: "ably cli, cli, push, devices, remove, unregister, ably push devices remove" +--- + + +```shell +ably push devices remove [flags] +``` + + +Use the `ably push devices remove` command to remove a push device registration. + +## Arguments + +Pass the following arguments to the `ably push devices remove` command: + +### `` + +The ID of the device to remove. + +## Flags + +You can optionally pass the following flags to the `ably push devices remove` command: + +### `--force | -f` + +Skip confirmation prompt. Required when using `--json`. The default is `false`. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Remove a device registration: + + +```shell +ably push devices remove "device123" +``` + + +Force remove without confirmation: + + +```shell +ably push devices remove "device123" --force +``` + diff --git a/src/pages/docs/cli/push/devices/save.mdx b/src/pages/docs/cli/push/devices/save.mdx new file mode 100644 index 0000000000..bcd4e93d7e --- /dev/null +++ b/src/pages/docs/cli/push/devices/save.mdx @@ -0,0 +1,95 @@ +--- +title: "ably push devices save" +meta_description: "Register or update a push device using the Ably CLI." +meta_keywords: "ably cli, cli, push, devices, save, register, update, ably push devices save" +--- + + +```shell +ably push devices save [flags] +``` + + +Use the `ably push devices save` command to register or update a push device. + +## Flags + +You can optionally pass the following flags to the `ably push devices save` command: + +### `--id` + +The device ID. Required unless `--data` is provided. + +### `--platform` + +The device platform. Options are `ios`, `android`, and `browser`. + +### `--form-factor` + +The device form factor. Options are `phone`, `tablet`, `desktop`, `tv`, `watch`, `car`, `embedded`, and `other`. + +### `--transport-type` + +The push transport type. Options are `apns`, `fcm`, and `web`. + +### `--device-token` + +The device token for APNs or FCM. Required when transport type is `apns` or `fcm`. + +### `--target-url` + +The target URL for web push. Required when transport type is `web`. + +### `--p256dh-key` + +The P-256 Diffie-Hellman key for web push. Required when transport type is `web`. + +### `--auth-secret` + +The authentication secret for web push. Required when transport type is `web`. + +### `--client-id` + +The client ID to associate with the device. + +### `--metadata` + +Device metadata as a JSON string. + +### `--data` + +Full device registration JSON, or a file path prefixed with `@`. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Register an iOS device: + + +```shell +ably push devices save --id "device-001" --platform ios --form-factor phone --transport-type apns --device-token "token123" --client-id "user456" +``` + + +Register a web push device: + + +```shell +ably push devices save --platform browser --form-factor desktop --transport-type web --target-url "https://example.com/push" --p256dh-key "key123" --auth-secret "secret456" +``` + + +Register a device from a JSON file: + + +```shell +ably push devices save --data @device.json +``` + diff --git a/src/pages/docs/cli/push/index.mdx b/src/pages/docs/cli/push/index.mdx new file mode 100644 index 0000000000..37fc2fb177 --- /dev/null +++ b/src/pages/docs/cli/push/index.mdx @@ -0,0 +1,47 @@ +--- +title: "ably push" +meta_description: "Manage push notifications using the Ably CLI." +meta_keywords: "ably cli, cli, push, notifications, publish, devices, channels, config, ably push" +--- + +Use the `ably push` command group to manage push notifications. These commands enable you to publish notifications, manage channel subscriptions, configure push services, and manage device registrations. + +## Publishing + +| Command | Description | +| ------- | ----------- | +| [`ably push publish`](/docs/cli/push/publish) | Publish a push notification to a device, client, or channel. | +| [`ably push batch-publish`](/docs/cli/push/batch-publish) | Publish push notifications to multiple recipients in a batch. | + +## Channel subscriptions + +| Command | Description | +| ------- | ----------- | +| [`ably push channels`](/docs/cli/push/channels) | Manage push notification channel subscriptions. | +| [`ably push channels list`](/docs/cli/push/channels/list) | List push channel subscriptions. | +| [`ably push channels list-channels`](/docs/cli/push/channels/list-channels) | List channels with push subscriptions. | +| [`ably push channels save`](/docs/cli/push/channels/save) | Subscribe a device or client to push notifications on a channel. | +| [`ably push channels remove`](/docs/cli/push/channels/remove) | Remove a push channel subscription. | +| [`ably push channels remove-where`](/docs/cli/push/channels/remove-where) | Remove push channel subscriptions matching filter criteria. | + +## Configuration + +| Command | Description | +| ------- | ----------- | +| [`ably push config`](/docs/cli/push/config) | Manage push notification configuration. | +| [`ably push config show`](/docs/cli/push/config/show) | Show push notification configuration for an app. | +| [`ably push config set-apns`](/docs/cli/push/config/set-apns) | Configure APNs push notifications for an app. | +| [`ably push config set-fcm`](/docs/cli/push/config/set-fcm) | Configure FCM push notifications for an app. | +| [`ably push config clear-apns`](/docs/cli/push/config/clear-apns) | Clear APNs push notification configuration for an app. | +| [`ably push config clear-fcm`](/docs/cli/push/config/clear-fcm) | Clear FCM push notification configuration for an app. | + +## Device registrations + +| Command | Description | +| ------- | ----------- | +| [`ably push devices`](/docs/cli/push/devices) | Manage push notification device registrations. | +| [`ably push devices list`](/docs/cli/push/devices/list) | List push device registrations. | +| [`ably push devices get`](/docs/cli/push/devices/get) | Get details of a push device registration. | +| [`ably push devices save`](/docs/cli/push/devices/save) | Register or update a push device. | +| [`ably push devices remove`](/docs/cli/push/devices/remove) | Remove a push device registration. | +| [`ably push devices remove-where`](/docs/cli/push/devices/remove-where) | Remove push device registrations matching filter criteria. | diff --git a/src/pages/docs/cli/push/publish.mdx b/src/pages/docs/cli/push/publish.mdx new file mode 100644 index 0000000000..cfd1599746 --- /dev/null +++ b/src/pages/docs/cli/push/publish.mdx @@ -0,0 +1,127 @@ +--- +title: "ably push publish" +meta_description: "Publish a push notification to a device, client, or channel using the Ably CLI." +meta_keywords: "ably cli, cli, push, publish, notification, device, client, channel, ably push publish" +--- + + +```shell +ably push publish [flags] +``` + + +Use the `ably push publish` command to publish a push notification to a device, client, or channel. + +## Flags + +You can optionally pass the following flags to the `ably push publish` command: + +### `--device-id` + +The ID of the device to publish to. Exclusive with `--client-id` and `--recipient`. + +### `--client-id` + +The client ID to publish to. Exclusive with `--device-id` and `--recipient`. + +### `--recipient` + +A raw JSON recipient object. Exclusive with `--device-id` and `--client-id`. + +### `--channel` + +The target channel name. Publishes a push notification via the channel using `extras.push`. Ignored if `--device-id`, `--client-id`, or `--recipient` is also provided. + +### `--title` + +The title of the push notification. + +### `--body` + +The body text of the push notification. + +### `--sound` + +The sound to play when the notification is received. + +### `--icon` + +The icon for the push notification. + +### `--badge` + +The badge number to display on the app icon. + +### `--data` + +A JSON payload to include with the push notification. + +### `--collapse-key` + +A collapse key for grouping notifications. + +### `--ttl` + +The time-to-live for the notification in seconds. + +### `--payload` + +A full JSON payload for the push notification, provided as a JSON string or a file path. Overrides convenience flags such as `--title` and `--body`. + +### `--apns` + +APNs-specific JSON configuration. + +### `--fcm` + +FCM-specific JSON configuration. + +### `--web` + +Web push-specific JSON configuration. + +### `--force | -f` + +Skip confirmation prompt. Required when using `--json`. The default is `false`. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Publish a push notification to a device: + + +```shell +ably push publish --device-id "device123" --title "Hello" --body "World" +``` + + +Publish a push notification to a client: + + +```shell +ably push publish --client-id "user456" --title "Update" --body "New content available" +``` + + +Publish a push notification to a channel: + + +```shell +ably push publish --channel "announcements" --title "News" --body "Breaking update" --force +``` + + +Publish with a custom payload: + + +```shell +ably push publish --device-id "device123" --payload '{"notification":{"title":"Custom","body":"Payload"},"data":{"key":"value"}}' +``` + diff --git a/src/pages/docs/cli/queues/create.mdx b/src/pages/docs/cli/queues/create.mdx new file mode 100644 index 0000000000..1070844cec --- /dev/null +++ b/src/pages/docs/cli/queues/create.mdx @@ -0,0 +1,71 @@ +--- +title: "ably queues create" +meta_description: "Create a queue using the Ably CLI." +meta_keywords: "ably cli, cli, queues, create, message queue, ably queues create" +--- + + +```shell +ably queues create --name [flags] +``` + + +Use the `ably queues create` command to create a new queue for your Ably application. + +## Flags + +You can pass the following flags to the `ably queues create` command: + +### `--name` + +The name of the queue to create. This flag is required. + +### `--app` + +The app ID to create the queue for. If not specified, the currently selected app is used. + +### `--max-length` + +The maximum number of messages the queue can hold. The default value is `10000`. + +### `--region` + +The region to create the queue in. The default value is `us-east-1-a`. + +### `--ttl` + +The time-to-live for messages in the queue, in seconds. The default value is `60`. The maximum value is `3600`. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Create a queue: + + +```shell +ably queues create --name "my-queue" +``` + + +Create a queue with custom settings: + + +```shell +ably queues create --name "my-queue" --max-length 5000 --ttl 300 +``` + + +Create a queue in a specific region: + + +```shell +ably queues create --name "my-queue" --region eu-west-1-a +``` + diff --git a/src/pages/docs/cli/queues/delete.mdx b/src/pages/docs/cli/queues/delete.mdx new file mode 100644 index 0000000000..19ceb7136e --- /dev/null +++ b/src/pages/docs/cli/queues/delete.mdx @@ -0,0 +1,59 @@ +--- +title: "ably queues delete" +meta_description: "Delete a queue using the Ably CLI." +meta_keywords: "ably cli, cli, queues, delete, message queue, ably queues delete" +--- + + +```shell +ably queues delete [flags] +``` + + +Use the `ably queues delete` command to delete a queue. + +## Arguments + +Pass the following arguments to the `ably queues delete` command: + +### `` + +The ID of the queue to delete. This argument is required. + +## Flags + +You can optionally pass the following flags to the `ably queues delete` command: + +### `--app` + +The app ID that the queue belongs to. If not specified, the currently selected app is used. + +### `--force | -f` + +Skip the confirmation prompt and delete the queue immediately. Required when using `--json`. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Delete a queue: + + +```shell +ably queues delete aBcDe1 +``` + + +Delete a queue without a confirmation prompt: + + +```shell +ably queues delete aBcDe1 --force +``` + diff --git a/src/pages/docs/cli/queues/index.mdx b/src/pages/docs/cli/queues/index.mdx new file mode 100644 index 0000000000..79a3baf6e3 --- /dev/null +++ b/src/pages/docs/cli/queues/index.mdx @@ -0,0 +1,15 @@ +--- +title: "ably queues" +meta_description: "Manage Ably queues." +meta_keywords: "ably cli, cli, queues, message queues, ably queues" +--- + +Use the `ably queues` command group to manage your Ably queues. These commands enable you to create, list, and delete queues for your applications. + +## Subcommands + +| Command | Description | +| ------- | ----------- | +| [`ably queues create`](/docs/cli/queues/create) | Create a queue. | +| [`ably queues delete`](/docs/cli/queues/delete) | Delete a queue. | +| [`ably queues list`](/docs/cli/queues/list) | List all queues. | diff --git a/src/pages/docs/cli/queues/list.mdx b/src/pages/docs/cli/queues/list.mdx new file mode 100644 index 0000000000..d8a8021f6b --- /dev/null +++ b/src/pages/docs/cli/queues/list.mdx @@ -0,0 +1,51 @@ +--- +title: "ably queues list" +meta_description: "List all queues using the Ably CLI." +meta_keywords: "ably cli, cli, queues, list, message queues, ably queues list" +--- + + +```shell +ably queues list [flags] +``` + + +Use the `ably queues list` command to list all queues for an application. + +## Flags + +You can optionally pass the following flags to the `ably queues list` command: + +### `--app` + +The app ID to list queues for. If not specified, the currently selected app is used. + +### `--limit` + +The maximum number of queues to return. The default value is `100`. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +List all queues: + + +```shell +ably queues list +``` + + +List all queues in JSON format: + + +```shell +ably queues list --json +``` + diff --git a/src/pages/docs/cli/rooms/index.mdx b/src/pages/docs/cli/rooms/index.mdx new file mode 100644 index 0000000000..34cad9a514 --- /dev/null +++ b/src/pages/docs/cli/rooms/index.mdx @@ -0,0 +1,66 @@ +--- +title: "ably rooms" +meta_description: "Interact with Ably Chat rooms using the CLI." +meta_keywords: "ably cli, cli, rooms, chat, messages, presence, occupancy, reactions, typing, ably rooms" +--- + +Use the `ably rooms` command group to interact with Ably Chat rooms. These commands enable you to manage rooms, send and subscribe to messages, monitor occupancy, manage presence, send reactions, and work with typing indicators. + +## Room management + +| Command | Description | +| ------- | ----------- | +| [`ably rooms list`](/docs/cli/rooms/list) | List active chat rooms. | + +## Messages + +| Command | Description | +| ------- | ----------- | +| [`ably rooms messages`](/docs/cli/rooms/messages) | Commands for working with chat messages in rooms. | +| [`ably rooms messages send`](/docs/cli/rooms/messages/send) | Send a message to a chat room. | +| [`ably rooms messages subscribe`](/docs/cli/rooms/messages/subscribe) | Subscribe to messages in one or more chat rooms. | +| [`ably rooms messages history`](/docs/cli/rooms/messages/history) | Get historical messages from a chat room. | +| [`ably rooms messages update`](/docs/cli/rooms/messages/update) | Update a message in a chat room. | +| [`ably rooms messages delete`](/docs/cli/rooms/messages/delete) | Delete a message in a chat room. | + +## Message reactions + +| Command | Description | +| ------- | ----------- | +| [`ably rooms messages reactions`](/docs/cli/rooms/messages/reactions) | Commands for working with message reactions. | +| [`ably rooms messages reactions send`](/docs/cli/rooms/messages/reactions/send) | Send a reaction to a message. | +| [`ably rooms messages reactions subscribe`](/docs/cli/rooms/messages/reactions/subscribe) | Subscribe to message reactions. | +| [`ably rooms messages reactions remove`](/docs/cli/rooms/messages/reactions/remove) | Remove a reaction from a message. | + +## Occupancy + +| Command | Description | +| ------- | ----------- | +| [`ably rooms occupancy`](/docs/cli/rooms/occupancy) | Commands for monitoring room occupancy. | +| [`ably rooms occupancy get`](/docs/cli/rooms/occupancy/get) | Get current occupancy metrics for a room. | +| [`ably rooms occupancy subscribe`](/docs/cli/rooms/occupancy/subscribe) | Subscribe to real-time occupancy metrics. | + +## Presence + +| Command | Description | +| ------- | ----------- | +| [`ably rooms presence`](/docs/cli/rooms/presence) | Commands for working with presence in chat rooms. | +| [`ably rooms presence enter`](/docs/cli/rooms/presence/enter) | Enter presence in a chat room. | +| [`ably rooms presence get`](/docs/cli/rooms/presence/get) | Get current presence members in a chat room. | +| [`ably rooms presence subscribe`](/docs/cli/rooms/presence/subscribe) | Subscribe to presence events in a chat room. | + +## Room reactions + +| Command | Description | +| ------- | ----------- | +| [`ably rooms reactions`](/docs/cli/rooms/reactions) | Commands for working with room-level reactions. | +| [`ably rooms reactions send`](/docs/cli/rooms/reactions/send) | Send a reaction in a chat room. | +| [`ably rooms reactions subscribe`](/docs/cli/rooms/reactions/subscribe) | Subscribe to reactions in a chat room. | + +## Typing indicators + +| Command | Description | +| ------- | ----------- | +| [`ably rooms typing`](/docs/cli/rooms/typing) | Commands for working with typing indicators. | +| [`ably rooms typing keystroke`](/docs/cli/rooms/typing/keystroke) | Send a typing indicator in a chat room. | +| [`ably rooms typing subscribe`](/docs/cli/rooms/typing/subscribe) | Subscribe to typing indicators in a chat room. | diff --git a/src/pages/docs/cli/rooms/list.mdx b/src/pages/docs/cli/rooms/list.mdx new file mode 100644 index 0000000000..84a7c5ff26 --- /dev/null +++ b/src/pages/docs/cli/rooms/list.mdx @@ -0,0 +1,51 @@ +--- +title: "ably rooms list" +meta_description: "List active Ably Chat rooms using the CLI." +meta_keywords: "ably cli, cli, rooms, list, chat, ably rooms list" +--- + + +```shell +ably rooms list [flags] +``` + + +Use the `ably rooms list` command to list active chat rooms. + +## Flags + +You can optionally pass the following flags to the `ably rooms list` command: + +### `--limit` + +The maximum number of rooms to return. Defaults to `100`. + +### `--prefix | -p` + +Filter rooms by a name prefix. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +List all active chat rooms: + + +```shell +ably rooms list +``` + + +Filter rooms by prefix: + + +```shell +ably rooms list --prefix "game-" +``` + diff --git a/src/pages/docs/cli/rooms/messages/delete.mdx b/src/pages/docs/cli/rooms/messages/delete.mdx new file mode 100644 index 0000000000..b9854d439a --- /dev/null +++ b/src/pages/docs/cli/rooms/messages/delete.mdx @@ -0,0 +1,63 @@ +--- +title: "ably rooms messages delete" +meta_description: "Delete a message in an Ably Chat room using the CLI." +meta_keywords: "ably cli, cli, rooms, messages, delete, chat, ably rooms messages delete" +--- + + +```shell +ably rooms messages delete [flags] +``` + + +Use the `ably rooms messages delete` command to delete a message in an Ably Chat room. + +## Arguments + +Pass the following arguments to the `ably rooms messages delete` command: + +### `` + +The name of the chat room containing the message. + +### `` + +The serial identifier of the message to delete. + +## Flags + +You can optionally pass the following flags to the `ably rooms messages delete` command: + +### `--description` + +A description of the reason for deleting the message. + +### `--client-id` + +A client ID to use when deleting the message. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Delete a message: + + +```shell +ably rooms messages delete my-room "01a2b3c4d5@1234567890000-0" +``` + + +Delete a message with a description: + + +```shell +ably rooms messages delete my-room "01a2b3c4d5@1234567890000-0" --description "Removed inappropriate content" +``` + diff --git a/src/pages/docs/cli/rooms/messages/history.mdx b/src/pages/docs/cli/rooms/messages/history.mdx new file mode 100644 index 0000000000..f56ecbc90c --- /dev/null +++ b/src/pages/docs/cli/rooms/messages/history.mdx @@ -0,0 +1,87 @@ +--- +title: "ably rooms messages history" +meta_description: "Get historical messages from an Ably Chat room using the CLI." +meta_keywords: "ably cli, cli, rooms, messages, history, chat, ably rooms messages history" +--- + + +```shell +ably rooms messages history [flags] +``` + + +Use the `ably rooms messages history` command to get historical messages from an Ably Chat room. + +## Arguments + +Pass the following arguments to the `ably rooms messages history` command: + +### `` + +The name of the chat room to retrieve history from. + +## Flags + +You can optionally pass the following flags to the `ably rooms messages history` command: + +### `--limit | -l` + +The maximum number of messages to return. Defaults to `50`. + +### `--order` + +The order in which to return messages. Options are `newestFirst` or `oldestFirst`. Defaults to `newestFirst`. + +### `--show-metadata` + +Display metadata attached to messages. Defaults to `false`. + +### `--start` + +The start of the time range to query. Accepts ISO 8601, Unix timestamp, or relative time formats. + +### `--end` + +The end of the time range to query. Accepts ISO 8601, Unix timestamp, or relative time formats. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Get recent message history for a room: + + +```shell +ably rooms messages history my-room +``` + + +Get history with a limit: + + +```shell +ably rooms messages history my-room --limit 10 +``` + + +Get history within a time range: + + +```shell +ably rooms messages history my-room --start "2025-01-01T00:00:00Z" --end "2025-01-02T00:00:00Z" +``` + + +Get history in oldest-first order: + + +```shell +ably rooms messages history my-room --order oldestFirst +``` + diff --git a/src/pages/docs/cli/rooms/messages/index.mdx b/src/pages/docs/cli/rooms/messages/index.mdx new file mode 100644 index 0000000000..a61bdaf1ff --- /dev/null +++ b/src/pages/docs/cli/rooms/messages/index.mdx @@ -0,0 +1,17 @@ +--- +title: "ably rooms messages" +meta_description: "Commands for working with chat messages in Ably Chat rooms using the CLI." +meta_keywords: "ably cli, cli, rooms, messages, chat, send, subscribe, history, ably rooms messages" +--- + +Use the `ably rooms messages` command group to work with chat messages in rooms. + +## Subcommands + +| Command | Description | +| ------- | ----------- | +| [`ably rooms messages send`](/docs/cli/rooms/messages/send) | Send a message to a chat room. | +| [`ably rooms messages subscribe`](/docs/cli/rooms/messages/subscribe) | Subscribe to messages in one or more chat rooms. | +| [`ably rooms messages history`](/docs/cli/rooms/messages/history) | Get historical messages from a chat room. | +| [`ably rooms messages update`](/docs/cli/rooms/messages/update) | Update a message in a chat room. | +| [`ably rooms messages delete`](/docs/cli/rooms/messages/delete) | Delete a message in a chat room. | diff --git a/src/pages/docs/cli/rooms/messages/reactions/index.mdx b/src/pages/docs/cli/rooms/messages/reactions/index.mdx new file mode 100644 index 0000000000..53bcf576b3 --- /dev/null +++ b/src/pages/docs/cli/rooms/messages/reactions/index.mdx @@ -0,0 +1,15 @@ +--- +title: "ably rooms messages reactions" +meta_description: "Commands for working with message reactions in Ably Chat rooms using the CLI." +meta_keywords: "ably cli, cli, rooms, messages, reactions, chat, ably rooms messages reactions" +--- + +Use the `ably rooms messages reactions` command group to work with message reactions in chat rooms. + +## Subcommands + +| Command | Description | +| ------- | ----------- | +| [`ably rooms messages reactions send`](/docs/cli/rooms/messages/reactions/send) | Send a reaction to a message. | +| [`ably rooms messages reactions subscribe`](/docs/cli/rooms/messages/reactions/subscribe) | Subscribe to message reactions. | +| [`ably rooms messages reactions remove`](/docs/cli/rooms/messages/reactions/remove) | Remove a reaction from a message. | diff --git a/src/pages/docs/cli/rooms/messages/reactions/remove.mdx b/src/pages/docs/cli/rooms/messages/reactions/remove.mdx new file mode 100644 index 0000000000..bb1b3370a0 --- /dev/null +++ b/src/pages/docs/cli/rooms/messages/reactions/remove.mdx @@ -0,0 +1,67 @@ +--- +title: "ably rooms messages reactions remove" +meta_description: "Remove a reaction from a message in an Ably Chat room using the CLI." +meta_keywords: "ably cli, cli, rooms, messages, reactions, remove, chat, ably rooms messages reactions remove" +--- + + +```shell +ably rooms messages reactions remove [flags] +``` + + +Use the `ably rooms messages reactions remove` command to remove a reaction from a message in a chat room. + +## Arguments + +Pass the following arguments to the `ably rooms messages reactions remove` command: + +### `` + +The name of the chat room containing the message. + +### `` + +The serial identifier of the message to remove the reaction from. + +### `` + +The emoji reaction to remove. + +## Flags + +You can optionally pass the following flags to the `ably rooms messages reactions remove` command: + +### `--type` + +The type of reaction to remove. Options are `unique`, `distinct`, or `multiple`. + +### `--client-id` + +A client ID to use when removing the reaction. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Remove a reaction from a message: + + +```shell +ably rooms messages reactions remove my-room "01a2b3c4d5@1234567890000-0" "thumbsup" +``` + + +Remove a reaction with a specific type: + + +```shell +ably rooms messages reactions remove my-room "01a2b3c4d5@1234567890000-0" "heart" --type unique +``` + diff --git a/src/pages/docs/cli/rooms/messages/reactions/send.mdx b/src/pages/docs/cli/rooms/messages/reactions/send.mdx new file mode 100644 index 0000000000..d54b463bfe --- /dev/null +++ b/src/pages/docs/cli/rooms/messages/reactions/send.mdx @@ -0,0 +1,79 @@ +--- +title: "ably rooms messages reactions send" +meta_description: "Send a reaction to a message in an Ably Chat room using the CLI." +meta_keywords: "ably cli, cli, rooms, messages, reactions, send, chat, ably rooms messages reactions send" +--- + + +```shell +ably rooms messages reactions send [flags] +``` + + +Use the `ably rooms messages reactions send` command to send a reaction to a message in a chat room. + +## Arguments + +Pass the following arguments to the `ably rooms messages reactions send` command: + +### `` + +The name of the chat room containing the message. + +### `` + +The serial identifier of the message to react to. + +### `` + +The emoji reaction to send. + +## Flags + +You can optionally pass the following flags to the `ably rooms messages reactions send` command: + +### `--type` + +The type of reaction. Options are `unique`, `distinct`, or `multiple`. + +### `--count` + +The number of reactions to send. Only applicable when `--type` is set to `multiple`. + +### `--client-id` + +A client ID to use when sending the reaction. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Send a reaction to a message: + + +```shell +ably rooms messages reactions send my-room "01a2b3c4d5@1234567890000-0" "thumbsup" +``` + + +Send a reaction with a specific type: + + +```shell +ably rooms messages reactions send my-room "01a2b3c4d5@1234567890000-0" "heart" --type unique +``` + + +Send multiple reactions: + + +```shell +ably rooms messages reactions send my-room "01a2b3c4d5@1234567890000-0" "clap" --type multiple --count 5 +``` + diff --git a/src/pages/docs/cli/rooms/messages/reactions/subscribe.mdx b/src/pages/docs/cli/rooms/messages/reactions/subscribe.mdx new file mode 100644 index 0000000000..3b58a20f98 --- /dev/null +++ b/src/pages/docs/cli/rooms/messages/reactions/subscribe.mdx @@ -0,0 +1,63 @@ +--- +title: "ably rooms messages reactions subscribe" +meta_description: "Subscribe to message reactions in an Ably Chat room using the CLI." +meta_keywords: "ably cli, cli, rooms, messages, reactions, subscribe, chat, ably rooms messages reactions subscribe" +--- + + +```shell +ably rooms messages reactions subscribe [flags] +``` + + +Use the `ably rooms messages reactions subscribe` command to subscribe to message reactions in a chat room. + +## Arguments + +Pass the following arguments to the `ably rooms messages reactions subscribe` command: + +### `` + +The name of the chat room to subscribe to message reactions in. + +## Flags + +You can optionally pass the following flags to the `ably rooms messages reactions subscribe` command: + +### `--raw` + +Get raw events instead of summaries. Defaults to `false`. + +### `--duration | -D` + +The duration in seconds to subscribe for before automatically unsubscribing. + +### `--client-id` + +A client ID to use for the subscription. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Subscribe to message reactions in a room: + + +```shell +ably rooms messages reactions subscribe my-room +``` + + +Subscribe and get raw events: + + +```shell +ably rooms messages reactions subscribe my-room --raw +``` + diff --git a/src/pages/docs/cli/rooms/messages/send.mdx b/src/pages/docs/cli/rooms/messages/send.mdx new file mode 100644 index 0000000000..a74eb217a7 --- /dev/null +++ b/src/pages/docs/cli/rooms/messages/send.mdx @@ -0,0 +1,83 @@ +--- +title: "ably rooms messages send" +meta_description: "Send a message to an Ably Chat room using the CLI." +meta_keywords: "ably cli, cli, rooms, messages, send, chat, ably rooms messages send" +--- + + +```shell +ably rooms messages send [flags] +``` + + +Use the `ably rooms messages send` command to send a message to an Ably Chat room. + + + +## Arguments + +Pass the following arguments to the `ably rooms messages send` command: + +### `` + +The name of the chat room to send the message to. + +### `` + +The text content of the message. + +## Flags + +You can optionally pass the following flags to the `ably rooms messages send` command: + +### `--count | -c` + +The number of messages to send. Defaults to `1`. + +### `--delay | -d` + +The delay between messages in milliseconds when sending multiple messages. Defaults to `40`. + +### `--metadata` + +A JSON string of metadata to attach to the message. + +### `--client-id` + +A client ID to use when sending the message. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Send a message to a chat room: + + +```shell +ably rooms messages send my-room "Hello, world!" +``` + + +Send multiple messages with interpolation: + + +```shell +ably rooms messages send my-room "Message {{.Count}} at {{.Timestamp}}" --count 10 +``` + + +Send a message with metadata: + + +```shell +ably rooms messages send my-room "Hello" --metadata '{"priority": "high"}' +``` + diff --git a/src/pages/docs/cli/rooms/messages/subscribe.mdx b/src/pages/docs/cli/rooms/messages/subscribe.mdx new file mode 100644 index 0000000000..9bd231ce2e --- /dev/null +++ b/src/pages/docs/cli/rooms/messages/subscribe.mdx @@ -0,0 +1,75 @@ +--- +title: "ably rooms messages subscribe" +meta_description: "Subscribe to messages in one or more Ably Chat rooms using the CLI." +meta_keywords: "ably cli, cli, rooms, messages, subscribe, chat, ably rooms messages subscribe" +--- + + +```shell +ably rooms messages subscribe [flags] +``` + + +Use the `ably rooms messages subscribe` command to subscribe to messages in one or more Ably Chat rooms. + +## Arguments + +Pass the following arguments to the `ably rooms messages subscribe` command: + +### `` + +The names of the chat rooms to subscribe to. + +## Flags + +You can optionally pass the following flags to the `ably rooms messages subscribe` command: + +### `--show-metadata` + +Display metadata attached to messages. Defaults to `false`. + +### `--duration | -D` + +The duration in seconds to subscribe for before automatically unsubscribing. + +### `--sequence-numbers` + +Display sequence numbers for messages. Defaults to `false`. + +### `--client-id` + +A client ID to use for the subscription. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Subscribe to messages in a single room: + + +```shell +ably rooms messages subscribe my-room +``` + + +Subscribe to messages in multiple rooms: + + +```shell +ably rooms messages subscribe my-room another-room +``` + + +Subscribe and show metadata: + + +```shell +ably rooms messages subscribe my-room --show-metadata +``` + diff --git a/src/pages/docs/cli/rooms/messages/update.mdx b/src/pages/docs/cli/rooms/messages/update.mdx new file mode 100644 index 0000000000..4f5070e42e --- /dev/null +++ b/src/pages/docs/cli/rooms/messages/update.mdx @@ -0,0 +1,83 @@ +--- +title: "ably rooms messages update" +meta_description: "Update a message in an Ably Chat room using the CLI." +meta_keywords: "ably cli, cli, rooms, messages, update, chat, ably rooms messages update" +--- + + +```shell +ably rooms messages update [flags] +``` + + +Use the `ably rooms messages update` command to update a message in an Ably Chat room. + +## Arguments + +Pass the following arguments to the `ably rooms messages update` command: + +### `` + +The name of the chat room containing the message. + +### `` + +The serial identifier of the message to update. + +### `` + +The new text content for the message. + +## Flags + +You can optionally pass the following flags to the `ably rooms messages update` command: + +### `--description` + +A description of the update. + +### `--headers` + +A JSON string of headers to attach to the update. + +### `--metadata` + +A JSON string of metadata to attach to the updated message. + +### `--client-id` + +A client ID to use when updating the message. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Update a message: + + +```shell +ably rooms messages update my-room "01a2b3c4d5@1234567890000-0" "Updated message text" +``` + + +Update a message with a description: + + +```shell +ably rooms messages update my-room "01a2b3c4d5@1234567890000-0" "Fixed typo" --description "Corrected spelling" +``` + + +Update a message with metadata: + + +```shell +ably rooms messages update my-room "01a2b3c4d5@1234567890000-0" "Edited message" --metadata '{"edited": true}' +``` + diff --git a/src/pages/docs/cli/rooms/occupancy/get.mdx b/src/pages/docs/cli/rooms/occupancy/get.mdx new file mode 100644 index 0000000000..acb2203d4b --- /dev/null +++ b/src/pages/docs/cli/rooms/occupancy/get.mdx @@ -0,0 +1,51 @@ +--- +title: "ably rooms occupancy get" +meta_description: "Get current occupancy metrics for an Ably Chat room using the CLI." +meta_keywords: "ably cli, cli, rooms, occupancy, get, chat, metrics, ably rooms occupancy get" +--- + + +```shell +ably rooms occupancy get [flags] +``` + + +Use the `ably rooms occupancy get` command to get the current occupancy metrics for a chat room. + +## Arguments + +Pass the following arguments to the `ably rooms occupancy get` command: + +### `` + +The name of the chat room to get occupancy for. + +## Flags + +You can optionally pass the following flags to the `ably rooms occupancy get` command: + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Get current occupancy for a room: + + +```shell +ably rooms occupancy get my-room +``` + + +Get occupancy in JSON format: + + +```shell +ably rooms occupancy get my-room --json +``` + diff --git a/src/pages/docs/cli/rooms/occupancy/index.mdx b/src/pages/docs/cli/rooms/occupancy/index.mdx new file mode 100644 index 0000000000..63f7bb21e0 --- /dev/null +++ b/src/pages/docs/cli/rooms/occupancy/index.mdx @@ -0,0 +1,14 @@ +--- +title: "ably rooms occupancy" +meta_description: "Commands for monitoring room occupancy in Ably Chat using the CLI." +meta_keywords: "ably cli, cli, rooms, occupancy, chat, metrics, ably rooms occupancy" +--- + +Use the `ably rooms occupancy` command group to monitor room occupancy in chat rooms. + +## Subcommands + +| Command | Description | +| ------- | ----------- | +| [`ably rooms occupancy get`](/docs/cli/rooms/occupancy/get) | Get current occupancy metrics for a room. | +| [`ably rooms occupancy subscribe`](/docs/cli/rooms/occupancy/subscribe) | Subscribe to real-time occupancy metrics for a room. | diff --git a/src/pages/docs/cli/rooms/occupancy/subscribe.mdx b/src/pages/docs/cli/rooms/occupancy/subscribe.mdx new file mode 100644 index 0000000000..0d8e2db5ce --- /dev/null +++ b/src/pages/docs/cli/rooms/occupancy/subscribe.mdx @@ -0,0 +1,59 @@ +--- +title: "ably rooms occupancy subscribe" +meta_description: "Subscribe to real-time occupancy metrics for an Ably Chat room using the CLI." +meta_keywords: "ably cli, cli, rooms, occupancy, subscribe, chat, metrics, ably rooms occupancy subscribe" +--- + + +```shell +ably rooms occupancy subscribe [flags] +``` + + +Use the `ably rooms occupancy subscribe` command to subscribe to real-time occupancy metrics for a chat room. + +## Arguments + +Pass the following arguments to the `ably rooms occupancy subscribe` command: + +### `` + +The name of the chat room to subscribe to occupancy metrics for. + +## Flags + +You can optionally pass the following flags to the `ably rooms occupancy subscribe` command: + +### `--duration | -D` + +The duration in seconds to subscribe for before automatically unsubscribing. + +### `--client-id` + +A client ID to use for the subscription. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Subscribe to occupancy metrics for a room: + + +```shell +ably rooms occupancy subscribe my-room +``` + + +Subscribe for a specific duration: + + +```shell +ably rooms occupancy subscribe my-room --duration 60 +``` + diff --git a/src/pages/docs/cli/rooms/presence/enter.mdx b/src/pages/docs/cli/rooms/presence/enter.mdx new file mode 100644 index 0000000000..048d3a9cc3 --- /dev/null +++ b/src/pages/docs/cli/rooms/presence/enter.mdx @@ -0,0 +1,79 @@ +--- +title: "ably rooms presence enter" +meta_description: "Enter presence in an Ably Chat room using the CLI." +meta_keywords: "ably cli, cli, rooms, presence, enter, chat, ably rooms presence enter" +--- + + +```shell +ably rooms presence enter [flags] +``` + + +Use the `ably rooms presence enter` command to enter presence in a chat room and remain present until terminated. + +## Arguments + +Pass the following arguments to the `ably rooms presence enter` command: + +### `` + +The name of the chat room to enter presence in. + +## Flags + +You can optionally pass the following flags to the `ably rooms presence enter` command: + +### `--data` + +A JSON string of data to associate with the presence member. + +### `--show-others` + +Display presence events from other members while present. Defaults to `false`. + +### `--duration | -D` + +The duration in seconds to remain present before automatically leaving. + +### `--sequence-numbers` + +Display sequence numbers for presence events. Defaults to `false`. + +### `--client-id` + +A client ID to use when entering presence. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Enter presence in a room: + + +```shell +ably rooms presence enter my-room +``` + + +Enter presence with data: + + +```shell +ably rooms presence enter my-room --data '{"status": "online", "name": "Alice"}' +``` + + +Enter presence and show other members' events: + + +```shell +ably rooms presence enter my-room --show-others +``` + diff --git a/src/pages/docs/cli/rooms/presence/get.mdx b/src/pages/docs/cli/rooms/presence/get.mdx new file mode 100644 index 0000000000..9654ee1c54 --- /dev/null +++ b/src/pages/docs/cli/rooms/presence/get.mdx @@ -0,0 +1,55 @@ +--- +title: "ably rooms presence get" +meta_description: "Get current presence members in an Ably Chat room using the CLI." +meta_keywords: "ably cli, cli, rooms, presence, get, chat, members, ably rooms presence get" +--- + + +```shell +ably rooms presence get [flags] +``` + + +Use the `ably rooms presence get` command to get all current presence members in a chat room. + +## Arguments + +Pass the following arguments to the `ably rooms presence get` command: + +### `` + +The name of the chat room to get presence members for. + +## Flags + +You can optionally pass the following flags to the `ably rooms presence get` command: + +### `--limit` + +The maximum number of presence members to return. Defaults to `100`. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Get all presence members in a room: + + +```shell +ably rooms presence get my-room +``` + + +Get presence members with a limit: + + +```shell +ably rooms presence get my-room --limit 10 +``` + diff --git a/src/pages/docs/cli/rooms/presence/index.mdx b/src/pages/docs/cli/rooms/presence/index.mdx new file mode 100644 index 0000000000..2eafe4464f --- /dev/null +++ b/src/pages/docs/cli/rooms/presence/index.mdx @@ -0,0 +1,15 @@ +--- +title: "ably rooms presence" +meta_description: "Commands for working with presence in Ably Chat rooms using the CLI." +meta_keywords: "ably cli, cli, rooms, presence, chat, members, ably rooms presence" +--- + +Use the `ably rooms presence` command group to work with presence in chat rooms. + +## Subcommands + +| Command | Description | +| ------- | ----------- | +| [`ably rooms presence enter`](/docs/cli/rooms/presence/enter) | Enter presence in a chat room. | +| [`ably rooms presence get`](/docs/cli/rooms/presence/get) | Get current presence members in a chat room. | +| [`ably rooms presence subscribe`](/docs/cli/rooms/presence/subscribe) | Subscribe to presence events in a chat room. | diff --git a/src/pages/docs/cli/rooms/presence/subscribe.mdx b/src/pages/docs/cli/rooms/presence/subscribe.mdx new file mode 100644 index 0000000000..3696f266a3 --- /dev/null +++ b/src/pages/docs/cli/rooms/presence/subscribe.mdx @@ -0,0 +1,59 @@ +--- +title: "ably rooms presence subscribe" +meta_description: "Subscribe to presence events in an Ably Chat room using the CLI." +meta_keywords: "ably cli, cli, rooms, presence, subscribe, chat, events, ably rooms presence subscribe" +--- + + +```shell +ably rooms presence subscribe [flags] +``` + + +Use the `ably rooms presence subscribe` command to subscribe to presence events in a chat room. + +## Arguments + +Pass the following arguments to the `ably rooms presence subscribe` command: + +### `` + +The name of the chat room to subscribe to presence events in. + +## Flags + +You can optionally pass the following flags to the `ably rooms presence subscribe` command: + +### `--duration | -D` + +The duration in seconds to subscribe for before automatically unsubscribing. + +### `--client-id` + +A client ID to use for the subscription. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Subscribe to presence events in a room: + + +```shell +ably rooms presence subscribe my-room +``` + + +Subscribe for a specific duration: + + +```shell +ably rooms presence subscribe my-room --duration 120 +``` + diff --git a/src/pages/docs/cli/rooms/reactions/index.mdx b/src/pages/docs/cli/rooms/reactions/index.mdx new file mode 100644 index 0000000000..7d7a5dd85e --- /dev/null +++ b/src/pages/docs/cli/rooms/reactions/index.mdx @@ -0,0 +1,14 @@ +--- +title: "ably rooms reactions" +meta_description: "Commands for working with room-level reactions in Ably Chat using the CLI." +meta_keywords: "ably cli, cli, rooms, reactions, chat, emoji, ably rooms reactions" +--- + +Use the `ably rooms reactions` command group to work with room-level reactions in chat rooms. + +## Subcommands + +| Command | Description | +| ------- | ----------- | +| [`ably rooms reactions send`](/docs/cli/rooms/reactions/send) | Send a reaction in a chat room. | +| [`ably rooms reactions subscribe`](/docs/cli/rooms/reactions/subscribe) | Subscribe to reactions in a chat room. | diff --git a/src/pages/docs/cli/rooms/reactions/send.mdx b/src/pages/docs/cli/rooms/reactions/send.mdx new file mode 100644 index 0000000000..fb1a108196 --- /dev/null +++ b/src/pages/docs/cli/rooms/reactions/send.mdx @@ -0,0 +1,63 @@ +--- +title: "ably rooms reactions send" +meta_description: "Send a reaction in an Ably Chat room using the CLI." +meta_keywords: "ably cli, cli, rooms, reactions, send, chat, emoji, ably rooms reactions send" +--- + + +```shell +ably rooms reactions send [flags] +``` + + +Use the `ably rooms reactions send` command to send a reaction in a chat room. + +## Arguments + +Pass the following arguments to the `ably rooms reactions send` command: + +### `` + +The name of the chat room to send the reaction in. + +### `` + +The emoji reaction to send. + +## Flags + +You can optionally pass the following flags to the `ably rooms reactions send` command: + +### `--metadata` + +A JSON string of metadata to attach to the reaction. + +### `--client-id` + +A client ID to use when sending the reaction. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Send a reaction in a room: + + +```shell +ably rooms reactions send my-room "heart" +``` + + +Send a reaction with metadata: + + +```shell +ably rooms reactions send my-room "thumbsup" --metadata '{"context": "great idea"}' +``` + diff --git a/src/pages/docs/cli/rooms/reactions/subscribe.mdx b/src/pages/docs/cli/rooms/reactions/subscribe.mdx new file mode 100644 index 0000000000..2c95a67bb1 --- /dev/null +++ b/src/pages/docs/cli/rooms/reactions/subscribe.mdx @@ -0,0 +1,59 @@ +--- +title: "ably rooms reactions subscribe" +meta_description: "Subscribe to reactions in an Ably Chat room using the CLI." +meta_keywords: "ably cli, cli, rooms, reactions, subscribe, chat, emoji, ably rooms reactions subscribe" +--- + + +```shell +ably rooms reactions subscribe [flags] +``` + + +Use the `ably rooms reactions subscribe` command to subscribe to reactions in a chat room. + +## Arguments + +Pass the following arguments to the `ably rooms reactions subscribe` command: + +### `` + +The name of the chat room to subscribe to reactions in. + +## Flags + +You can optionally pass the following flags to the `ably rooms reactions subscribe` command: + +### `--duration | -D` + +The duration in seconds to subscribe for before automatically unsubscribing. + +### `--client-id` + +A client ID to use for the subscription. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Subscribe to reactions in a room: + + +```shell +ably rooms reactions subscribe my-room +``` + + +Subscribe for a specific duration: + + +```shell +ably rooms reactions subscribe my-room --duration 60 +``` + diff --git a/src/pages/docs/cli/rooms/typing/index.mdx b/src/pages/docs/cli/rooms/typing/index.mdx new file mode 100644 index 0000000000..ef0e3dc2c1 --- /dev/null +++ b/src/pages/docs/cli/rooms/typing/index.mdx @@ -0,0 +1,14 @@ +--- +title: "ably rooms typing" +meta_description: "Commands for working with typing indicators in Ably Chat rooms using the CLI." +meta_keywords: "ably cli, cli, rooms, typing, chat, indicators, ably rooms typing" +--- + +Use the `ably rooms typing` command group to work with typing indicators in chat rooms. + +## Subcommands + +| Command | Description | +| ------- | ----------- | +| [`ably rooms typing keystroke`](/docs/cli/rooms/typing/keystroke) | Send a typing indicator in a chat room. | +| [`ably rooms typing subscribe`](/docs/cli/rooms/typing/subscribe) | Subscribe to typing indicators in a chat room. | diff --git a/src/pages/docs/cli/rooms/typing/keystroke.mdx b/src/pages/docs/cli/rooms/typing/keystroke.mdx new file mode 100644 index 0000000000..5f4a8c958c --- /dev/null +++ b/src/pages/docs/cli/rooms/typing/keystroke.mdx @@ -0,0 +1,63 @@ +--- +title: "ably rooms typing keystroke" +meta_description: "Send a typing indicator in an Ably Chat room using the CLI." +meta_keywords: "ably cli, cli, rooms, typing, keystroke, chat, indicator, ably rooms typing keystroke" +--- + + +```shell +ably rooms typing keystroke [flags] +``` + + +Use the `ably rooms typing keystroke` command to send a typing indicator in an Ably Chat room. + +## Arguments + +Pass the following arguments to the `ably rooms typing keystroke` command: + +### `` + +The name of the chat room to send the typing indicator in. + +## Flags + +You can optionally pass the following flags to the `ably rooms typing keystroke` command: + +### `--auto-type` + +Keep the typing indicator active continuously. Defaults to `false`. + +### `--duration | -D` + +The duration in seconds to keep the typing indicator active. + +### `--client-id` + +A client ID to use when sending the typing indicator. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Send a typing indicator: + + +```shell +ably rooms typing keystroke my-room +``` + + +Keep the typing indicator active continuously: + + +```shell +ably rooms typing keystroke my-room --auto-type +``` + diff --git a/src/pages/docs/cli/rooms/typing/subscribe.mdx b/src/pages/docs/cli/rooms/typing/subscribe.mdx new file mode 100644 index 0000000000..4e16880e8c --- /dev/null +++ b/src/pages/docs/cli/rooms/typing/subscribe.mdx @@ -0,0 +1,59 @@ +--- +title: "ably rooms typing subscribe" +meta_description: "Subscribe to typing indicators in an Ably Chat room using the CLI." +meta_keywords: "ably cli, cli, rooms, typing, subscribe, chat, indicators, ably rooms typing subscribe" +--- + + +```shell +ably rooms typing subscribe [flags] +``` + + +Use the `ably rooms typing subscribe` command to subscribe to typing indicators in an Ably Chat room. + +## Arguments + +Pass the following arguments to the `ably rooms typing subscribe` command: + +### `` + +The name of the chat room to subscribe to typing indicators in. + +## Flags + +You can optionally pass the following flags to the `ably rooms typing subscribe` command: + +### `--duration | -D` + +The duration in seconds to subscribe for before automatically unsubscribing. + +### `--client-id` + +A client ID to use for the subscription. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Subscribe to typing indicators in a room: + + +```shell +ably rooms typing subscribe my-room +``` + + +Subscribe for a specific duration: + + +```shell +ably rooms typing subscribe my-room --duration 60 +``` + diff --git a/src/pages/docs/cli/spaces/create.mdx b/src/pages/docs/cli/spaces/create.mdx new file mode 100644 index 0000000000..ebbf7267bf --- /dev/null +++ b/src/pages/docs/cli/spaces/create.mdx @@ -0,0 +1,55 @@ +--- +title: "ably spaces create" +meta_description: "Initialize an Ably Space without entering it using the CLI." +meta_keywords: "ably cli, cli, spaces, create, initialize, ably spaces create" +--- + + +```shell +ably spaces create [flags] +``` + + +Use the `ably spaces create` command to initialize a space without entering it. + +## Arguments + +Pass the following arguments to the `ably spaces create` command: + +### `` + +The name of the space to create. + +## Flags + +You can optionally pass the following flags to the `ably spaces create` command: + +### `--client-id` + +A client ID to use when creating the space. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Create a space: + + +```shell +ably spaces create my-space +``` + + +Create a space with a specific client ID: + + +```shell +ably spaces create my-space --client-id "user-123" +``` + diff --git a/src/pages/docs/cli/spaces/cursors/get.mdx b/src/pages/docs/cli/spaces/cursors/get.mdx new file mode 100644 index 0000000000..abe12cabc9 --- /dev/null +++ b/src/pages/docs/cli/spaces/cursors/get.mdx @@ -0,0 +1,51 @@ +--- +title: "ably spaces cursors get" +meta_description: "Get all current cursors in an Ably Space using the CLI." +meta_keywords: "ably cli, cli, spaces, cursors, get, position, ably spaces cursors get" +--- + + +```shell +ably spaces cursors get +``` + + +Use the `ably spaces cursors get` command to get all current cursors in a space. + +## Arguments + +Pass the following arguments to the `ably spaces cursors get` command: + +### `` + +The name of the space to get cursors for. + +## Flags + +You can optionally pass the following flags to the `ably spaces cursors get` command: + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Get all cursors in a space: + + +```shell +ably spaces cursors get my-space +``` + + +Get cursors in JSON format: + + +```shell +ably spaces cursors get my-space --json +``` + diff --git a/src/pages/docs/cli/spaces/cursors/index.mdx b/src/pages/docs/cli/spaces/cursors/index.mdx new file mode 100644 index 0000000000..73ae25d111 --- /dev/null +++ b/src/pages/docs/cli/spaces/cursors/index.mdx @@ -0,0 +1,15 @@ +--- +title: "ably spaces cursors" +meta_description: "Commands for cursor management in Ably Spaces using the CLI." +meta_keywords: "ably cli, cli, spaces, cursors, position, tracking, ably spaces cursors" +--- + +Use the `ably spaces cursors` command group to manage cursors in Ably Spaces. + +## Subcommands + +| Command | Description | +| ------- | ----------- | +| [`ably spaces cursors get`](/docs/cli/spaces/cursors/get) | Get all current cursors in a space. | +| [`ably spaces cursors set`](/docs/cli/spaces/cursors/set) | Set a cursor with position data in a space. | +| [`ably spaces cursors subscribe`](/docs/cli/spaces/cursors/subscribe) | Subscribe to cursor movements in a space. | diff --git a/src/pages/docs/cli/spaces/cursors/set.mdx b/src/pages/docs/cli/spaces/cursors/set.mdx new file mode 100644 index 0000000000..e15806dac2 --- /dev/null +++ b/src/pages/docs/cli/spaces/cursors/set.mdx @@ -0,0 +1,83 @@ +--- +title: "ably spaces cursors set" +meta_description: "Set a cursor with position data in an Ably Space using the CLI." +meta_keywords: "ably cli, cli, spaces, cursors, set, position, ably spaces cursors set" +--- + + +```shell +ably spaces cursors set [flags] +``` + + +Use the `ably spaces cursors set` command to set a cursor with position data in a space. + +## Arguments + +Pass the following arguments to the `ably spaces cursors set` command: + +### `` + +The name of the space to set the cursor in. + +## Flags + +You can optionally pass the following flags to the `ably spaces cursors set` command: + +### `--x` + +The x coordinate of the cursor position. + +### `--y` + +The y coordinate of the cursor position. + +### `--data` + +JSON cursor data to associate with the cursor. + +### `--simulate` + +Simulate random cursor movement. Defaults to `false`. + +### `--duration | -D` + +The duration in seconds to maintain the cursor before automatically removing it. + +### `--client-id` + +A client ID to use when setting the cursor. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Set a cursor position: + + +```shell +ably spaces cursors set my-space --x 100 --y 200 +``` + + +Set a cursor with additional data: + + +```shell +ably spaces cursors set my-space --x 100 --y 200 --data '{"color": "red"}' +``` + + +Simulate random cursor movement: + + +```shell +ably spaces cursors set my-space --simulate --duration 30 +``` + diff --git a/src/pages/docs/cli/spaces/cursors/subscribe.mdx b/src/pages/docs/cli/spaces/cursors/subscribe.mdx new file mode 100644 index 0000000000..de77d4acb6 --- /dev/null +++ b/src/pages/docs/cli/spaces/cursors/subscribe.mdx @@ -0,0 +1,59 @@ +--- +title: "ably spaces cursors subscribe" +meta_description: "Subscribe to cursor movements in an Ably Space using the CLI." +meta_keywords: "ably cli, cli, spaces, cursors, subscribe, movements, ably spaces cursors subscribe" +--- + + +```shell +ably spaces cursors subscribe [flags] +``` + + +Use the `ably spaces cursors subscribe` command to subscribe to cursor movements in a space. + +## Arguments + +Pass the following arguments to the `ably spaces cursors subscribe` command: + +### `` + +The name of the space to subscribe to cursor movements in. + +## Flags + +You can optionally pass the following flags to the `ably spaces cursors subscribe` command: + +### `--duration | -D` + +The duration in seconds to subscribe for before automatically unsubscribing. + +### `--client-id` + +A client ID to use when subscribing. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Subscribe to cursor movements in a space: + + +```shell +ably spaces cursors subscribe my-space +``` + + +Subscribe for a specific duration: + + +```shell +ably spaces cursors subscribe my-space --duration 60 +``` + diff --git a/src/pages/docs/cli/spaces/get.mdx b/src/pages/docs/cli/spaces/get.mdx new file mode 100644 index 0000000000..694c2b0b01 --- /dev/null +++ b/src/pages/docs/cli/spaces/get.mdx @@ -0,0 +1,51 @@ +--- +title: "ably spaces get" +meta_description: "Get the current state of an Ably Space using the CLI." +meta_keywords: "ably cli, cli, spaces, get, state, ably spaces get" +--- + + +```shell +ably spaces get +``` + + +Use the `ably spaces get` command to get the current state of a space. + +## Arguments + +Pass the following arguments to the `ably spaces get` command: + +### `` + +The name of the space to get. + +## Flags + +You can optionally pass the following flags to the `ably spaces get` command: + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Get the current state of a space: + + +```shell +ably spaces get my-space +``` + + +Get the state of a space in JSON format: + + +```shell +ably spaces get my-space --json +``` + diff --git a/src/pages/docs/cli/spaces/index.mdx b/src/pages/docs/cli/spaces/index.mdx new file mode 100644 index 0000000000..1715597f10 --- /dev/null +++ b/src/pages/docs/cli/spaces/index.mdx @@ -0,0 +1,60 @@ +--- +title: "ably spaces" +meta_description: "Interact with Ably Spaces using the CLI." +meta_keywords: "ably cli, cli, spaces, cursors, locations, locks, members, occupancy, ably spaces" +--- + +Use the `ably spaces` command group to interact with Ably Spaces. These commands enable you to create and manage spaces, track cursors, locations, locks, members, and occupancy. + +## Space management + +| Command | Description | +| ------- | ----------- | +| [`ably spaces create`](/docs/cli/spaces/create) | Initialize a space without entering it. | +| [`ably spaces get`](/docs/cli/spaces/get) | Get the current state of a space. | +| [`ably spaces list`](/docs/cli/spaces/list) | List active spaces. | +| [`ably spaces subscribe`](/docs/cli/spaces/subscribe) | Subscribe to member and location update events in a space. | + +## Cursors + +| Command | Description | +| ------- | ----------- | +| [`ably spaces cursors`](/docs/cli/spaces/cursors) | Commands for cursor management in Ably Spaces. | +| [`ably spaces cursors get`](/docs/cli/spaces/cursors/get) | Get all current cursors in a space. | +| [`ably spaces cursors set`](/docs/cli/spaces/cursors/set) | Set a cursor with position data in a space. | +| [`ably spaces cursors subscribe`](/docs/cli/spaces/cursors/subscribe) | Subscribe to cursor movements in a space. | + +## Locations + +| Command | Description | +| ------- | ----------- | +| [`ably spaces locations`](/docs/cli/spaces/locations) | Commands for location management in Ably Spaces. | +| [`ably spaces locations get`](/docs/cli/spaces/locations/get) | Get all current locations in a space. | +| [`ably spaces locations set`](/docs/cli/spaces/locations/set) | Set location in a space. | +| [`ably spaces locations subscribe`](/docs/cli/spaces/locations/subscribe) | Subscribe to location updates for members in a space. | + +## Locks + +| Command | Description | +| ------- | ----------- | +| [`ably spaces locks`](/docs/cli/spaces/locks) | Commands for component locking in Ably Spaces. | +| [`ably spaces locks acquire`](/docs/cli/spaces/locks/acquire) | Acquire a lock in a space. | +| [`ably spaces locks get`](/docs/cli/spaces/locks/get) | Get a lock or all locks in a space. | +| [`ably spaces locks subscribe`](/docs/cli/spaces/locks/subscribe) | Subscribe to lock events in a space. | + +## Members + +| Command | Description | +| ------- | ----------- | +| [`ably spaces members`](/docs/cli/spaces/members) | Commands for managing members in Ably Spaces. | +| [`ably spaces members enter`](/docs/cli/spaces/members/enter) | Enter a space and remain present until terminated. | +| [`ably spaces members get`](/docs/cli/spaces/members/get) | Get all members in a space. | +| [`ably spaces members subscribe`](/docs/cli/spaces/members/subscribe) | Subscribe to member presence events in a space. | + +## Occupancy + +| Command | Description | +| ------- | ----------- | +| [`ably spaces occupancy`](/docs/cli/spaces/occupancy) | Commands for working with occupancy in Ably Spaces. | +| [`ably spaces occupancy get`](/docs/cli/spaces/occupancy/get) | Get current occupancy metrics for a space. | +| [`ably spaces occupancy subscribe`](/docs/cli/spaces/occupancy/subscribe) | Subscribe to occupancy events on a space. | diff --git a/src/pages/docs/cli/spaces/list.mdx b/src/pages/docs/cli/spaces/list.mdx new file mode 100644 index 0000000000..f9f86e2d94 --- /dev/null +++ b/src/pages/docs/cli/spaces/list.mdx @@ -0,0 +1,59 @@ +--- +title: "ably spaces list" +meta_description: "List active Ably Spaces using the CLI." +meta_keywords: "ably cli, cli, spaces, list, active, ably spaces list" +--- + + +```shell +ably spaces list [flags] +``` + + +Use the `ably spaces list` command to list active spaces. + +## Flags + +You can optionally pass the following flags to the `ably spaces list` command: + +### `--limit` + +The maximum number of spaces to return. Defaults to `100`. + +### `--prefix | -p` + +A prefix to filter spaces by name. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +List all active spaces: + + +```shell +ably spaces list +``` + + +List spaces with a prefix: + + +```shell +ably spaces list --prefix "project-" +``` + + +List spaces with a custom limit: + + +```shell +ably spaces list --limit 50 +``` + diff --git a/src/pages/docs/cli/spaces/locations/get.mdx b/src/pages/docs/cli/spaces/locations/get.mdx new file mode 100644 index 0000000000..133b0c0321 --- /dev/null +++ b/src/pages/docs/cli/spaces/locations/get.mdx @@ -0,0 +1,51 @@ +--- +title: "ably spaces locations get" +meta_description: "Get all current locations in an Ably Space using the CLI." +meta_keywords: "ably cli, cli, spaces, locations, get, ably spaces locations get" +--- + + +```shell +ably spaces locations get +``` + + +Use the `ably spaces locations get` command to get all current locations in a space. + +## Arguments + +Pass the following arguments to the `ably spaces locations get` command: + +### `` + +The name of the space to get locations for. + +## Flags + +You can optionally pass the following flags to the `ably spaces locations get` command: + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Get all current locations in a space: + + +```shell +ably spaces locations get my-space +``` + + +Get locations in JSON format: + + +```shell +ably spaces locations get my-space --json +``` + diff --git a/src/pages/docs/cli/spaces/locations/index.mdx b/src/pages/docs/cli/spaces/locations/index.mdx new file mode 100644 index 0000000000..ae99a7df7f --- /dev/null +++ b/src/pages/docs/cli/spaces/locations/index.mdx @@ -0,0 +1,15 @@ +--- +title: "ably spaces locations" +meta_description: "Commands for location management in Ably Spaces using the CLI." +meta_keywords: "ably cli, cli, spaces, locations, tracking, ably spaces locations" +--- + +Use the `ably spaces locations` command group to manage locations in Ably Spaces. + +## Subcommands + +| Command | Description | +| ------- | ----------- | +| [`ably spaces locations get`](/docs/cli/spaces/locations/get) | Get all current locations in a space. | +| [`ably spaces locations set`](/docs/cli/spaces/locations/set) | Set location in a space. | +| [`ably spaces locations subscribe`](/docs/cli/spaces/locations/subscribe) | Subscribe to location updates for members in a space. | diff --git a/src/pages/docs/cli/spaces/locations/set.mdx b/src/pages/docs/cli/spaces/locations/set.mdx new file mode 100644 index 0000000000..d6867ed0c4 --- /dev/null +++ b/src/pages/docs/cli/spaces/locations/set.mdx @@ -0,0 +1,63 @@ +--- +title: "ably spaces locations set" +meta_description: "Set location in an Ably Space using the CLI." +meta_keywords: "ably cli, cli, spaces, locations, set, ably spaces locations set" +--- + + +```shell +ably spaces locations set --location [flags] +``` + + +Use the `ably spaces locations set` command to set location in a space. + +## Arguments + +Pass the following arguments to the `ably spaces locations set` command: + +### `` + +The name of the space to set the location in. + +## Flags + +You can optionally pass the following flags to the `ably spaces locations set` command: + +### `--location` + +JSON location data to set. This flag is required. + +### `--duration | -D` + +The duration in seconds to maintain the location before automatically removing it. + +### `--client-id` + +A client ID to use when setting the location. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Set a location in a space: + + +```shell +ably spaces locations set my-space --location '{"page": "sheet-1", "cell": "A1"}' +``` + + +Set a location with a specific duration: + + +```shell +ably spaces locations set my-space --location '{"slide": 5}' --duration 120 +``` + diff --git a/src/pages/docs/cli/spaces/locations/subscribe.mdx b/src/pages/docs/cli/spaces/locations/subscribe.mdx new file mode 100644 index 0000000000..7213744d47 --- /dev/null +++ b/src/pages/docs/cli/spaces/locations/subscribe.mdx @@ -0,0 +1,59 @@ +--- +title: "ably spaces locations subscribe" +meta_description: "Subscribe to location updates for members in an Ably Space using the CLI." +meta_keywords: "ably cli, cli, spaces, locations, subscribe, updates, ably spaces locations subscribe" +--- + + +```shell +ably spaces locations subscribe [flags] +``` + + +Use the `ably spaces locations subscribe` command to subscribe to location updates for members in a space. + +## Arguments + +Pass the following arguments to the `ably spaces locations subscribe` command: + +### `` + +The name of the space to subscribe to location updates in. + +## Flags + +You can optionally pass the following flags to the `ably spaces locations subscribe` command: + +### `--duration | -D` + +The duration in seconds to subscribe for before automatically unsubscribing. + +### `--client-id` + +A client ID to use when subscribing. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Subscribe to location updates in a space: + + +```shell +ably spaces locations subscribe my-space +``` + + +Subscribe for a specific duration: + + +```shell +ably spaces locations subscribe my-space --duration 60 +``` + diff --git a/src/pages/docs/cli/spaces/locks/acquire.mdx b/src/pages/docs/cli/spaces/locks/acquire.mdx new file mode 100644 index 0000000000..ac4a027658 --- /dev/null +++ b/src/pages/docs/cli/spaces/locks/acquire.mdx @@ -0,0 +1,75 @@ +--- +title: "ably spaces locks acquire" +meta_description: "Acquire a lock in an Ably Space using the CLI." +meta_keywords: "ably cli, cli, spaces, locks, acquire, locking, ably spaces locks acquire" +--- + + +```shell +ably spaces locks acquire [flags] +``` + + +Use the `ably spaces locks acquire` command to acquire a lock in a space. + +## Arguments + +Pass the following arguments to the `ably spaces locks acquire` command: + +### `` + +The name of the space to acquire the lock in. + +### `` + +The identifier of the lock to acquire. + +## Flags + +You can optionally pass the following flags to the `ably spaces locks acquire` command: + +### `--data` + +JSON data to associate with the lock. + +### `--duration | -D` + +The duration in seconds to hold the lock before automatically releasing it. + +### `--client-id` + +A client ID to use when acquiring the lock. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Acquire a lock in a space: + + +```shell +ably spaces locks acquire my-space my-lock +``` + + +Acquire a lock with associated data: + + +```shell +ably spaces locks acquire my-space my-lock --data '{"component": "editor"}' +``` + + +Acquire a lock for a specific duration: + + +```shell +ably spaces locks acquire my-space my-lock --duration 300 +``` + diff --git a/src/pages/docs/cli/spaces/locks/get.mdx b/src/pages/docs/cli/spaces/locks/get.mdx new file mode 100644 index 0000000000..91c1f2d154 --- /dev/null +++ b/src/pages/docs/cli/spaces/locks/get.mdx @@ -0,0 +1,55 @@ +--- +title: "ably spaces locks get" +meta_description: "Get a lock or all locks in an Ably Space using the CLI." +meta_keywords: "ably cli, cli, spaces, locks, get, ably spaces locks get" +--- + + +```shell +ably spaces locks get [lock-id] +``` + + +Use the `ably spaces locks get` command to get a lock or all locks in a space. + +## Arguments + +Pass the following arguments to the `ably spaces locks get` command: + +### `` + +The name of the space to get locks for. + +### `[lock-id]` + +The identifier of a specific lock to get. Omit to get all locks in the space. + +## Flags + +You can optionally pass the following flags to the `ably spaces locks get` command: + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Get all locks in a space: + + +```shell +ably spaces locks get my-space +``` + + +Get a specific lock: + + +```shell +ably spaces locks get my-space my-lock +``` + diff --git a/src/pages/docs/cli/spaces/locks/index.mdx b/src/pages/docs/cli/spaces/locks/index.mdx new file mode 100644 index 0000000000..1ecf9a85ac --- /dev/null +++ b/src/pages/docs/cli/spaces/locks/index.mdx @@ -0,0 +1,15 @@ +--- +title: "ably spaces locks" +meta_description: "Commands for component locking in Ably Spaces using the CLI." +meta_keywords: "ably cli, cli, spaces, locks, locking, components, ably spaces locks" +--- + +Use the `ably spaces locks` command group to manage component locking in Ably Spaces. + +## Subcommands + +| Command | Description | +| ------- | ----------- | +| [`ably spaces locks acquire`](/docs/cli/spaces/locks/acquire) | Acquire a lock in a space. | +| [`ably spaces locks get`](/docs/cli/spaces/locks/get) | Get a lock or all locks in a space. | +| [`ably spaces locks subscribe`](/docs/cli/spaces/locks/subscribe) | Subscribe to lock events in a space. | diff --git a/src/pages/docs/cli/spaces/locks/subscribe.mdx b/src/pages/docs/cli/spaces/locks/subscribe.mdx new file mode 100644 index 0000000000..f8b0b33f31 --- /dev/null +++ b/src/pages/docs/cli/spaces/locks/subscribe.mdx @@ -0,0 +1,59 @@ +--- +title: "ably spaces locks subscribe" +meta_description: "Subscribe to lock events in an Ably Space using the CLI." +meta_keywords: "ably cli, cli, spaces, locks, subscribe, events, ably spaces locks subscribe" +--- + + +```shell +ably spaces locks subscribe [flags] +``` + + +Use the `ably spaces locks subscribe` command to subscribe to lock events in a space. + +## Arguments + +Pass the following arguments to the `ably spaces locks subscribe` command: + +### `` + +The name of the space to subscribe to lock events in. + +## Flags + +You can optionally pass the following flags to the `ably spaces locks subscribe` command: + +### `--duration | -D` + +The duration in seconds to subscribe for before automatically unsubscribing. + +### `--client-id` + +A client ID to use when subscribing. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Subscribe to lock events in a space: + + +```shell +ably spaces locks subscribe my-space +``` + + +Subscribe for a specific duration: + + +```shell +ably spaces locks subscribe my-space --duration 60 +``` + diff --git a/src/pages/docs/cli/spaces/members/enter.mdx b/src/pages/docs/cli/spaces/members/enter.mdx new file mode 100644 index 0000000000..8d4813a424 --- /dev/null +++ b/src/pages/docs/cli/spaces/members/enter.mdx @@ -0,0 +1,71 @@ +--- +title: "ably spaces members enter" +meta_description: "Enter an Ably Space and remain present until terminated using the CLI." +meta_keywords: "ably cli, cli, spaces, members, enter, presence, ably spaces members enter" +--- + + +```shell +ably spaces members enter [flags] +``` + + +Use the `ably spaces members enter` command to enter a space and remain present until terminated. + +## Arguments + +Pass the following arguments to the `ably spaces members enter` command: + +### `` + +The name of the space to enter. + +## Flags + +You can optionally pass the following flags to the `ably spaces members enter` command: + +### `--profile` + +JSON profile data to associate with the member. + +### `--duration | -D` + +The duration in seconds to remain present before automatically leaving. + +### `--client-id` + +A client ID to use when entering the space. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Enter a space: + + +```shell +ably spaces members enter my-space +``` + + +Enter a space with profile data: + + +```shell +ably spaces members enter my-space --profile '{"name": "Alice", "avatar": "avatar-1"}' +``` + + +Enter a space for a specific duration: + + +```shell +ably spaces members enter my-space --duration 120 +``` + diff --git a/src/pages/docs/cli/spaces/members/get.mdx b/src/pages/docs/cli/spaces/members/get.mdx new file mode 100644 index 0000000000..35b126036c --- /dev/null +++ b/src/pages/docs/cli/spaces/members/get.mdx @@ -0,0 +1,51 @@ +--- +title: "ably spaces members get" +meta_description: "Get all members in an Ably Space using the CLI." +meta_keywords: "ably cli, cli, spaces, members, get, presence, ably spaces members get" +--- + + +```shell +ably spaces members get +``` + + +Use the `ably spaces members get` command to get all members in a space. + +## Arguments + +Pass the following arguments to the `ably spaces members get` command: + +### `` + +The name of the space to get members for. + +## Flags + +You can optionally pass the following flags to the `ably spaces members get` command: + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Get all members in a space: + + +```shell +ably spaces members get my-space +``` + + +Get members in JSON format: + + +```shell +ably spaces members get my-space --json +``` + diff --git a/src/pages/docs/cli/spaces/members/index.mdx b/src/pages/docs/cli/spaces/members/index.mdx new file mode 100644 index 0000000000..cf70a7cc19 --- /dev/null +++ b/src/pages/docs/cli/spaces/members/index.mdx @@ -0,0 +1,15 @@ +--- +title: "ably spaces members" +meta_description: "Commands for managing members in Ably Spaces using the CLI." +meta_keywords: "ably cli, cli, spaces, members, presence, ably spaces members" +--- + +Use the `ably spaces members` command group to manage members in Ably Spaces. + +## Subcommands + +| Command | Description | +| ------- | ----------- | +| [`ably spaces members enter`](/docs/cli/spaces/members/enter) | Enter a space and remain present until terminated. | +| [`ably spaces members get`](/docs/cli/spaces/members/get) | Get all members in a space. | +| [`ably spaces members subscribe`](/docs/cli/spaces/members/subscribe) | Subscribe to member presence events in a space. | diff --git a/src/pages/docs/cli/spaces/members/subscribe.mdx b/src/pages/docs/cli/spaces/members/subscribe.mdx new file mode 100644 index 0000000000..3815a9898d --- /dev/null +++ b/src/pages/docs/cli/spaces/members/subscribe.mdx @@ -0,0 +1,59 @@ +--- +title: "ably spaces members subscribe" +meta_description: "Subscribe to member presence events in an Ably Space using the CLI." +meta_keywords: "ably cli, cli, spaces, members, subscribe, presence, events, ably spaces members subscribe" +--- + + +```shell +ably spaces members subscribe [flags] +``` + + +Use the `ably spaces members subscribe` command to subscribe to member presence events in a space. + +## Arguments + +Pass the following arguments to the `ably spaces members subscribe` command: + +### `` + +The name of the space to subscribe to member events in. + +## Flags + +You can optionally pass the following flags to the `ably spaces members subscribe` command: + +### `--duration | -D` + +The duration in seconds to subscribe for before automatically unsubscribing. + +### `--client-id` + +A client ID to use when subscribing. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Subscribe to member presence events in a space: + + +```shell +ably spaces members subscribe my-space +``` + + +Subscribe for a specific duration: + + +```shell +ably spaces members subscribe my-space --duration 60 +``` + diff --git a/src/pages/docs/cli/spaces/occupancy/get.mdx b/src/pages/docs/cli/spaces/occupancy/get.mdx new file mode 100644 index 0000000000..a20da274e0 --- /dev/null +++ b/src/pages/docs/cli/spaces/occupancy/get.mdx @@ -0,0 +1,51 @@ +--- +title: "ably spaces occupancy get" +meta_description: "Get current occupancy metrics for an Ably Space using the CLI." +meta_keywords: "ably cli, cli, spaces, occupancy, get, metrics, ably spaces occupancy get" +--- + + +```shell +ably spaces occupancy get +``` + + +Use the `ably spaces occupancy get` command to get current occupancy metrics for a space. + +## Arguments + +Pass the following arguments to the `ably spaces occupancy get` command: + +### `` + +The name of the space to get occupancy metrics for. + +## 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: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Get current occupancy metrics for a space: + + +```shell +ably spaces occupancy get my-space +``` + + +Get occupancy in JSON format: + + +```shell +ably spaces occupancy get my-space --json +``` + diff --git a/src/pages/docs/cli/spaces/occupancy/index.mdx b/src/pages/docs/cli/spaces/occupancy/index.mdx new file mode 100644 index 0000000000..3b6e79fc0e --- /dev/null +++ b/src/pages/docs/cli/spaces/occupancy/index.mdx @@ -0,0 +1,14 @@ +--- +title: "ably spaces occupancy" +meta_description: "Commands for working with occupancy in Ably Spaces using the CLI." +meta_keywords: "ably cli, cli, spaces, occupancy, metrics, ably spaces occupancy" +--- + +Use the `ably spaces occupancy` command group to work with occupancy in Ably Spaces. + +## Subcommands + +| Command | Description | +| ------- | ----------- | +| [`ably spaces occupancy get`](/docs/cli/spaces/occupancy/get) | Get current occupancy metrics for a space. | +| [`ably spaces occupancy subscribe`](/docs/cli/spaces/occupancy/subscribe) | Subscribe to occupancy events on a space. | diff --git a/src/pages/docs/cli/spaces/occupancy/subscribe.mdx b/src/pages/docs/cli/spaces/occupancy/subscribe.mdx new file mode 100644 index 0000000000..1c75fd2b50 --- /dev/null +++ b/src/pages/docs/cli/spaces/occupancy/subscribe.mdx @@ -0,0 +1,59 @@ +--- +title: "ably spaces occupancy subscribe" +meta_description: "Subscribe to occupancy events on an Ably Space using the CLI." +meta_keywords: "ably cli, cli, spaces, occupancy, subscribe, events, ably spaces occupancy subscribe" +--- + + +```shell +ably spaces occupancy subscribe [flags] +``` + + +Use the `ably spaces occupancy subscribe` command to subscribe to occupancy events on a space. + +## Arguments + +Pass the following arguments to the `ably spaces occupancy subscribe` command: + +### `` + +The name of the space to subscribe to occupancy events on. + +## Flags + +You can optionally pass the following flags to the `ably spaces occupancy subscribe` command: + +### `--duration | -D` + +The duration in seconds to subscribe for before automatically unsubscribing. + +### `--client-id` + +A client ID to use when subscribing. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Subscribe to occupancy events on a space: + + +```shell +ably spaces occupancy subscribe my-space +``` + + +Subscribe for a specific duration: + + +```shell +ably spaces occupancy subscribe my-space --duration 60 +``` + diff --git a/src/pages/docs/cli/spaces/subscribe.mdx b/src/pages/docs/cli/spaces/subscribe.mdx new file mode 100644 index 0000000000..5984f3ad4e --- /dev/null +++ b/src/pages/docs/cli/spaces/subscribe.mdx @@ -0,0 +1,59 @@ +--- +title: "ably spaces subscribe" +meta_description: "Subscribe to member and location update events in an Ably Space using the CLI." +meta_keywords: "ably cli, cli, spaces, subscribe, events, members, locations, ably spaces subscribe" +--- + + +```shell +ably spaces subscribe [flags] +``` + + +Use the `ably spaces subscribe` command to subscribe to member and location update events in a space. + +## Arguments + +Pass the following arguments to the `ably spaces subscribe` command: + +### `` + +The name of the space to subscribe to. + +## Flags + +You can optionally pass the following flags to the `ably spaces subscribe` command: + +### `--duration | -D` + +The duration in seconds to subscribe for before automatically unsubscribing. + +### `--client-id` + +A client ID to use when subscribing. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Subscribe to events in a space: + + +```shell +ably spaces subscribe my-space +``` + + +Subscribe for a specific duration: + + +```shell +ably spaces subscribe my-space --duration 60 +``` + diff --git a/src/pages/docs/cli/stats/account.mdx b/src/pages/docs/cli/stats/account.mdx new file mode 100644 index 0000000000..cfc44e0b9d --- /dev/null +++ b/src/pages/docs/cli/stats/account.mdx @@ -0,0 +1,95 @@ +--- +title: "ably stats account" +meta_description: "Get account-level statistics with optional live updates using the CLI." +meta_keywords: "ably cli, cli, stats, statistics, account, live, ably stats account" +--- + + +```shell +ably stats account [flags] +``` + + +Use the `ably stats account` command to get account-level statistics with optional live updates. + +## Flags + +You can optionally pass the following flags to the `ably stats account` command: + +### `--start` + +The start of the time range to retrieve stats from. Accepts ISO 8601, Unix milliseconds, or relative time formats. + +### `--end` + +The end of the time range to retrieve stats from. Accepts ISO 8601, Unix milliseconds, or relative time formats. + +### `--unit` + +The unit of time for the stats interval. Options are `minute`, `hour`, `day`, or `month`. Defaults to `minute`. + +### `--limit` + +The maximum number of stats records to retrieve. Defaults to `10`. + +### `--live` + +Subscribe to live stats updates at minute intervals. Defaults to `false`. + +### `--interval` + +The polling interval in seconds for live mode. Defaults to `6`. + +### `--debug` + +Show debug information for live polling. Defaults to `false`. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Retrieve recent account stats: + + +```shell +ably stats account +``` + + +Retrieve hourly stats: + + +```shell +ably stats account --unit hour +``` + + +Retrieve stats within a time range: + + +```shell +ably stats account --start "2025-01-01T00:00:00Z" --end "2025-01-02T00:00:00Z" +``` + + +Subscribe to live stats updates: + + +```shell +ably stats account --live +``` + + +Subscribe to live stats with a custom polling interval: + + +```shell +ably stats account --live --interval 10 +``` + diff --git a/src/pages/docs/cli/stats/app.mdx b/src/pages/docs/cli/stats/app.mdx new file mode 100644 index 0000000000..77b8c88623 --- /dev/null +++ b/src/pages/docs/cli/stats/app.mdx @@ -0,0 +1,95 @@ +--- +title: "ably stats app" +meta_description: "Get app-level statistics with optional live updates using the CLI." +meta_keywords: "ably cli, cli, stats, statistics, app, live, ably stats app" +--- + + +```shell +ably stats app [id] [flags] +``` + + +Use the `ably stats app` command to get app-level statistics with optional live updates. + +## Arguments + +Pass the following arguments to the `ably stats app` command: + +### `[id]` + +The ID of the app to retrieve stats for. If not provided, the currently selected app is used. + +## Flags + +You can optionally pass the following flags to the `ably stats app` command: + +### `--start` + +The start of the time range to retrieve stats from. Accepts ISO 8601, Unix milliseconds, or relative time formats. + +### `--end` + +The end of the time range to retrieve stats from. Accepts ISO 8601, Unix milliseconds, or relative time formats. + +### `--unit` + +The unit of time for the stats interval. Options are `minute`, `hour`, `day`, or `month`. Defaults to `minute`. + +### `--limit` + +The maximum number of stats records to retrieve. Defaults to `10`. + +### `--live` + +Subscribe to live stats updates at minute intervals. Defaults to `false`. + +### `--interval` + +The polling interval in seconds for live mode. Defaults to `6`. + +### `--debug` + +Show debug information for live polling. Defaults to `false`. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Retrieve stats for the current app: + + +```shell +ably stats app +``` + + +Retrieve stats for a specific app: + + +```shell +ably stats app abc123 +``` + + +Retrieve hourly stats: + + +```shell +ably stats app --unit hour +``` + + +Subscribe to live stats updates: + + +```shell +ably stats app --live +``` + diff --git a/src/pages/docs/cli/stats/index.mdx b/src/pages/docs/cli/stats/index.mdx new file mode 100644 index 0000000000..2a0292813a --- /dev/null +++ b/src/pages/docs/cli/stats/index.mdx @@ -0,0 +1,14 @@ +--- +title: "ably stats" +meta_description: "View statistics for your Ably account or apps." +meta_keywords: "ably cli, cli, stats, statistics, account, app, ably stats" +--- + +Use the `ably stats` command group to view statistics for your Ably account or apps. These commands enable you to retrieve usage metrics and subscribe to live stats updates. + +## Subcommands + +| Command | Description | +| ------- | ----------- | +| [`ably stats account`](/docs/cli/stats/account) | Get account-level statistics. | +| [`ably stats app`](/docs/cli/stats/app) | Get app-level statistics. | diff --git a/src/pages/docs/cli/status.mdx b/src/pages/docs/cli/status.mdx new file mode 100644 index 0000000000..fad67464a3 --- /dev/null +++ b/src/pages/docs/cli/status.mdx @@ -0,0 +1,47 @@ +--- +title: "ably status" +meta_description: "Check the status of Ably services using the CLI." +meta_keywords: "ably cli, cli, status, service status, ably status" +--- + + +```shell +ably status [flags] +``` + + +Use the `ably status` command to check the current status of Ably services. + +## Flags + +You can optionally pass the following flags to the `ably status` command: + +### `--open | -o` + +Open the Ably status page in a browser. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Check the status of Ably services: + + +```shell +ably status +``` + + +Check status with JSON output: + + +```shell +ably status --json +``` + diff --git a/src/pages/docs/cli/support/ask.mdx b/src/pages/docs/cli/support/ask.mdx new file mode 100644 index 0000000000..0d2cf010cf --- /dev/null +++ b/src/pages/docs/cli/support/ask.mdx @@ -0,0 +1,63 @@ +--- +title: "ably support ask" +meta_description: "Ask a question to the Ably AI agent for help using the CLI." +meta_keywords: "ably cli, cli, support, ask, ai, question, ably support ask" +--- + + +```shell +ably support ask [flags] +``` + + +Use the `ably support ask` command to ask a question to the Ably AI agent for help. + +## Arguments + +Pass the following arguments to the `ably support ask` command: + +### `` + +The question to ask the Ably AI agent. + +## Flags + +You can optionally pass the following flags to the `ably support ask` command: + +### `--continue` + +Continue a previous conversation with the AI agent. Defaults to `false`. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Ask a basic question: + + +```shell +ably support ask "How do I create an app?" +``` + + +Ask a technical question: + + +```shell +ably support ask "How do I authenticate with token auth?" +``` + + +Continue a previous conversation: + + +```shell +ably support ask "Can you give me more details?" --continue +``` + diff --git a/src/pages/docs/cli/support/contact.mdx b/src/pages/docs/cli/support/contact.mdx new file mode 100644 index 0000000000..935d619522 --- /dev/null +++ b/src/pages/docs/cli/support/contact.mdx @@ -0,0 +1,23 @@ +--- +title: "ably support contact" +meta_description: "Contact Ably for assistance using the CLI." +meta_keywords: "ably cli, cli, support, contact, help, ably support contact" +--- + + +```shell +ably support contact +``` + + +Use the `ably support contact` command to contact Ably for assistance. This opens the Ably contact page in your default browser. + +## Examples + +Open the Ably contact page: + + +```shell +ably support contact +``` + diff --git a/src/pages/docs/cli/support/index.mdx b/src/pages/docs/cli/support/index.mdx new file mode 100644 index 0000000000..8a32206da9 --- /dev/null +++ b/src/pages/docs/cli/support/index.mdx @@ -0,0 +1,14 @@ +--- +title: "ably support" +meta_description: "Get support and help from Ably." +meta_keywords: "ably cli, cli, support, help, ask, contact, ably support" +--- + +Use the `ably support` command group to get support and help from Ably. These commands enable you to ask questions to an AI agent or contact Ably directly for assistance. + +## Subcommands + +| Command | Description | +| ------- | ----------- | +| [`ably support ask`](/docs/cli/support/ask) | Ask a question to the Ably AI agent. | +| [`ably support contact`](/docs/cli/support/contact) | Open the Ably contact page. | diff --git a/src/pages/docs/cli/version.mdx b/src/pages/docs/cli/version.mdx new file mode 100644 index 0000000000..6c760df608 --- /dev/null +++ b/src/pages/docs/cli/version.mdx @@ -0,0 +1,31 @@ +--- +title: "ably version" +meta_description: "Display the version of the Ably CLI." +meta_keywords: "ably cli, cli, version, ably version" +--- + + +```shell +ably version +``` + + +Use the `ably version` command to display version information for the Ably CLI, including the CLI version, platform architecture, and Node.js version. + +## Global flags + +The following [global flags](/docs/cli#global-flags) are also available: + +* [`--json`](/docs/cli#json) +* [`--pretty-json`](/docs/cli#pretty-json) +* [`--verbose`](/docs/cli#verbose) + +## Examples + +Display the CLI version: + + +```shell +ably version +``` + From ef019c9e2ca8f124973e75faa62bbc12c31bcf42 Mon Sep 17 00:00:00 2001 From: sacOO7 Date: Thu, 2 Apr 2026 13:27:14 +0530 Subject: [PATCH 2/9] Added NODE_OPTIONS: --max-old-space-size=8192 to the build job's environment. 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. --- .circleci/config.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.circleci/config.yml b/.circleci/config.yml index fd47405d04..6c3422b6df 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -75,6 +75,7 @@ jobs: environment: ASSET_COMPRESSION_ITERATIONS: 1 COMPRESS_MAX_THREADS: 4 + NODE_OPTIONS: --max-old-space-size=8192 executor: name: default resource_class: xlarge From 7e09b7d826b1228fcb488f7e325acb2b3996dfab Mon Sep 17 00:00:00 2001 From: sacOO7 Date: Sun, 5 Apr 2026 20:24:45 +0530 Subject: [PATCH 3/9] - Implemented proper navigation links to CLI reference - Added navigation footers to generated CLI command pages --- src/data/nav/platform.ts | 4 + src/pages/docs/cli/accounts/current.mdx | 5 ++ src/pages/docs/cli/accounts/index.mdx | 4 + src/pages/docs/cli/accounts/list.mdx | 5 ++ src/pages/docs/cli/accounts/login.mdx | 5 ++ src/pages/docs/cli/accounts/logout.mdx | 5 ++ src/pages/docs/cli/accounts/switch.mdx | 5 ++ src/pages/docs/cli/apps/create.mdx | 5 ++ src/pages/docs/cli/apps/current.mdx | 5 ++ src/pages/docs/cli/apps/delete.mdx | 5 ++ src/pages/docs/cli/apps/index.mdx | 4 + src/pages/docs/cli/apps/list.mdx | 5 ++ src/pages/docs/cli/apps/rules/create.mdx | 5 ++ src/pages/docs/cli/apps/rules/delete.mdx | 5 ++ src/pages/docs/cli/apps/rules/index.mdx | 5 ++ src/pages/docs/cli/apps/rules/list.mdx | 5 ++ src/pages/docs/cli/apps/rules/update.mdx | 5 ++ src/pages/docs/cli/apps/switch.mdx | 5 ++ src/pages/docs/cli/apps/update.mdx | 5 ++ src/pages/docs/cli/auth/index.mdx | 4 + src/pages/docs/cli/auth/issue-ably-token.mdx | 5 ++ src/pages/docs/cli/auth/issue-jwt-token.mdx | 5 ++ src/pages/docs/cli/auth/keys/create.mdx | 5 ++ src/pages/docs/cli/auth/keys/current.mdx | 5 ++ src/pages/docs/cli/auth/keys/get.mdx | 5 ++ src/pages/docs/cli/auth/keys/index.mdx | 5 ++ src/pages/docs/cli/auth/keys/list.mdx | 5 ++ src/pages/docs/cli/auth/keys/revoke.mdx | 5 ++ src/pages/docs/cli/auth/keys/switch.mdx | 5 ++ src/pages/docs/cli/auth/keys/update.mdx | 5 ++ src/pages/docs/cli/auth/revoke-token.mdx | 5 ++ src/pages/docs/cli/autocomplete.mdx | 75 +++++++++++++++++ src/pages/docs/cli/bench/index.mdx | 4 + src/pages/docs/cli/bench/publisher.mdx | 5 ++ src/pages/docs/cli/bench/subscriber.mdx | 5 ++ .../docs/cli/channels/annotations/delete.mdx | 5 ++ .../docs/cli/channels/annotations/get.mdx | 5 ++ .../docs/cli/channels/annotations/index.mdx | 5 ++ .../docs/cli/channels/annotations/publish.mdx | 5 ++ .../cli/channels/annotations/subscribe.mdx | 5 ++ src/pages/docs/cli/channels/append.mdx | 5 ++ src/pages/docs/cli/channels/batch-publish.mdx | 5 ++ src/pages/docs/cli/channels/delete.mdx | 5 ++ src/pages/docs/cli/channels/history.mdx | 5 ++ src/pages/docs/cli/channels/index.mdx | 4 + src/pages/docs/cli/channels/inspect.mdx | 5 ++ src/pages/docs/cli/channels/list.mdx | 5 ++ src/pages/docs/cli/channels/occupancy/get.mdx | 5 ++ .../docs/cli/channels/occupancy/index.mdx | 5 ++ .../docs/cli/channels/occupancy/subscribe.mdx | 5 ++ .../docs/cli/channels/presence/enter.mdx | 5 ++ src/pages/docs/cli/channels/presence/get.mdx | 5 ++ .../docs/cli/channels/presence/index.mdx | 5 ++ .../docs/cli/channels/presence/subscribe.mdx | 5 ++ src/pages/docs/cli/channels/publish.mdx | 5 ++ src/pages/docs/cli/channels/subscribe.mdx | 5 ++ src/pages/docs/cli/channels/update.mdx | 5 ++ src/pages/docs/cli/config/index.mdx | 4 + src/pages/docs/cli/config/path.mdx | 5 ++ src/pages/docs/cli/config/show.mdx | 5 ++ src/pages/docs/cli/connections/index.mdx | 4 + src/pages/docs/cli/connections/test.mdx | 5 ++ src/pages/docs/cli/help.mdx | 4 + src/pages/docs/cli/index.mdx | 81 +++++-------------- src/pages/docs/cli/integrations/create.mdx | 5 ++ src/pages/docs/cli/integrations/delete.mdx | 5 ++ src/pages/docs/cli/integrations/get.mdx | 5 ++ src/pages/docs/cli/integrations/index.mdx | 4 + src/pages/docs/cli/integrations/list.mdx | 5 ++ src/pages/docs/cli/integrations/update.mdx | 5 ++ src/pages/docs/cli/interactive.mdx | 4 + src/pages/docs/cli/login.mdx | 4 + .../docs/cli/logs/channel-lifecycle/index.mdx | 5 ++ .../cli/logs/channel-lifecycle/subscribe.mdx | 5 ++ .../cli/logs/connection-lifecycle/history.mdx | 5 ++ .../cli/logs/connection-lifecycle/index.mdx | 5 ++ .../logs/connection-lifecycle/subscribe.mdx | 5 ++ src/pages/docs/cli/logs/history.mdx | 5 ++ src/pages/docs/cli/logs/index.mdx | 4 + src/pages/docs/cli/logs/push/history.mdx | 5 ++ src/pages/docs/cli/logs/push/index.mdx | 5 ++ src/pages/docs/cli/logs/push/subscribe.mdx | 5 ++ src/pages/docs/cli/logs/subscribe.mdx | 5 ++ src/pages/docs/cli/push/batch-publish.mdx | 5 ++ src/pages/docs/cli/push/channels/index.mdx | 5 ++ .../docs/cli/push/channels/list-channels.mdx | 5 ++ src/pages/docs/cli/push/channels/list.mdx | 5 ++ .../docs/cli/push/channels/remove-where.mdx | 5 ++ src/pages/docs/cli/push/channels/remove.mdx | 5 ++ src/pages/docs/cli/push/channels/save.mdx | 5 ++ src/pages/docs/cli/push/config/clear-apns.mdx | 5 ++ src/pages/docs/cli/push/config/clear-fcm.mdx | 5 ++ src/pages/docs/cli/push/config/index.mdx | 5 ++ src/pages/docs/cli/push/config/set-apns.mdx | 5 ++ src/pages/docs/cli/push/config/set-fcm.mdx | 5 ++ src/pages/docs/cli/push/config/show.mdx | 5 ++ src/pages/docs/cli/push/devices/get.mdx | 5 ++ src/pages/docs/cli/push/devices/index.mdx | 5 ++ src/pages/docs/cli/push/devices/list.mdx | 5 ++ .../docs/cli/push/devices/remove-where.mdx | 5 ++ src/pages/docs/cli/push/devices/remove.mdx | 5 ++ src/pages/docs/cli/push/devices/save.mdx | 5 ++ src/pages/docs/cli/push/index.mdx | 4 + src/pages/docs/cli/push/publish.mdx | 5 ++ src/pages/docs/cli/queues/create.mdx | 5 ++ src/pages/docs/cli/queues/delete.mdx | 5 ++ src/pages/docs/cli/queues/index.mdx | 4 + src/pages/docs/cli/queues/list.mdx | 5 ++ src/pages/docs/cli/rooms/index.mdx | 4 + src/pages/docs/cli/rooms/list.mdx | 5 ++ src/pages/docs/cli/rooms/messages/delete.mdx | 5 ++ src/pages/docs/cli/rooms/messages/history.mdx | 5 ++ src/pages/docs/cli/rooms/messages/index.mdx | 5 ++ .../cli/rooms/messages/reactions/index.mdx | 5 ++ .../cli/rooms/messages/reactions/remove.mdx | 5 ++ .../cli/rooms/messages/reactions/send.mdx | 5 ++ .../rooms/messages/reactions/subscribe.mdx | 5 ++ src/pages/docs/cli/rooms/messages/send.mdx | 5 ++ .../docs/cli/rooms/messages/subscribe.mdx | 5 ++ src/pages/docs/cli/rooms/messages/update.mdx | 5 ++ src/pages/docs/cli/rooms/occupancy/get.mdx | 5 ++ src/pages/docs/cli/rooms/occupancy/index.mdx | 5 ++ .../docs/cli/rooms/occupancy/subscribe.mdx | 5 ++ src/pages/docs/cli/rooms/presence/enter.mdx | 5 ++ src/pages/docs/cli/rooms/presence/get.mdx | 5 ++ src/pages/docs/cli/rooms/presence/index.mdx | 5 ++ .../docs/cli/rooms/presence/subscribe.mdx | 5 ++ src/pages/docs/cli/rooms/reactions/index.mdx | 5 ++ src/pages/docs/cli/rooms/reactions/send.mdx | 5 ++ .../docs/cli/rooms/reactions/subscribe.mdx | 5 ++ src/pages/docs/cli/rooms/typing/index.mdx | 5 ++ src/pages/docs/cli/rooms/typing/keystroke.mdx | 5 ++ src/pages/docs/cli/rooms/typing/subscribe.mdx | 5 ++ src/pages/docs/cli/spaces/create.mdx | 5 ++ src/pages/docs/cli/spaces/cursors/get.mdx | 5 ++ src/pages/docs/cli/spaces/cursors/index.mdx | 5 ++ src/pages/docs/cli/spaces/cursors/set.mdx | 5 ++ .../docs/cli/spaces/cursors/subscribe.mdx | 5 ++ src/pages/docs/cli/spaces/get.mdx | 5 ++ src/pages/docs/cli/spaces/index.mdx | 4 + src/pages/docs/cli/spaces/list.mdx | 5 ++ src/pages/docs/cli/spaces/locations/get.mdx | 5 ++ src/pages/docs/cli/spaces/locations/index.mdx | 5 ++ src/pages/docs/cli/spaces/locations/set.mdx | 5 ++ .../docs/cli/spaces/locations/subscribe.mdx | 5 ++ src/pages/docs/cli/spaces/locks/acquire.mdx | 5 ++ src/pages/docs/cli/spaces/locks/get.mdx | 5 ++ src/pages/docs/cli/spaces/locks/index.mdx | 5 ++ src/pages/docs/cli/spaces/locks/subscribe.mdx | 5 ++ src/pages/docs/cli/spaces/members/enter.mdx | 5 ++ src/pages/docs/cli/spaces/members/get.mdx | 5 ++ src/pages/docs/cli/spaces/members/index.mdx | 5 ++ .../docs/cli/spaces/members/subscribe.mdx | 5 ++ src/pages/docs/cli/spaces/occupancy/get.mdx | 5 ++ src/pages/docs/cli/spaces/occupancy/index.mdx | 5 ++ .../docs/cli/spaces/occupancy/subscribe.mdx | 5 ++ src/pages/docs/cli/spaces/subscribe.mdx | 5 ++ src/pages/docs/cli/stats/account.mdx | 5 ++ src/pages/docs/cli/stats/app.mdx | 5 ++ src/pages/docs/cli/stats/index.mdx | 4 + src/pages/docs/cli/status.mdx | 4 + src/pages/docs/cli/support/ask.mdx | 5 ++ src/pages/docs/cli/support/contact.mdx | 5 ++ src/pages/docs/cli/support/index.mdx | 4 + src/pages/docs/cli/version.mdx | 4 + src/pages/docs/platform/tools/cli.mdx | 68 ++++++++-------- 166 files changed, 922 insertions(+), 96 deletions(-) create mode 100644 src/pages/docs/cli/autocomplete.mdx diff --git a/src/data/nav/platform.ts b/src/data/nav/platform.ts index 38a8b53a47..4ea54e2171 100644 --- a/src/data/nav/platform.ts +++ b/src/data/nav/platform.ts @@ -386,6 +386,10 @@ export default { link: '/docs/api/control-api', name: 'Control API', }, + { + link: '/docs/cli', + name: 'Ably CLI Reference', + }, ], }, ], diff --git a/src/pages/docs/cli/accounts/current.mdx b/src/pages/docs/cli/accounts/current.mdx index a9e01e3a2d..bcda95c456 100644 --- a/src/pages/docs/cli/accounts/current.mdx +++ b/src/pages/docs/cli/accounts/current.mdx @@ -39,3 +39,8 @@ Display the current account in JSON format: ably accounts current --json ``` + +## See also + +* [Accounts](/docs/cli/accounts) — Explore all `ably accounts` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/accounts/index.mdx b/src/pages/docs/cli/accounts/index.mdx index 63d1a629d0..4eadec1686 100644 --- a/src/pages/docs/cli/accounts/index.mdx +++ b/src/pages/docs/cli/accounts/index.mdx @@ -15,3 +15,7 @@ Use the `ably accounts` command group to manage your Ably accounts and configure | [`ably accounts login`](/docs/cli/accounts/login) | Log in to an Ably account. | | [`ably accounts logout`](/docs/cli/accounts/logout) | Log out from an Ably account. | | [`ably accounts switch`](/docs/cli/accounts/switch) | Switch to a different Ably account. | + +## See also + +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/accounts/list.mdx b/src/pages/docs/cli/accounts/list.mdx index 71ca8f366d..af70aabfb1 100644 --- a/src/pages/docs/cli/accounts/list.mdx +++ b/src/pages/docs/cli/accounts/list.mdx @@ -39,3 +39,8 @@ List all configured accounts in JSON format: ably accounts list --json ``` + +## See also + +* [Accounts](/docs/cli/accounts) — Explore all `ably accounts` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/accounts/login.mdx b/src/pages/docs/cli/accounts/login.mdx index 6710009248..65007fd8b1 100644 --- a/src/pages/docs/cli/accounts/login.mdx +++ b/src/pages/docs/cli/accounts/login.mdx @@ -65,3 +65,8 @@ Log in without opening a browser: ably accounts login --no-browser ``` + +## See also + +* [Accounts](/docs/cli/accounts) — Explore all `ably accounts` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/accounts/logout.mdx b/src/pages/docs/cli/accounts/logout.mdx index 7fbb0baa04..7587b3afad 100644 --- a/src/pages/docs/cli/accounts/logout.mdx +++ b/src/pages/docs/cli/accounts/logout.mdx @@ -61,3 +61,8 @@ Log out without confirmation: ably accounts logout --force ``` + +## See also + +* [Accounts](/docs/cli/accounts) — Explore all `ably accounts` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/accounts/switch.mdx b/src/pages/docs/cli/accounts/switch.mdx index 6e5d09f086..9b25d7c061 100644 --- a/src/pages/docs/cli/accounts/switch.mdx +++ b/src/pages/docs/cli/accounts/switch.mdx @@ -45,3 +45,8 @@ Switch to a specific account by alias: ably accounts switch work ``` + +## See also + +* [Accounts](/docs/cli/accounts) — Explore all `ably accounts` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/apps/create.mdx b/src/pages/docs/cli/apps/create.mdx index f3a88153ec..d117711c4e 100644 --- a/src/pages/docs/cli/apps/create.mdx +++ b/src/pages/docs/cli/apps/create.mdx @@ -49,3 +49,8 @@ Create an application restricted to TLS connections only: ably apps create --name "secure-app" --tls-only ``` + +## See also + +* [Apps](/docs/cli/apps) — Explore all `ably apps` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/apps/current.mdx b/src/pages/docs/cli/apps/current.mdx index 91ad7d2f8b..e3fd8713dd 100644 --- a/src/pages/docs/cli/apps/current.mdx +++ b/src/pages/docs/cli/apps/current.mdx @@ -37,3 +37,8 @@ Show the currently selected app in JSON format: ably apps current --json ``` + +## See also + +* [Apps](/docs/cli/apps) — Explore all `ably apps` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/apps/delete.mdx b/src/pages/docs/cli/apps/delete.mdx index 2521a4ff6a..e06f63ca1c 100644 --- a/src/pages/docs/cli/apps/delete.mdx +++ b/src/pages/docs/cli/apps/delete.mdx @@ -69,3 +69,8 @@ Delete an app without a confirmation prompt: ably apps delete aBcDe1 --force ``` + +## See also + +* [Apps](/docs/cli/apps) — Explore all `ably apps` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/apps/index.mdx b/src/pages/docs/cli/apps/index.mdx index b00490fef5..6f32a5f47d 100644 --- a/src/pages/docs/cli/apps/index.mdx +++ b/src/pages/docs/cli/apps/index.mdx @@ -26,3 +26,7 @@ Use the `ably apps` command group to manage your Ably applications. These comman | [`ably apps rules delete`](/docs/cli/apps/rules/delete) | Delete a channel rule from an app. | | [`ably apps rules list`](/docs/cli/apps/rules/list) | List channel rules for an app. | | [`ably apps rules update`](/docs/cli/apps/rules/update) | Update a channel rule for an app. | + +## See also + +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/apps/list.mdx b/src/pages/docs/cli/apps/list.mdx index 4a3a40969b..b93058435c 100644 --- a/src/pages/docs/cli/apps/list.mdx +++ b/src/pages/docs/cli/apps/list.mdx @@ -45,3 +45,8 @@ List apps in JSON format: ably apps list --json ``` + +## See also + +* [Apps](/docs/cli/apps) — Explore all `ably apps` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/apps/rules/create.mdx b/src/pages/docs/cli/apps/rules/create.mdx index 0d643fd8a5..f8b1b42b0e 100644 --- a/src/pages/docs/cli/apps/rules/create.mdx +++ b/src/pages/docs/cli/apps/rules/create.mdx @@ -105,3 +105,8 @@ Create a channel rule with push notifications enabled: ably apps rules create --name "alerts" --push-enabled ``` + +## See also + +* [Apps rules](/docs/cli/apps/rules) — Explore all `ably apps rules` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/apps/rules/delete.mdx b/src/pages/docs/cli/apps/rules/delete.mdx index 55ea6455eb..567ff619b6 100644 --- a/src/pages/docs/cli/apps/rules/delete.mdx +++ b/src/pages/docs/cli/apps/rules/delete.mdx @@ -57,3 +57,8 @@ Delete a channel rule without a confirmation prompt: ably apps rules delete "chat" --force ``` + +## See also + +* [Apps rules](/docs/cli/apps/rules) — Explore all `ably apps rules` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/apps/rules/index.mdx b/src/pages/docs/cli/apps/rules/index.mdx index 1b47e8ce9b..cc2b9656d4 100644 --- a/src/pages/docs/cli/apps/rules/index.mdx +++ b/src/pages/docs/cli/apps/rules/index.mdx @@ -14,3 +14,8 @@ Use the `ably apps rules` command group to manage channel rules (namespaces) for | [`ably apps rules delete`](/docs/cli/apps/rules/delete) | Delete a channel rule from an app. | | [`ably apps rules list`](/docs/cli/apps/rules/list) | List channel rules for an app. | | [`ably apps rules update`](/docs/cli/apps/rules/update) | Update a channel rule for an app. | + +## See also + +* [Apps](/docs/cli/apps) — Explore all `ably apps` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/apps/rules/list.mdx b/src/pages/docs/cli/apps/rules/list.mdx index 04cd240214..f495f82327 100644 --- a/src/pages/docs/cli/apps/rules/list.mdx +++ b/src/pages/docs/cli/apps/rules/list.mdx @@ -49,3 +49,8 @@ List channel rules for a specific app: ably apps rules list --app aBcDe1 ``` + +## See also + +* [Apps rules](/docs/cli/apps/rules) — Explore all `ably apps rules` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/apps/rules/update.mdx b/src/pages/docs/cli/apps/rules/update.mdx index bbfc1ead1a..003377fa67 100644 --- a/src/pages/docs/cli/apps/rules/update.mdx +++ b/src/pages/docs/cli/apps/rules/update.mdx @@ -113,3 +113,8 @@ Update a channel rule and output the result as JSON: ably apps rules update "chat" --persisted --json ``` + +## See also + +* [Apps rules](/docs/cli/apps/rules) — Explore all `ably apps rules` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/apps/switch.mdx b/src/pages/docs/cli/apps/switch.mdx index 570963f5a0..c4d59a4b72 100644 --- a/src/pages/docs/cli/apps/switch.mdx +++ b/src/pages/docs/cli/apps/switch.mdx @@ -45,3 +45,8 @@ Switch to a specific app by ID: ably apps switch aBcDe1 ``` + +## See also + +* [Apps](/docs/cli/apps) — Explore all `ably apps` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/apps/update.mdx b/src/pages/docs/cli/apps/update.mdx index f98586193c..6250f94bbe 100644 --- a/src/pages/docs/cli/apps/update.mdx +++ b/src/pages/docs/cli/apps/update.mdx @@ -57,3 +57,8 @@ Restrict an application to TLS connections only: ably apps update aBcDe1 --tls-only ``` + +## See also + +* [Apps](/docs/cli/apps) — Explore all `ably apps` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/auth/index.mdx b/src/pages/docs/cli/auth/index.mdx index 31895c938c..f1e7bdcca2 100644 --- a/src/pages/docs/cli/auth/index.mdx +++ b/src/pages/docs/cli/auth/index.mdx @@ -26,3 +26,7 @@ Use the `ably auth` command group to manage authentication, API keys, and tokens | [`ably auth keys revoke`](/docs/cli/auth/keys/revoke) | Permanently revoke an API key. | | [`ably auth keys switch`](/docs/cli/auth/keys/switch) | Switch to a different API key for the current app. | | [`ably auth keys update`](/docs/cli/auth/keys/update) | Update an API key's properties. | + +## See also + +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/auth/issue-ably-token.mdx b/src/pages/docs/cli/auth/issue-ably-token.mdx index 8acbf2af36..ebe727c62c 100644 --- a/src/pages/docs/cli/auth/issue-ably-token.mdx +++ b/src/pages/docs/cli/auth/issue-ably-token.mdx @@ -87,3 +87,8 @@ Pipe the token to another command: ably auth issue-ably-token --token-only | pbcopy ``` + +## See also + +* [Auth](/docs/cli/auth) — Explore all `ably auth` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/auth/issue-jwt-token.mdx b/src/pages/docs/cli/auth/issue-jwt-token.mdx index 03f04d2ce1..d6db76b1ed 100644 --- a/src/pages/docs/cli/auth/issue-jwt-token.mdx +++ b/src/pages/docs/cli/auth/issue-jwt-token.mdx @@ -71,3 +71,8 @@ Output only the token string: ably auth issue-jwt-token --token-only ``` + +## See also + +* [Auth](/docs/cli/auth) — Explore all `ably auth` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/auth/keys/create.mdx b/src/pages/docs/cli/auth/keys/create.mdx index 8e57c832df..9b0b7d6ac4 100644 --- a/src/pages/docs/cli/auth/keys/create.mdx +++ b/src/pages/docs/cli/auth/keys/create.mdx @@ -55,3 +55,8 @@ Create a key with specific capabilities: ably auth keys create --name "Publish Only" --capabilities '{"my-channel":["publish"]}' ``` + +## See also + +* [Auth keys](/docs/cli/auth/keys) — Explore all `ably auth keys` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/auth/keys/current.mdx b/src/pages/docs/cli/auth/keys/current.mdx index e9df12fe2c..9765818b87 100644 --- a/src/pages/docs/cli/auth/keys/current.mdx +++ b/src/pages/docs/cli/auth/keys/current.mdx @@ -47,3 +47,8 @@ Show the current key for a specific app: ably auth keys current --app "aBcDeF" ``` + +## See also + +* [Auth keys](/docs/cli/auth/keys) — Explore all `ably auth keys` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/auth/keys/get.mdx b/src/pages/docs/cli/auth/keys/get.mdx index 51b4fb48e2..caf9b5ce5b 100644 --- a/src/pages/docs/cli/auth/keys/get.mdx +++ b/src/pages/docs/cli/auth/keys/get.mdx @@ -55,3 +55,8 @@ Get a key by its label: ably auth keys get "My API Key" ``` + +## See also + +* [Auth keys](/docs/cli/auth/keys) — Explore all `ably auth keys` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/auth/keys/index.mdx b/src/pages/docs/cli/auth/keys/index.mdx index ba7b2622c2..f38b67abba 100644 --- a/src/pages/docs/cli/auth/keys/index.mdx +++ b/src/pages/docs/cli/auth/keys/index.mdx @@ -17,3 +17,8 @@ Use the `ably auth keys` command group to manage API keys for Ably apps. These c | [`ably auth keys revoke`](/docs/cli/auth/keys/revoke) | Permanently revoke an API key. | | [`ably auth keys switch`](/docs/cli/auth/keys/switch) | Switch to a different API key for the current app. | | [`ably auth keys update`](/docs/cli/auth/keys/update) | Update an API key's properties. | + +## See also + +* [Auth](/docs/cli/auth) — Explore all `ably auth` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/auth/keys/list.mdx b/src/pages/docs/cli/auth/keys/list.mdx index 5e2ab473f1..f5a304727d 100644 --- a/src/pages/docs/cli/auth/keys/list.mdx +++ b/src/pages/docs/cli/auth/keys/list.mdx @@ -51,3 +51,8 @@ List keys for a specific app: ably auth keys list --app "aBcDeF" ``` + +## See also + +* [Auth keys](/docs/cli/auth/keys) — Explore all `ably auth keys` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/auth/keys/revoke.mdx b/src/pages/docs/cli/auth/keys/revoke.mdx index 9fea1e788b..c2377748e0 100644 --- a/src/pages/docs/cli/auth/keys/revoke.mdx +++ b/src/pages/docs/cli/auth/keys/revoke.mdx @@ -59,3 +59,8 @@ Force revoke without confirmation: ably auth keys revoke "aBcDeF.gHiJkL" --force ``` + +## See also + +* [Auth keys](/docs/cli/auth/keys) — Explore all `ably auth keys` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/auth/keys/switch.mdx b/src/pages/docs/cli/auth/keys/switch.mdx index c56da23b82..36019ebb60 100644 --- a/src/pages/docs/cli/auth/keys/switch.mdx +++ b/src/pages/docs/cli/auth/keys/switch.mdx @@ -53,3 +53,8 @@ Switch to a specific key: ably auth keys switch "aBcDeF.gHiJkL" ``` + +## See also + +* [Auth keys](/docs/cli/auth/keys) — Explore all `ably auth keys` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/auth/keys/update.mdx b/src/pages/docs/cli/auth/keys/update.mdx index 660f844686..266bb51d22 100644 --- a/src/pages/docs/cli/auth/keys/update.mdx +++ b/src/pages/docs/cli/auth/keys/update.mdx @@ -63,3 +63,8 @@ Update the capabilities for a key: ably auth keys update "aBcDeF.gHiJkL" --capabilities "publish,subscribe" ``` + +## See also + +* [Auth keys](/docs/cli/auth/keys) — Explore all `ably auth keys` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/auth/revoke-token.mdx b/src/pages/docs/cli/auth/revoke-token.mdx index 2449adde78..45ee0d386c 100644 --- a/src/pages/docs/cli/auth/revoke-token.mdx +++ b/src/pages/docs/cli/auth/revoke-token.mdx @@ -59,3 +59,8 @@ Revoke tokens for a specific client ID: ably auth revoke-token "xVLyHw.DRE6hQ..." --client-id "user-123" ``` + +## See also + +* [Auth](/docs/cli/auth) — Explore all `ably auth` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/autocomplete.mdx b/src/pages/docs/cli/autocomplete.mdx new file mode 100644 index 0000000000..d0b7dcb6db --- /dev/null +++ b/src/pages/docs/cli/autocomplete.mdx @@ -0,0 +1,75 @@ +--- +title: "ably autocomplete" +meta_description: "Display autocomplete installation instructions for the Ably CLI." +meta_keywords: "ably cli, cli, autocomplete, shell completion, bash, zsh, powershell" +--- + + +```shell +ably autocomplete [SHELL] +``` + + +Use the `ably autocomplete` command to display installation instructions for shell autocompletion. Once configured, autocomplete enables tab completion for commands and flags in your terminal. + +## Arguments + +Pass the following arguments to the `ably autocomplete` command: + +### `[SHELL]` + +The shell type to set up autocomplete for. Supported values: `zsh`, `bash`, `powershell`. + +If no shell is specified, the default shell is used. + +## Flags + +### `--refresh-cache | -r` + +Refresh the autocomplete cache, ignoring displaying instructions. + +## Examples + +Display autocomplete setup instructions for the default shell: + + +```shell +ably autocomplete +``` + + +Set up autocomplete for bash: + + +```shell +ably autocomplete bash +``` + + +Set up autocomplete for zsh: + + +```shell +ably autocomplete zsh +``` + + +Set up autocomplete for powershell: + + +```shell +ably autocomplete powershell +``` + + +Refresh the autocomplete cache: + + +```shell +ably autocomplete --refresh-cache +``` + + +## See also + +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/bench/index.mdx b/src/pages/docs/cli/bench/index.mdx index 00bce3b022..73407927cb 100644 --- a/src/pages/docs/cli/bench/index.mdx +++ b/src/pages/docs/cli/bench/index.mdx @@ -12,3 +12,7 @@ Use the `ably bench` command group to run performance benchmarking tests. These | ------- | ----------- | | [`ably bench publisher`](/docs/cli/bench/publisher) | Run a publisher benchmark test. | | [`ably bench subscriber`](/docs/cli/bench/subscriber) | Run a subscriber benchmark test. | + +## See also + +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/bench/publisher.mdx b/src/pages/docs/cli/bench/publisher.mdx index 7d1c3d7e41..2dc65ca164 100644 --- a/src/pages/docs/cli/bench/publisher.mdx +++ b/src/pages/docs/cli/bench/publisher.mdx @@ -81,3 +81,8 @@ Run a benchmark using the REST transport: ably bench publisher my-channel --transport rest ``` + +## See also + +* [Bench](/docs/cli/bench) — Explore all `ably bench` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/bench/subscriber.mdx b/src/pages/docs/cli/bench/subscriber.mdx index 9fabde774f..c2cd245a10 100644 --- a/src/pages/docs/cli/bench/subscriber.mdx +++ b/src/pages/docs/cli/bench/subscriber.mdx @@ -49,3 +49,8 @@ Run a basic subscriber benchmark: ably bench subscriber my-channel ``` + +## See also + +* [Bench](/docs/cli/bench) — Explore all `ably bench` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/channels/annotations/delete.mdx b/src/pages/docs/cli/channels/annotations/delete.mdx index 4260bc20d9..b10ebe1d2c 100644 --- a/src/pages/docs/cli/channels/annotations/delete.mdx +++ b/src/pages/docs/cli/channels/annotations/delete.mdx @@ -65,3 +65,8 @@ Delete a reaction by name: ably channels annotations delete my-channel "01a2b3c4d5@1234567890000-0" "reactions:unique.v1" --name thumbsup ``` + +## See also + +* [Channels annotations](/docs/cli/channels/annotations) — Explore all `ably channels annotations` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/channels/annotations/get.mdx b/src/pages/docs/cli/channels/annotations/get.mdx index 25e1a06608..7a09032706 100644 --- a/src/pages/docs/cli/channels/annotations/get.mdx +++ b/src/pages/docs/cli/channels/annotations/get.mdx @@ -57,3 +57,8 @@ Get annotations with a limit: ably channels annotations get my-channel "01a2b3c4d5@1234567890000-0" --limit 10 ``` + +## See also + +* [Channels annotations](/docs/cli/channels/annotations) — Explore all `ably channels annotations` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/channels/annotations/index.mdx b/src/pages/docs/cli/channels/annotations/index.mdx index 2b48439126..c052db3725 100644 --- a/src/pages/docs/cli/channels/annotations/index.mdx +++ b/src/pages/docs/cli/channels/annotations/index.mdx @@ -14,3 +14,8 @@ Use the `ably channels annotations` command group to manage annotations on Ably | [`ably channels annotations subscribe`](/docs/cli/channels/annotations/subscribe) | Subscribe to annotations on a channel. | | [`ably channels annotations get`](/docs/cli/channels/annotations/get) | Get annotations for a channel message. | | [`ably channels annotations delete`](/docs/cli/channels/annotations/delete) | Delete an annotation from a channel message. | + +## See also + +* [Channels](/docs/cli/channels) — Explore all `ably channels` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/channels/annotations/publish.mdx b/src/pages/docs/cli/channels/annotations/publish.mdx index 3953256129..1e04b14698 100644 --- a/src/pages/docs/cli/channels/annotations/publish.mdx +++ b/src/pages/docs/cli/channels/annotations/publish.mdx @@ -85,3 +85,8 @@ Publish an annotation with a count: ably channels annotations publish my-channel "01a2b3c4d5@1234567890000-0" "metrics:multiple.v1" --name views --count 5 ``` + +## See also + +* [Channels annotations](/docs/cli/channels/annotations) — Explore all `ably channels annotations` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/channels/annotations/subscribe.mdx b/src/pages/docs/cli/channels/annotations/subscribe.mdx index eccd1f8d84..1cebca46f2 100644 --- a/src/pages/docs/cli/channels/annotations/subscribe.mdx +++ b/src/pages/docs/cli/channels/annotations/subscribe.mdx @@ -73,3 +73,8 @@ Subscribe for a specific duration: ably channels annotations subscribe my-channel --duration 60 ``` + +## See also + +* [Channels annotations](/docs/cli/channels/annotations) — Explore all `ably channels annotations` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/channels/append.mdx b/src/pages/docs/cli/channels/append.mdx index 8821c524af..d43f722314 100644 --- a/src/pages/docs/cli/channels/append.mdx +++ b/src/pages/docs/cli/channels/append.mdx @@ -81,3 +81,8 @@ Append with a description: ably channels append my-channel "01a2b3c4d5@1234567890000-0" '{"note": "correction"}' --description "Added correction" ``` + +## See also + +* [Channels](/docs/cli/channels) — Explore all `ably channels` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/channels/batch-publish.mdx b/src/pages/docs/cli/channels/batch-publish.mdx index 859d052d33..eb3a42d2b6 100644 --- a/src/pages/docs/cli/channels/batch-publish.mdx +++ b/src/pages/docs/cli/channels/batch-publish.mdx @@ -77,3 +77,8 @@ Publish using a complete batch spec: ably channels batch-publish --spec '{"channels": ["channel-1", "channel-2"], "messages": [{"data": "Hello!"}]}' ``` + +## See also + +* [Channels](/docs/cli/channels) — Explore all `ably channels` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/channels/delete.mdx b/src/pages/docs/cli/channels/delete.mdx index 306ea4da62..6921557788 100644 --- a/src/pages/docs/cli/channels/delete.mdx +++ b/src/pages/docs/cli/channels/delete.mdx @@ -61,3 +61,8 @@ Delete a message with a description: ably channels delete my-channel "01a2b3c4d5@1234567890000-0" --description "Removed inappropriate content" ``` + +## See also + +* [Channels](/docs/cli/channels) — Explore all `ably channels` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/channels/history.mdx b/src/pages/docs/cli/channels/history.mdx index 892c8ff9a7..ae2a330675 100644 --- a/src/pages/docs/cli/channels/history.mdx +++ b/src/pages/docs/cli/channels/history.mdx @@ -85,3 +85,8 @@ Retrieve history in forwards direction: ably channels history my-channel --direction forwards ``` + +## See also + +* [Channels](/docs/cli/channels) — Explore all `ably channels` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/channels/index.mdx b/src/pages/docs/cli/channels/index.mdx index 0d25f8e796..c6164b28dd 100644 --- a/src/pages/docs/cli/channels/index.mdx +++ b/src/pages/docs/cli/channels/index.mdx @@ -51,3 +51,7 @@ Use the `ably channels` command group to interact with Ably Pub/Sub channels. Th | ------- | ----------- | | [`ably channels list`](/docs/cli/channels/list) | List active channels. | | [`ably channels inspect`](/docs/cli/channels/inspect) | Open the Ably dashboard to inspect a channel. | + +## See also + +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/channels/inspect.mdx b/src/pages/docs/cli/channels/inspect.mdx index adc87181d9..ac76645309 100644 --- a/src/pages/docs/cli/channels/inspect.mdx +++ b/src/pages/docs/cli/channels/inspect.mdx @@ -45,3 +45,8 @@ Inspect a channel in the Ably dashboard: ably channels inspect my-channel ``` + +## See also + +* [Channels](/docs/cli/channels) — Explore all `ably channels` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/channels/list.mdx b/src/pages/docs/cli/channels/list.mdx index 6c8fb972ab..09da4cfdbd 100644 --- a/src/pages/docs/cli/channels/list.mdx +++ b/src/pages/docs/cli/channels/list.mdx @@ -57,3 +57,8 @@ List channels with a limit: ably channels list --limit 10 ``` + +## See also + +* [Channels](/docs/cli/channels) — Explore all `ably channels` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/channels/occupancy/get.mdx b/src/pages/docs/cli/channels/occupancy/get.mdx index e0198987e6..96f63e7ac1 100644 --- a/src/pages/docs/cli/channels/occupancy/get.mdx +++ b/src/pages/docs/cli/channels/occupancy/get.mdx @@ -49,3 +49,8 @@ Get occupancy in JSON format: ably channels occupancy get my-channel --json ``` + +## See also + +* [Channels occupancy](/docs/cli/channels/occupancy) — Explore all `ably channels occupancy` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/channels/occupancy/index.mdx b/src/pages/docs/cli/channels/occupancy/index.mdx index 9fe90bbce0..a699751e47 100644 --- a/src/pages/docs/cli/channels/occupancy/index.mdx +++ b/src/pages/docs/cli/channels/occupancy/index.mdx @@ -12,3 +12,8 @@ Use the `ably channels occupancy` command group to monitor occupancy on Ably Pub | ------- | ----------- | | [`ably channels occupancy get`](/docs/cli/channels/occupancy/get) | Get current occupancy for a channel. | | [`ably channels occupancy subscribe`](/docs/cli/channels/occupancy/subscribe) | Subscribe to occupancy updates on a channel. | + +## See also + +* [Channels](/docs/cli/channels) — Explore all `ably channels` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/channels/occupancy/subscribe.mdx b/src/pages/docs/cli/channels/occupancy/subscribe.mdx index bd5c1ed3d7..19c041ceea 100644 --- a/src/pages/docs/cli/channels/occupancy/subscribe.mdx +++ b/src/pages/docs/cli/channels/occupancy/subscribe.mdx @@ -57,3 +57,8 @@ Subscribe for a specific duration: ably channels occupancy subscribe my-channel --duration 60 ``` + +## See also + +* [Channels occupancy](/docs/cli/channels/occupancy) — Explore all `ably channels occupancy` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/channels/presence/enter.mdx b/src/pages/docs/cli/channels/presence/enter.mdx index 811f3842e6..bbc8d5d215 100644 --- a/src/pages/docs/cli/channels/presence/enter.mdx +++ b/src/pages/docs/cli/channels/presence/enter.mdx @@ -77,3 +77,8 @@ Enter presence and show other members' events: ably channels presence enter my-channel --show-others ``` + +## See also + +* [Channels presence](/docs/cli/channels/presence) — Explore all `ably channels presence` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/channels/presence/get.mdx b/src/pages/docs/cli/channels/presence/get.mdx index 3ad007baf0..67025d15fd 100644 --- a/src/pages/docs/cli/channels/presence/get.mdx +++ b/src/pages/docs/cli/channels/presence/get.mdx @@ -53,3 +53,8 @@ Get presence members with a limit: ably channels presence get my-channel --limit 10 ``` + +## See also + +* [Channels presence](/docs/cli/channels/presence) — Explore all `ably channels presence` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/channels/presence/index.mdx b/src/pages/docs/cli/channels/presence/index.mdx index 4550033c6a..e63c010eca 100644 --- a/src/pages/docs/cli/channels/presence/index.mdx +++ b/src/pages/docs/cli/channels/presence/index.mdx @@ -13,3 +13,8 @@ Use the `ably channels presence` command group to manage presence on Ably Pub/Su | [`ably channels presence enter`](/docs/cli/channels/presence/enter) | Enter presence on a channel. | | [`ably channels presence get`](/docs/cli/channels/presence/get) | Get current presence members on a channel. | | [`ably channels presence subscribe`](/docs/cli/channels/presence/subscribe) | Subscribe to presence events on a channel. | + +## See also + +* [Channels](/docs/cli/channels) — Explore all `ably channels` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/channels/presence/subscribe.mdx b/src/pages/docs/cli/channels/presence/subscribe.mdx index 97d43d9463..15dd63ea42 100644 --- a/src/pages/docs/cli/channels/presence/subscribe.mdx +++ b/src/pages/docs/cli/channels/presence/subscribe.mdx @@ -57,3 +57,8 @@ Subscribe for a specific duration: ably channels presence subscribe my-channel --duration 60 ``` + +## See also + +* [Channels presence](/docs/cli/channels/presence) — Explore all `ably channels presence` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/channels/publish.mdx b/src/pages/docs/cli/channels/publish.mdx index 64eedc6ccc..b635225e58 100644 --- a/src/pages/docs/cli/channels/publish.mdx +++ b/src/pages/docs/cli/channels/publish.mdx @@ -101,3 +101,8 @@ Publish using the realtime transport: ably channels publish my-channel "Hello" --transport realtime ``` + +## See also + +* [Channels](/docs/cli/channels) — Explore all `ably channels` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/channels/subscribe.mdx b/src/pages/docs/cli/channels/subscribe.mdx index 008aea9e4f..6d0022333a 100644 --- a/src/pages/docs/cli/channels/subscribe.mdx +++ b/src/pages/docs/cli/channels/subscribe.mdx @@ -97,3 +97,8 @@ Subscribe with a cipher key for encrypted messages: ably channels subscribe my-channel --cipher "my-secret-key" ``` + +## See also + +* [Channels](/docs/cli/channels) — Explore all `ably channels` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/channels/update.mdx b/src/pages/docs/cli/channels/update.mdx index 3fe59ce798..4d1a493338 100644 --- a/src/pages/docs/cli/channels/update.mdx +++ b/src/pages/docs/cli/channels/update.mdx @@ -73,3 +73,8 @@ Update a message with a description: ably channels update my-channel "01a2b3c4d5@1234567890000-0" '{"key": "new-value"}' --description "Fixed typo" ``` + +## See also + +* [Channels](/docs/cli/channels) — Explore all `ably channels` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/config/index.mdx b/src/pages/docs/cli/config/index.mdx index cac7bc1f7b..40dd8dd4dc 100644 --- a/src/pages/docs/cli/config/index.mdx +++ b/src/pages/docs/cli/config/index.mdx @@ -12,3 +12,7 @@ Use the `ably config` command group to manage your Ably CLI configuration. These | ------- | ----------- | | [`ably config path`](/docs/cli/config/path) | Print the path to the Ably CLI config file. | | [`ably config show`](/docs/cli/config/show) | Display the contents of the Ably CLI config file. | + +## See also + +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/config/path.mdx b/src/pages/docs/cli/config/path.mdx index 39ae40b6f9..f315b79687 100644 --- a/src/pages/docs/cli/config/path.mdx +++ b/src/pages/docs/cli/config/path.mdx @@ -29,3 +29,8 @@ Print the config file path: ably config path ``` + +## See also + +* [Config](/docs/cli/config) — Explore all `ably config` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/config/show.mdx b/src/pages/docs/cli/config/show.mdx index 80e70734a5..cb115b34ef 100644 --- a/src/pages/docs/cli/config/show.mdx +++ b/src/pages/docs/cli/config/show.mdx @@ -37,3 +37,8 @@ Display the config file contents in JSON format: ably config show --json ``` + +## See also + +* [Config](/docs/cli/config) — Explore all `ably config` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/connections/index.mdx b/src/pages/docs/cli/connections/index.mdx index 2c2d1b64ae..e947e03978 100644 --- a/src/pages/docs/cli/connections/index.mdx +++ b/src/pages/docs/cli/connections/index.mdx @@ -11,3 +11,7 @@ Use the `ably connections` command group to test connections to Ably. These comm | Command | Description | | ------- | ----------- | | [`ably connections test`](/docs/cli/connections/test) | Test connection to Ably. | + +## See also + +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/connections/test.mdx b/src/pages/docs/cli/connections/test.mdx index e71b8a8b3d..bb4fb9a946 100644 --- a/src/pages/docs/cli/connections/test.mdx +++ b/src/pages/docs/cli/connections/test.mdx @@ -57,3 +57,8 @@ Test HTTP connectivity only: ably connections test --transport xhr ``` + +## See also + +* [Connections](/docs/cli/connections) — Explore all `ably connections` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/help.mdx b/src/pages/docs/cli/help.mdx index 30f282fcfe..feab1b29fc 100644 --- a/src/pages/docs/cli/help.mdx +++ b/src/pages/docs/cli/help.mdx @@ -47,3 +47,7 @@ Display help for a command group: ably help channels ``` + +## See also + +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/index.mdx b/src/pages/docs/cli/index.mdx index 8ab8477726..66608954c8 100644 --- a/src/pages/docs/cli/index.mdx +++ b/src/pages/docs/cli/index.mdx @@ -4,27 +4,9 @@ meta_description: "Command-line interface for the Ably realtime messaging platfo meta_keywords: "ably cli, cli, command line, realtime messaging, pub/sub, chat, spaces" --- -The Ably CLI provides a command-line interface for interacting with the Ably realtime messaging platform. Use it to manage your accounts, apps, channels, authentication, and more. +## Overview -## Installation - -Install the Ably CLI using npm: - - -```shell -npm install -g @ably/cli -``` - - -## Authentication - -Before using the CLI, authenticate with your Ably account: - - -```shell -ably login -``` - +For an overview of the Ably CLI, including [installation instructions](/docs/platform/tools/cli#installation) and [feature highlights](/docs/platform/tools/cli#feature-set), see the [Ably CLI](/docs/platform/tools/cli) page. ## Global flags @@ -42,49 +24,26 @@ Output results in colorized JSON format. Enable verbose logging. -## Command groups +## Commands -### Account and app management - -| Command Group | Description | -| ------------- | ----------- | -| [`ably accounts`](/docs/cli/accounts) | Manage Ably accounts and configured access tokens | -| [`ably apps`](/docs/cli/apps) | Manage Ably applications | -| [`ably auth`](/docs/cli/auth) | Manage authentication, API keys, and tokens | - -### Realtime communication - -| Command Group | Description | -| ------------- | ----------- | +| 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 | - -### Infrastructure and monitoring - -| Command Group | Description | -| ------------- | ----------- | -| [`ably connections`](/docs/cli/connections) | Test connections to Ably | -| [`ably integrations`](/docs/cli/integrations) | Manage Ably integrations with external services | -| [`ably logs`](/docs/cli/logs) | Stream and retrieve logs from Ably | -| [`ably push`](/docs/cli/push) | Manage push notifications | -| [`ably queues`](/docs/cli/queues) | Manage Ably queues | -| [`ably stats`](/docs/cli/stats) | View account and app statistics | - -### Utilities and tools - -| Command Group | Description | -| ------------- | ----------- | -| [`ably bench`](/docs/cli/bench) | Performance benchmarking commands | -| [`ably config`](/docs/cli/config) | Manage CLI configuration | +| [`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 | - -## Standalone commands - -| Command | Description | -| ------- | ----------- | -| [`ably help`](/docs/cli/help) | Display help for Ably CLI commands | -| [`ably interactive`](/docs/cli/interactive) | Launch interactive Ably shell | -| [`ably login`](/docs/cli/login) | Log in to your Ably account | -| [`ably status`](/docs/cli/status) | Check the status of Ably services | -| [`ably version`](/docs/cli/version) | Display the CLI version | diff --git a/src/pages/docs/cli/integrations/create.mdx b/src/pages/docs/cli/integrations/create.mdx index b0b3068499..e2bdb6c80a 100644 --- a/src/pages/docs/cli/integrations/create.mdx +++ b/src/pages/docs/cli/integrations/create.mdx @@ -77,3 +77,8 @@ Create a disabled integration rule: ably integrations create --rule-type http --source-type channel.message --target-url https://example.com/webhook --status disabled ``` + +## See also + +* [Integrations](/docs/cli/integrations) — Explore all `ably integrations` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/integrations/delete.mdx b/src/pages/docs/cli/integrations/delete.mdx index 4c895bd382..9fea9386bb 100644 --- a/src/pages/docs/cli/integrations/delete.mdx +++ b/src/pages/docs/cli/integrations/delete.mdx @@ -57,3 +57,8 @@ Delete an integration rule without a confirmation prompt: ably integrations delete aBcDe1 --force ``` + +## See also + +* [Integrations](/docs/cli/integrations) — Explore all `ably integrations` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/integrations/get.mdx b/src/pages/docs/cli/integrations/get.mdx index 2be17f1f1e..2e4340d106 100644 --- a/src/pages/docs/cli/integrations/get.mdx +++ b/src/pages/docs/cli/integrations/get.mdx @@ -53,3 +53,8 @@ Get an integration rule in JSON format: ably integrations get aBcDe1 --json ``` + +## See also + +* [Integrations](/docs/cli/integrations) — Explore all `ably integrations` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/integrations/index.mdx b/src/pages/docs/cli/integrations/index.mdx index 8017416423..3a91515bf4 100644 --- a/src/pages/docs/cli/integrations/index.mdx +++ b/src/pages/docs/cli/integrations/index.mdx @@ -15,3 +15,7 @@ Use the `ably integrations` command group to manage your Ably integrations with | [`ably integrations get`](/docs/cli/integrations/get) | Get an integration rule by ID. | | [`ably integrations list`](/docs/cli/integrations/list) | List all integration rules. | | [`ably integrations update`](/docs/cli/integrations/update) | Update an integration rule. | + +## See also + +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/integrations/list.mdx b/src/pages/docs/cli/integrations/list.mdx index 2e6d3f9538..eb76b4f87b 100644 --- a/src/pages/docs/cli/integrations/list.mdx +++ b/src/pages/docs/cli/integrations/list.mdx @@ -49,3 +49,8 @@ List integration rules for a specific app: ably integrations list --app aBcDe1 ``` + +## See also + +* [Integrations](/docs/cli/integrations) — Explore all `ably integrations` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/integrations/update.mdx b/src/pages/docs/cli/integrations/update.mdx index beb161923a..3839fc45a8 100644 --- a/src/pages/docs/cli/integrations/update.mdx +++ b/src/pages/docs/cli/integrations/update.mdx @@ -85,3 +85,8 @@ Update the target URL for an integration rule: ably integrations update aBcDe1 --target-url https://example.com/new-webhook ``` + +## See also + +* [Integrations](/docs/cli/integrations) — Explore all `ably integrations` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/interactive.mdx b/src/pages/docs/cli/interactive.mdx index 629b4ec263..badc12b191 100644 --- a/src/pages/docs/cli/interactive.mdx +++ b/src/pages/docs/cli/interactive.mdx @@ -33,3 +33,7 @@ Launch the interactive shell: ably interactive ``` + +## See also + +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/login.mdx b/src/pages/docs/cli/login.mdx index 8a4bcaf8ea..a94d1bff32 100644 --- a/src/pages/docs/cli/login.mdx +++ b/src/pages/docs/cli/login.mdx @@ -63,3 +63,7 @@ Log in with an alias for the account: ably login --alias my-company ``` + +## See also + +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/logs/channel-lifecycle/index.mdx b/src/pages/docs/cli/logs/channel-lifecycle/index.mdx index 0818c7c851..aa8fda8dc6 100644 --- a/src/pages/docs/cli/logs/channel-lifecycle/index.mdx +++ b/src/pages/docs/cli/logs/channel-lifecycle/index.mdx @@ -11,3 +11,8 @@ Use the `ably logs channel-lifecycle` command group to stream logs from the chan | Command | Description | | ------- | ----------- | | [`ably logs channel-lifecycle subscribe`](/docs/cli/logs/channel-lifecycle/subscribe) | Subscribe to channel lifecycle events. | + +## See also + +* [Logs](/docs/cli/logs) — Explore all `ably logs` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/logs/channel-lifecycle/subscribe.mdx b/src/pages/docs/cli/logs/channel-lifecycle/subscribe.mdx index 43980a7258..c7a27b319b 100644 --- a/src/pages/docs/cli/logs/channel-lifecycle/subscribe.mdx +++ b/src/pages/docs/cli/logs/channel-lifecycle/subscribe.mdx @@ -53,3 +53,8 @@ Subscribe with rewind to receive recent events: ably logs channel-lifecycle subscribe --rewind 5 ``` + +## See also + +* [Logs channel-lifecycle](/docs/cli/logs/channel-lifecycle) — Explore all `ably logs channel-lifecycle` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/logs/connection-lifecycle/history.mdx b/src/pages/docs/cli/logs/connection-lifecycle/history.mdx index 831630b1d8..bfd641cca3 100644 --- a/src/pages/docs/cli/logs/connection-lifecycle/history.mdx +++ b/src/pages/docs/cli/logs/connection-lifecycle/history.mdx @@ -57,3 +57,8 @@ Retrieve logs within a time range: ably logs connection-lifecycle history --start "2025-01-01T00:00:00Z" --end "2025-01-02T00:00:00Z" ``` + +## See also + +* [Logs connection-lifecycle](/docs/cli/logs/connection-lifecycle) — Explore all `ably logs connection-lifecycle` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/logs/connection-lifecycle/index.mdx b/src/pages/docs/cli/logs/connection-lifecycle/index.mdx index 25132477a3..ffdea5c62d 100644 --- a/src/pages/docs/cli/logs/connection-lifecycle/index.mdx +++ b/src/pages/docs/cli/logs/connection-lifecycle/index.mdx @@ -12,3 +12,8 @@ Use the `ably logs connection-lifecycle` command group to stream and retrieve co | ------- | ----------- | | [`ably logs connection-lifecycle subscribe`](/docs/cli/logs/connection-lifecycle/subscribe) | Subscribe to live connection lifecycle logs. | | [`ably logs connection-lifecycle history`](/docs/cli/logs/connection-lifecycle/history) | Retrieve connection lifecycle log history. | + +## See also + +* [Logs](/docs/cli/logs) — Explore all `ably logs` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/logs/connection-lifecycle/subscribe.mdx b/src/pages/docs/cli/logs/connection-lifecycle/subscribe.mdx index ee1d8379f0..9d9a13d461 100644 --- a/src/pages/docs/cli/logs/connection-lifecycle/subscribe.mdx +++ b/src/pages/docs/cli/logs/connection-lifecycle/subscribe.mdx @@ -53,3 +53,8 @@ Subscribe with rewind to receive recent logs: ably logs connection-lifecycle subscribe --rewind 10 ``` + +## See also + +* [Logs connection-lifecycle](/docs/cli/logs/connection-lifecycle) — Explore all `ably logs connection-lifecycle` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/logs/history.mdx b/src/pages/docs/cli/logs/history.mdx index d28504bb33..0f6d4ae89a 100644 --- a/src/pages/docs/cli/logs/history.mdx +++ b/src/pages/docs/cli/logs/history.mdx @@ -65,3 +65,8 @@ Retrieve logs in forwards direction: ably logs history --direction forwards ``` + +## See also + +* [Logs](/docs/cli/logs) — Explore all `ably logs` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/logs/index.mdx b/src/pages/docs/cli/logs/index.mdx index 239cd14f00..3dabc58a8f 100644 --- a/src/pages/docs/cli/logs/index.mdx +++ b/src/pages/docs/cli/logs/index.mdx @@ -35,3 +35,7 @@ Use the `ably logs` command group to stream and retrieve logs from Ably. These c | [`ably logs push`](/docs/cli/logs/push) | Stream and retrieve push notification logs. | | [`ably logs push subscribe`](/docs/cli/logs/push/subscribe) | Subscribe to push notification logs. | | [`ably logs push history`](/docs/cli/logs/push/history) | Retrieve push notification log history. | + +## See also + +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/logs/push/history.mdx b/src/pages/docs/cli/logs/push/history.mdx index 862f33ecc8..03c5cf9943 100644 --- a/src/pages/docs/cli/logs/push/history.mdx +++ b/src/pages/docs/cli/logs/push/history.mdx @@ -57,3 +57,8 @@ Retrieve logs within a time range: ably logs push history --start "2025-01-01T00:00:00Z" --end "2025-01-02T00:00:00Z" ``` + +## See also + +* [Logs push](/docs/cli/logs/push) — Explore all `ably logs push` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/logs/push/index.mdx b/src/pages/docs/cli/logs/push/index.mdx index dd595cfe86..94b2668abb 100644 --- a/src/pages/docs/cli/logs/push/index.mdx +++ b/src/pages/docs/cli/logs/push/index.mdx @@ -12,3 +12,8 @@ Use the `ably logs push` command group to stream and retrieve push notification | ------- | ----------- | | [`ably logs push subscribe`](/docs/cli/logs/push/subscribe) | Subscribe to push notification logs. | | [`ably logs push history`](/docs/cli/logs/push/history) | Retrieve push notification log history. | + +## See also + +* [Logs](/docs/cli/logs) — Explore all `ably logs` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/logs/push/subscribe.mdx b/src/pages/docs/cli/logs/push/subscribe.mdx index 84bdb45845..52a32e985a 100644 --- a/src/pages/docs/cli/logs/push/subscribe.mdx +++ b/src/pages/docs/cli/logs/push/subscribe.mdx @@ -53,3 +53,8 @@ Subscribe with rewind to receive recent logs: ably logs push subscribe --rewind 5 ``` + +## See also + +* [Logs push](/docs/cli/logs/push) — Explore all `ably logs push` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/logs/subscribe.mdx b/src/pages/docs/cli/logs/subscribe.mdx index 6b25c4c7cc..67e6ca01b8 100644 --- a/src/pages/docs/cli/logs/subscribe.mdx +++ b/src/pages/docs/cli/logs/subscribe.mdx @@ -65,3 +65,8 @@ Subscribe with rewind to receive recent logs: ably logs subscribe --rewind 10 ``` + +## See also + +* [Logs](/docs/cli/logs) — Explore all `ably logs` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/push/batch-publish.mdx b/src/pages/docs/cli/push/batch-publish.mdx index 16c2adc5b2..22f584408b 100644 --- a/src/pages/docs/cli/push/batch-publish.mdx +++ b/src/pages/docs/cli/push/batch-publish.mdx @@ -61,3 +61,8 @@ Publish from stdin: cat notifications.json | ably push batch-publish - ``` + +## See also + +* [Push](/docs/cli/push) — Explore all `ably push` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/push/channels/index.mdx b/src/pages/docs/cli/push/channels/index.mdx index accb52c26f..0a9f031b71 100644 --- a/src/pages/docs/cli/push/channels/index.mdx +++ b/src/pages/docs/cli/push/channels/index.mdx @@ -15,3 +15,8 @@ Use the `ably push channels` command group to manage push notification channel s | [`ably push channels save`](/docs/cli/push/channels/save) | Subscribe a device or client to push notifications on a channel. | | [`ably push channels remove`](/docs/cli/push/channels/remove) | Remove a push channel subscription. | | [`ably push channels remove-where`](/docs/cli/push/channels/remove-where) | Remove push channel subscriptions matching filter criteria. | + +## See also + +* [Push](/docs/cli/push) — Explore all `ably push` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/push/channels/list-channels.mdx b/src/pages/docs/cli/push/channels/list-channels.mdx index 01fa911aa3..d3d409c7ce 100644 --- a/src/pages/docs/cli/push/channels/list-channels.mdx +++ b/src/pages/docs/cli/push/channels/list-channels.mdx @@ -37,3 +37,8 @@ List channels with push subscriptions: ably push channels list-channels ``` + +## See also + +* [Push channels](/docs/cli/push/channels) — Explore all `ably push channels` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/push/channels/list.mdx b/src/pages/docs/cli/push/channels/list.mdx index aa0fafbc1d..a7a6bd51a4 100644 --- a/src/pages/docs/cli/push/channels/list.mdx +++ b/src/pages/docs/cli/push/channels/list.mdx @@ -57,3 +57,8 @@ Filter subscriptions by device: ably push channels list --channel my-channel --device-id "device123" ``` + +## See also + +* [Push channels](/docs/cli/push/channels) — Explore all `ably push channels` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/push/channels/remove-where.mdx b/src/pages/docs/cli/push/channels/remove-where.mdx index bd1b9c7c60..5fc9ca795b 100644 --- a/src/pages/docs/cli/push/channels/remove-where.mdx +++ b/src/pages/docs/cli/push/channels/remove-where.mdx @@ -57,3 +57,8 @@ Remove all subscriptions for a client on a channel: ably push channels remove-where --channel my-channel --client-id "user456" ``` + +## See also + +* [Push channels](/docs/cli/push/channels) — Explore all `ably push channels` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/push/channels/remove.mdx b/src/pages/docs/cli/push/channels/remove.mdx index 8614a5bd99..2610f07692 100644 --- a/src/pages/docs/cli/push/channels/remove.mdx +++ b/src/pages/docs/cli/push/channels/remove.mdx @@ -57,3 +57,8 @@ Remove a client subscription from a channel: ably push channels remove --channel my-channel --client-id "user456" ``` + +## See also + +* [Push channels](/docs/cli/push/channels) — Explore all `ably push channels` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/push/channels/save.mdx b/src/pages/docs/cli/push/channels/save.mdx index 97d4ec2f77..1a679d49ae 100644 --- a/src/pages/docs/cli/push/channels/save.mdx +++ b/src/pages/docs/cli/push/channels/save.mdx @@ -53,3 +53,8 @@ Subscribe a client to push notifications on a channel: ably push channels save --channel my-channel --client-id "user456" ``` + +## See also + +* [Push channels](/docs/cli/push/channels) — Explore all `ably push channels` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/push/config/clear-apns.mdx b/src/pages/docs/cli/push/config/clear-apns.mdx index b1ec724614..63d6ccc23f 100644 --- a/src/pages/docs/cli/push/config/clear-apns.mdx +++ b/src/pages/docs/cli/push/config/clear-apns.mdx @@ -49,3 +49,8 @@ Force clear APNs configuration: ably push config clear-apns --force ``` + +## See also + +* [Push config](/docs/cli/push/config) — Explore all `ably push config` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/push/config/clear-fcm.mdx b/src/pages/docs/cli/push/config/clear-fcm.mdx index e489a58013..08231f1aef 100644 --- a/src/pages/docs/cli/push/config/clear-fcm.mdx +++ b/src/pages/docs/cli/push/config/clear-fcm.mdx @@ -49,3 +49,8 @@ Force clear FCM configuration: ably push config clear-fcm --force ``` + +## See also + +* [Push config](/docs/cli/push/config) — Explore all `ably push config` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/push/config/index.mdx b/src/pages/docs/cli/push/config/index.mdx index e7432e405f..d8630bef5d 100644 --- a/src/pages/docs/cli/push/config/index.mdx +++ b/src/pages/docs/cli/push/config/index.mdx @@ -15,3 +15,8 @@ Use the `ably push config` command group to manage push notification configurati | [`ably push config set-fcm`](/docs/cli/push/config/set-fcm) | Configure FCM push notifications for an app. | | [`ably push config clear-apns`](/docs/cli/push/config/clear-apns) | Clear APNs push notification configuration for an app. | | [`ably push config clear-fcm`](/docs/cli/push/config/clear-fcm) | Clear FCM push notification configuration for an app. | + +## See also + +* [Push](/docs/cli/push) — Explore all `ably push` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/push/config/set-apns.mdx b/src/pages/docs/cli/push/config/set-apns.mdx index 18e2b95c33..eb6d620d65 100644 --- a/src/pages/docs/cli/push/config/set-apns.mdx +++ b/src/pages/docs/cli/push/config/set-apns.mdx @@ -73,3 +73,8 @@ Configure APNs with a P8 key: ably push config set-apns --key-file /path/to/key.p8 --key-id "ABC123" --team-id "TEAM456" --topic "com.example.app" ``` + +## See also + +* [Push config](/docs/cli/push/config) — Explore all `ably push config` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/push/config/set-fcm.mdx b/src/pages/docs/cli/push/config/set-fcm.mdx index 7f1ed50590..8d96567522 100644 --- a/src/pages/docs/cli/push/config/set-fcm.mdx +++ b/src/pages/docs/cli/push/config/set-fcm.mdx @@ -41,3 +41,8 @@ Configure FCM with a service account: ably push config set-fcm --service-account /path/to/service-account.json ``` + +## See also + +* [Push config](/docs/cli/push/config) — Explore all `ably push config` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/push/config/show.mdx b/src/pages/docs/cli/push/config/show.mdx index 692f10b609..413c3605a9 100644 --- a/src/pages/docs/cli/push/config/show.mdx +++ b/src/pages/docs/cli/push/config/show.mdx @@ -45,3 +45,8 @@ Show push configuration for a specific app: ably push config show --app "app-id" ``` + +## See also + +* [Push config](/docs/cli/push/config) — Explore all `ably push config` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/push/devices/get.mdx b/src/pages/docs/cli/push/devices/get.mdx index eae6bfc5f0..d579ab8783 100644 --- a/src/pages/docs/cli/push/devices/get.mdx +++ b/src/pages/docs/cli/push/devices/get.mdx @@ -37,3 +37,8 @@ Get details of a device registration: ably push devices get "device123" ``` + +## See also + +* [Push devices](/docs/cli/push/devices) — Explore all `ably push devices` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/push/devices/index.mdx b/src/pages/docs/cli/push/devices/index.mdx index ad30a3c0f4..8ef7bcf556 100644 --- a/src/pages/docs/cli/push/devices/index.mdx +++ b/src/pages/docs/cli/push/devices/index.mdx @@ -15,3 +15,8 @@ Use the `ably push devices` command group to manage push notification device reg | [`ably push devices save`](/docs/cli/push/devices/save) | Register or update a push device. | | [`ably push devices remove`](/docs/cli/push/devices/remove) | Remove a push device registration. | | [`ably push devices remove-where`](/docs/cli/push/devices/remove-where) | Remove push device registrations matching filter criteria. | + +## See also + +* [Push](/docs/cli/push) — Explore all `ably push` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/push/devices/list.mdx b/src/pages/docs/cli/push/devices/list.mdx index 567c4cbde5..d9b43ac7dc 100644 --- a/src/pages/docs/cli/push/devices/list.mdx +++ b/src/pages/docs/cli/push/devices/list.mdx @@ -57,3 +57,8 @@ Filter by state: ably push devices list --state ACTIVE ``` + +## See also + +* [Push devices](/docs/cli/push/devices) — Explore all `ably push devices` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/push/devices/remove-where.mdx b/src/pages/docs/cli/push/devices/remove-where.mdx index 6f779d0a1b..bfda9990aa 100644 --- a/src/pages/docs/cli/push/devices/remove-where.mdx +++ b/src/pages/docs/cli/push/devices/remove-where.mdx @@ -53,3 +53,8 @@ Remove registrations by client ID: ably push devices remove-where --client-id "user456" ``` + +## See also + +* [Push devices](/docs/cli/push/devices) — Explore all `ably push devices` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/push/devices/remove.mdx b/src/pages/docs/cli/push/devices/remove.mdx index ce97507914..ae0d964585 100644 --- a/src/pages/docs/cli/push/devices/remove.mdx +++ b/src/pages/docs/cli/push/devices/remove.mdx @@ -53,3 +53,8 @@ Force remove without confirmation: ably push devices remove "device123" --force ``` + +## See also + +* [Push devices](/docs/cli/push/devices) — Explore all `ably push devices` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/push/devices/save.mdx b/src/pages/docs/cli/push/devices/save.mdx index bcd4e93d7e..def6c4f724 100644 --- a/src/pages/docs/cli/push/devices/save.mdx +++ b/src/pages/docs/cli/push/devices/save.mdx @@ -93,3 +93,8 @@ Register a device from a JSON file: ably push devices save --data @device.json ``` + +## See also + +* [Push devices](/docs/cli/push/devices) — Explore all `ably push devices` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/push/index.mdx b/src/pages/docs/cli/push/index.mdx index 37fc2fb177..04f1e728bb 100644 --- a/src/pages/docs/cli/push/index.mdx +++ b/src/pages/docs/cli/push/index.mdx @@ -45,3 +45,7 @@ Use the `ably push` command group to manage push notifications. These commands e | [`ably push devices save`](/docs/cli/push/devices/save) | Register or update a push device. | | [`ably push devices remove`](/docs/cli/push/devices/remove) | Remove a push device registration. | | [`ably push devices remove-where`](/docs/cli/push/devices/remove-where) | Remove push device registrations matching filter criteria. | + +## See also + +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/push/publish.mdx b/src/pages/docs/cli/push/publish.mdx index cfd1599746..1e7b504970 100644 --- a/src/pages/docs/cli/push/publish.mdx +++ b/src/pages/docs/cli/push/publish.mdx @@ -125,3 +125,8 @@ Publish with a custom payload: ably push publish --device-id "device123" --payload '{"notification":{"title":"Custom","body":"Payload"},"data":{"key":"value"}}' ``` + +## See also + +* [Push](/docs/cli/push) — Explore all `ably push` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/queues/create.mdx b/src/pages/docs/cli/queues/create.mdx index 1070844cec..4317163966 100644 --- a/src/pages/docs/cli/queues/create.mdx +++ b/src/pages/docs/cli/queues/create.mdx @@ -69,3 +69,8 @@ Create a queue in a specific region: ably queues create --name "my-queue" --region eu-west-1-a ``` + +## See also + +* [Queues](/docs/cli/queues) — Explore all `ably queues` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/queues/delete.mdx b/src/pages/docs/cli/queues/delete.mdx index 19ceb7136e..b75f9777e1 100644 --- a/src/pages/docs/cli/queues/delete.mdx +++ b/src/pages/docs/cli/queues/delete.mdx @@ -57,3 +57,8 @@ Delete a queue without a confirmation prompt: ably queues delete aBcDe1 --force ``` + +## See also + +* [Queues](/docs/cli/queues) — Explore all `ably queues` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/queues/index.mdx b/src/pages/docs/cli/queues/index.mdx index 79a3baf6e3..835701bb0d 100644 --- a/src/pages/docs/cli/queues/index.mdx +++ b/src/pages/docs/cli/queues/index.mdx @@ -13,3 +13,7 @@ Use the `ably queues` command group to manage your Ably queues. These commands e | [`ably queues create`](/docs/cli/queues/create) | Create a queue. | | [`ably queues delete`](/docs/cli/queues/delete) | Delete a queue. | | [`ably queues list`](/docs/cli/queues/list) | List all queues. | + +## See also + +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/queues/list.mdx b/src/pages/docs/cli/queues/list.mdx index d8a8021f6b..ad234f1f4c 100644 --- a/src/pages/docs/cli/queues/list.mdx +++ b/src/pages/docs/cli/queues/list.mdx @@ -49,3 +49,8 @@ List all queues in JSON format: ably queues list --json ``` + +## See also + +* [Queues](/docs/cli/queues) — Explore all `ably queues` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/rooms/index.mdx b/src/pages/docs/cli/rooms/index.mdx index 34cad9a514..07bff21270 100644 --- a/src/pages/docs/cli/rooms/index.mdx +++ b/src/pages/docs/cli/rooms/index.mdx @@ -64,3 +64,7 @@ Use the `ably rooms` command group to interact with Ably Chat rooms. These comma | [`ably rooms typing`](/docs/cli/rooms/typing) | Commands for working with typing indicators. | | [`ably rooms typing keystroke`](/docs/cli/rooms/typing/keystroke) | Send a typing indicator in a chat room. | | [`ably rooms typing subscribe`](/docs/cli/rooms/typing/subscribe) | Subscribe to typing indicators in a chat room. | + +## See also + +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/rooms/list.mdx b/src/pages/docs/cli/rooms/list.mdx index 84a7c5ff26..7442d33a9c 100644 --- a/src/pages/docs/cli/rooms/list.mdx +++ b/src/pages/docs/cli/rooms/list.mdx @@ -49,3 +49,8 @@ Filter rooms by prefix: ably rooms list --prefix "game-" ``` + +## See also + +* [Rooms](/docs/cli/rooms) — Explore all `ably rooms` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/rooms/messages/delete.mdx b/src/pages/docs/cli/rooms/messages/delete.mdx index b9854d439a..554753bfdd 100644 --- a/src/pages/docs/cli/rooms/messages/delete.mdx +++ b/src/pages/docs/cli/rooms/messages/delete.mdx @@ -61,3 +61,8 @@ Delete a message with a description: ably rooms messages delete my-room "01a2b3c4d5@1234567890000-0" --description "Removed inappropriate content" ``` + +## See also + +* [Rooms messages](/docs/cli/rooms/messages) — Explore all `ably rooms messages` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/rooms/messages/history.mdx b/src/pages/docs/cli/rooms/messages/history.mdx index f56ecbc90c..9c25976508 100644 --- a/src/pages/docs/cli/rooms/messages/history.mdx +++ b/src/pages/docs/cli/rooms/messages/history.mdx @@ -85,3 +85,8 @@ Get history in oldest-first order: ably rooms messages history my-room --order oldestFirst ``` + +## See also + +* [Rooms messages](/docs/cli/rooms/messages) — Explore all `ably rooms messages` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/rooms/messages/index.mdx b/src/pages/docs/cli/rooms/messages/index.mdx index a61bdaf1ff..cdeb1d1955 100644 --- a/src/pages/docs/cli/rooms/messages/index.mdx +++ b/src/pages/docs/cli/rooms/messages/index.mdx @@ -15,3 +15,8 @@ Use the `ably rooms messages` command group to work with chat messages in rooms. | [`ably rooms messages history`](/docs/cli/rooms/messages/history) | Get historical messages from a chat room. | | [`ably rooms messages update`](/docs/cli/rooms/messages/update) | Update a message in a chat room. | | [`ably rooms messages delete`](/docs/cli/rooms/messages/delete) | Delete a message in a chat room. | + +## See also + +* [Rooms](/docs/cli/rooms) — Explore all `ably rooms` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/rooms/messages/reactions/index.mdx b/src/pages/docs/cli/rooms/messages/reactions/index.mdx index 53bcf576b3..76615d5356 100644 --- a/src/pages/docs/cli/rooms/messages/reactions/index.mdx +++ b/src/pages/docs/cli/rooms/messages/reactions/index.mdx @@ -13,3 +13,8 @@ Use the `ably rooms messages reactions` command group to work with message react | [`ably rooms messages reactions send`](/docs/cli/rooms/messages/reactions/send) | Send a reaction to a message. | | [`ably rooms messages reactions subscribe`](/docs/cli/rooms/messages/reactions/subscribe) | Subscribe to message reactions. | | [`ably rooms messages reactions remove`](/docs/cli/rooms/messages/reactions/remove) | Remove a reaction from a message. | + +## See also + +* [Rooms messages](/docs/cli/rooms/messages) — Explore all `ably rooms messages` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/rooms/messages/reactions/remove.mdx b/src/pages/docs/cli/rooms/messages/reactions/remove.mdx index bb1b3370a0..01735af531 100644 --- a/src/pages/docs/cli/rooms/messages/reactions/remove.mdx +++ b/src/pages/docs/cli/rooms/messages/reactions/remove.mdx @@ -65,3 +65,8 @@ Remove a reaction with a specific type: ably rooms messages reactions remove my-room "01a2b3c4d5@1234567890000-0" "heart" --type unique ``` + +## See also + +* [Rooms messages reactions](/docs/cli/rooms/messages/reactions) — Explore all `ably rooms messages reactions` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/rooms/messages/reactions/send.mdx b/src/pages/docs/cli/rooms/messages/reactions/send.mdx index d54b463bfe..3b3aa94b18 100644 --- a/src/pages/docs/cli/rooms/messages/reactions/send.mdx +++ b/src/pages/docs/cli/rooms/messages/reactions/send.mdx @@ -77,3 +77,8 @@ Send multiple reactions: ably rooms messages reactions send my-room "01a2b3c4d5@1234567890000-0" "clap" --type multiple --count 5 ``` + +## See also + +* [Rooms messages reactions](/docs/cli/rooms/messages/reactions) — Explore all `ably rooms messages reactions` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/rooms/messages/reactions/subscribe.mdx b/src/pages/docs/cli/rooms/messages/reactions/subscribe.mdx index 3b58a20f98..72fc32ae79 100644 --- a/src/pages/docs/cli/rooms/messages/reactions/subscribe.mdx +++ b/src/pages/docs/cli/rooms/messages/reactions/subscribe.mdx @@ -61,3 +61,8 @@ Subscribe and get raw events: ably rooms messages reactions subscribe my-room --raw ``` + +## See also + +* [Rooms messages reactions](/docs/cli/rooms/messages/reactions) — Explore all `ably rooms messages reactions` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/rooms/messages/send.mdx b/src/pages/docs/cli/rooms/messages/send.mdx index a74eb217a7..c593492e5c 100644 --- a/src/pages/docs/cli/rooms/messages/send.mdx +++ b/src/pages/docs/cli/rooms/messages/send.mdx @@ -81,3 +81,8 @@ Send a message with metadata: ably rooms messages send my-room "Hello" --metadata '{"priority": "high"}' ``` + +## See also + +* [Rooms messages](/docs/cli/rooms/messages) — Explore all `ably rooms messages` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/rooms/messages/subscribe.mdx b/src/pages/docs/cli/rooms/messages/subscribe.mdx index 9bd231ce2e..4b000d23c3 100644 --- a/src/pages/docs/cli/rooms/messages/subscribe.mdx +++ b/src/pages/docs/cli/rooms/messages/subscribe.mdx @@ -73,3 +73,8 @@ Subscribe and show metadata: ably rooms messages subscribe my-room --show-metadata ``` + +## See also + +* [Rooms messages](/docs/cli/rooms/messages) — Explore all `ably rooms messages` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/rooms/messages/update.mdx b/src/pages/docs/cli/rooms/messages/update.mdx index 4f5070e42e..4c3aa18a8f 100644 --- a/src/pages/docs/cli/rooms/messages/update.mdx +++ b/src/pages/docs/cli/rooms/messages/update.mdx @@ -81,3 +81,8 @@ Update a message with metadata: ably rooms messages update my-room "01a2b3c4d5@1234567890000-0" "Edited message" --metadata '{"edited": true}' ``` + +## See also + +* [Rooms messages](/docs/cli/rooms/messages) — Explore all `ably rooms messages` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/rooms/occupancy/get.mdx b/src/pages/docs/cli/rooms/occupancy/get.mdx index acb2203d4b..78d251a1b6 100644 --- a/src/pages/docs/cli/rooms/occupancy/get.mdx +++ b/src/pages/docs/cli/rooms/occupancy/get.mdx @@ -49,3 +49,8 @@ Get occupancy in JSON format: ably rooms occupancy get my-room --json ``` + +## See also + +* [Rooms occupancy](/docs/cli/rooms/occupancy) — Explore all `ably rooms occupancy` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/rooms/occupancy/index.mdx b/src/pages/docs/cli/rooms/occupancy/index.mdx index 63f7bb21e0..8ad35d417a 100644 --- a/src/pages/docs/cli/rooms/occupancy/index.mdx +++ b/src/pages/docs/cli/rooms/occupancy/index.mdx @@ -12,3 +12,8 @@ Use the `ably rooms occupancy` command group to monitor room occupancy in chat r | ------- | ----------- | | [`ably rooms occupancy get`](/docs/cli/rooms/occupancy/get) | Get current occupancy metrics for a room. | | [`ably rooms occupancy subscribe`](/docs/cli/rooms/occupancy/subscribe) | Subscribe to real-time occupancy metrics for a room. | + +## See also + +* [Rooms](/docs/cli/rooms) — Explore all `ably rooms` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/rooms/occupancy/subscribe.mdx b/src/pages/docs/cli/rooms/occupancy/subscribe.mdx index 0d8e2db5ce..70af4fd7b8 100644 --- a/src/pages/docs/cli/rooms/occupancy/subscribe.mdx +++ b/src/pages/docs/cli/rooms/occupancy/subscribe.mdx @@ -57,3 +57,8 @@ Subscribe for a specific duration: ably rooms occupancy subscribe my-room --duration 60 ``` + +## See also + +* [Rooms occupancy](/docs/cli/rooms/occupancy) — Explore all `ably rooms occupancy` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/rooms/presence/enter.mdx b/src/pages/docs/cli/rooms/presence/enter.mdx index 048d3a9cc3..fceed09fff 100644 --- a/src/pages/docs/cli/rooms/presence/enter.mdx +++ b/src/pages/docs/cli/rooms/presence/enter.mdx @@ -77,3 +77,8 @@ Enter presence and show other members' events: ably rooms presence enter my-room --show-others ``` + +## See also + +* [Rooms presence](/docs/cli/rooms/presence) — Explore all `ably rooms presence` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/rooms/presence/get.mdx b/src/pages/docs/cli/rooms/presence/get.mdx index 9654ee1c54..d20fe0c6bf 100644 --- a/src/pages/docs/cli/rooms/presence/get.mdx +++ b/src/pages/docs/cli/rooms/presence/get.mdx @@ -53,3 +53,8 @@ Get presence members with a limit: ably rooms presence get my-room --limit 10 ``` + +## See also + +* [Rooms presence](/docs/cli/rooms/presence) — Explore all `ably rooms presence` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/rooms/presence/index.mdx b/src/pages/docs/cli/rooms/presence/index.mdx index 2eafe4464f..e3d7b9784d 100644 --- a/src/pages/docs/cli/rooms/presence/index.mdx +++ b/src/pages/docs/cli/rooms/presence/index.mdx @@ -13,3 +13,8 @@ Use the `ably rooms presence` command group to work with presence in chat rooms. | [`ably rooms presence enter`](/docs/cli/rooms/presence/enter) | Enter presence in a chat room. | | [`ably rooms presence get`](/docs/cli/rooms/presence/get) | Get current presence members in a chat room. | | [`ably rooms presence subscribe`](/docs/cli/rooms/presence/subscribe) | Subscribe to presence events in a chat room. | + +## See also + +* [Rooms](/docs/cli/rooms) — Explore all `ably rooms` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/rooms/presence/subscribe.mdx b/src/pages/docs/cli/rooms/presence/subscribe.mdx index 3696f266a3..a18ccecb46 100644 --- a/src/pages/docs/cli/rooms/presence/subscribe.mdx +++ b/src/pages/docs/cli/rooms/presence/subscribe.mdx @@ -57,3 +57,8 @@ Subscribe for a specific duration: ably rooms presence subscribe my-room --duration 120 ``` + +## See also + +* [Rooms presence](/docs/cli/rooms/presence) — Explore all `ably rooms presence` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/rooms/reactions/index.mdx b/src/pages/docs/cli/rooms/reactions/index.mdx index 7d7a5dd85e..b63cdf6857 100644 --- a/src/pages/docs/cli/rooms/reactions/index.mdx +++ b/src/pages/docs/cli/rooms/reactions/index.mdx @@ -12,3 +12,8 @@ Use the `ably rooms reactions` command group to work with room-level reactions i | ------- | ----------- | | [`ably rooms reactions send`](/docs/cli/rooms/reactions/send) | Send a reaction in a chat room. | | [`ably rooms reactions subscribe`](/docs/cli/rooms/reactions/subscribe) | Subscribe to reactions in a chat room. | + +## See also + +* [Rooms](/docs/cli/rooms) — Explore all `ably rooms` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/rooms/reactions/send.mdx b/src/pages/docs/cli/rooms/reactions/send.mdx index fb1a108196..c5b5002d86 100644 --- a/src/pages/docs/cli/rooms/reactions/send.mdx +++ b/src/pages/docs/cli/rooms/reactions/send.mdx @@ -61,3 +61,8 @@ Send a reaction with metadata: ably rooms reactions send my-room "thumbsup" --metadata '{"context": "great idea"}' ``` + +## See also + +* [Rooms reactions](/docs/cli/rooms/reactions) — Explore all `ably rooms reactions` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/rooms/reactions/subscribe.mdx b/src/pages/docs/cli/rooms/reactions/subscribe.mdx index 2c95a67bb1..6fb41539bf 100644 --- a/src/pages/docs/cli/rooms/reactions/subscribe.mdx +++ b/src/pages/docs/cli/rooms/reactions/subscribe.mdx @@ -57,3 +57,8 @@ Subscribe for a specific duration: ably rooms reactions subscribe my-room --duration 60 ``` + +## See also + +* [Rooms reactions](/docs/cli/rooms/reactions) — Explore all `ably rooms reactions` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/rooms/typing/index.mdx b/src/pages/docs/cli/rooms/typing/index.mdx index ef0e3dc2c1..885e184c0f 100644 --- a/src/pages/docs/cli/rooms/typing/index.mdx +++ b/src/pages/docs/cli/rooms/typing/index.mdx @@ -12,3 +12,8 @@ Use the `ably rooms typing` command group to work with typing indicators in chat | ------- | ----------- | | [`ably rooms typing keystroke`](/docs/cli/rooms/typing/keystroke) | Send a typing indicator in a chat room. | | [`ably rooms typing subscribe`](/docs/cli/rooms/typing/subscribe) | Subscribe to typing indicators in a chat room. | + +## See also + +* [Rooms](/docs/cli/rooms) — Explore all `ably rooms` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/rooms/typing/keystroke.mdx b/src/pages/docs/cli/rooms/typing/keystroke.mdx index 5f4a8c958c..8c9f3e8587 100644 --- a/src/pages/docs/cli/rooms/typing/keystroke.mdx +++ b/src/pages/docs/cli/rooms/typing/keystroke.mdx @@ -61,3 +61,8 @@ Keep the typing indicator active continuously: ably rooms typing keystroke my-room --auto-type ``` + +## See also + +* [Rooms typing](/docs/cli/rooms/typing) — Explore all `ably rooms typing` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/rooms/typing/subscribe.mdx b/src/pages/docs/cli/rooms/typing/subscribe.mdx index 4e16880e8c..90b28f633c 100644 --- a/src/pages/docs/cli/rooms/typing/subscribe.mdx +++ b/src/pages/docs/cli/rooms/typing/subscribe.mdx @@ -57,3 +57,8 @@ Subscribe for a specific duration: ably rooms typing subscribe my-room --duration 60 ``` + +## See also + +* [Rooms typing](/docs/cli/rooms/typing) — Explore all `ably rooms typing` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/spaces/create.mdx b/src/pages/docs/cli/spaces/create.mdx index ebbf7267bf..dae0fe5e05 100644 --- a/src/pages/docs/cli/spaces/create.mdx +++ b/src/pages/docs/cli/spaces/create.mdx @@ -53,3 +53,8 @@ Create a space with a specific client ID: ably spaces create my-space --client-id "user-123" ``` + +## See also + +* [Spaces](/docs/cli/spaces) — Explore all `ably spaces` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/spaces/cursors/get.mdx b/src/pages/docs/cli/spaces/cursors/get.mdx index abe12cabc9..1e1736ea19 100644 --- a/src/pages/docs/cli/spaces/cursors/get.mdx +++ b/src/pages/docs/cli/spaces/cursors/get.mdx @@ -49,3 +49,8 @@ Get cursors in JSON format: ably spaces cursors get my-space --json ``` + +## See also + +* [Spaces cursors](/docs/cli/spaces/cursors) — Explore all `ably spaces cursors` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/spaces/cursors/index.mdx b/src/pages/docs/cli/spaces/cursors/index.mdx index 73ae25d111..3152daf955 100644 --- a/src/pages/docs/cli/spaces/cursors/index.mdx +++ b/src/pages/docs/cli/spaces/cursors/index.mdx @@ -13,3 +13,8 @@ Use the `ably spaces cursors` command group to manage cursors in Ably Spaces. | [`ably spaces cursors get`](/docs/cli/spaces/cursors/get) | Get all current cursors in a space. | | [`ably spaces cursors set`](/docs/cli/spaces/cursors/set) | Set a cursor with position data in a space. | | [`ably spaces cursors subscribe`](/docs/cli/spaces/cursors/subscribe) | Subscribe to cursor movements in a space. | + +## See also + +* [Spaces](/docs/cli/spaces) — Explore all `ably spaces` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/spaces/cursors/set.mdx b/src/pages/docs/cli/spaces/cursors/set.mdx index e15806dac2..572130742d 100644 --- a/src/pages/docs/cli/spaces/cursors/set.mdx +++ b/src/pages/docs/cli/spaces/cursors/set.mdx @@ -81,3 +81,8 @@ Simulate random cursor movement: ably spaces cursors set my-space --simulate --duration 30 ``` + +## See also + +* [Spaces cursors](/docs/cli/spaces/cursors) — Explore all `ably spaces cursors` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/spaces/cursors/subscribe.mdx b/src/pages/docs/cli/spaces/cursors/subscribe.mdx index de77d4acb6..26f44327f6 100644 --- a/src/pages/docs/cli/spaces/cursors/subscribe.mdx +++ b/src/pages/docs/cli/spaces/cursors/subscribe.mdx @@ -57,3 +57,8 @@ Subscribe for a specific duration: ably spaces cursors subscribe my-space --duration 60 ``` + +## See also + +* [Spaces cursors](/docs/cli/spaces/cursors) — Explore all `ably spaces cursors` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/spaces/get.mdx b/src/pages/docs/cli/spaces/get.mdx index 694c2b0b01..8c8aa0a994 100644 --- a/src/pages/docs/cli/spaces/get.mdx +++ b/src/pages/docs/cli/spaces/get.mdx @@ -49,3 +49,8 @@ Get the state of a space in JSON format: ably spaces get my-space --json ``` + +## See also + +* [Spaces](/docs/cli/spaces) — Explore all `ably spaces` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/spaces/index.mdx b/src/pages/docs/cli/spaces/index.mdx index 1715597f10..6dc39e59a6 100644 --- a/src/pages/docs/cli/spaces/index.mdx +++ b/src/pages/docs/cli/spaces/index.mdx @@ -58,3 +58,7 @@ Use the `ably spaces` command group to interact with Ably Spaces. These commands | [`ably spaces occupancy`](/docs/cli/spaces/occupancy) | Commands for working with occupancy in Ably Spaces. | | [`ably spaces occupancy get`](/docs/cli/spaces/occupancy/get) | Get current occupancy metrics for a space. | | [`ably spaces occupancy subscribe`](/docs/cli/spaces/occupancy/subscribe) | Subscribe to occupancy events on a space. | + +## See also + +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/spaces/list.mdx b/src/pages/docs/cli/spaces/list.mdx index f9f86e2d94..cfa5591cc9 100644 --- a/src/pages/docs/cli/spaces/list.mdx +++ b/src/pages/docs/cli/spaces/list.mdx @@ -57,3 +57,8 @@ List spaces with a custom limit: ably spaces list --limit 50 ``` + +## See also + +* [Spaces](/docs/cli/spaces) — Explore all `ably spaces` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/spaces/locations/get.mdx b/src/pages/docs/cli/spaces/locations/get.mdx index 133b0c0321..05d2025ee4 100644 --- a/src/pages/docs/cli/spaces/locations/get.mdx +++ b/src/pages/docs/cli/spaces/locations/get.mdx @@ -49,3 +49,8 @@ Get locations in JSON format: ably spaces locations get my-space --json ``` + +## See also + +* [Spaces locations](/docs/cli/spaces/locations) — Explore all `ably spaces locations` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/spaces/locations/index.mdx b/src/pages/docs/cli/spaces/locations/index.mdx index ae99a7df7f..062965f576 100644 --- a/src/pages/docs/cli/spaces/locations/index.mdx +++ b/src/pages/docs/cli/spaces/locations/index.mdx @@ -13,3 +13,8 @@ Use the `ably spaces locations` command group to manage locations in Ably Spaces | [`ably spaces locations get`](/docs/cli/spaces/locations/get) | Get all current locations in a space. | | [`ably spaces locations set`](/docs/cli/spaces/locations/set) | Set location in a space. | | [`ably spaces locations subscribe`](/docs/cli/spaces/locations/subscribe) | Subscribe to location updates for members in a space. | + +## See also + +* [Spaces](/docs/cli/spaces) — Explore all `ably spaces` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/spaces/locations/set.mdx b/src/pages/docs/cli/spaces/locations/set.mdx index d6867ed0c4..33bd672971 100644 --- a/src/pages/docs/cli/spaces/locations/set.mdx +++ b/src/pages/docs/cli/spaces/locations/set.mdx @@ -61,3 +61,8 @@ Set a location with a specific duration: ably spaces locations set my-space --location '{"slide": 5}' --duration 120 ``` + +## See also + +* [Spaces locations](/docs/cli/spaces/locations) — Explore all `ably spaces locations` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/spaces/locations/subscribe.mdx b/src/pages/docs/cli/spaces/locations/subscribe.mdx index 7213744d47..9aeb8699ae 100644 --- a/src/pages/docs/cli/spaces/locations/subscribe.mdx +++ b/src/pages/docs/cli/spaces/locations/subscribe.mdx @@ -57,3 +57,8 @@ Subscribe for a specific duration: ably spaces locations subscribe my-space --duration 60 ``` + +## See also + +* [Spaces locations](/docs/cli/spaces/locations) — Explore all `ably spaces locations` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/spaces/locks/acquire.mdx b/src/pages/docs/cli/spaces/locks/acquire.mdx index ac4a027658..d353e6499c 100644 --- a/src/pages/docs/cli/spaces/locks/acquire.mdx +++ b/src/pages/docs/cli/spaces/locks/acquire.mdx @@ -73,3 +73,8 @@ Acquire a lock for a specific duration: ably spaces locks acquire my-space my-lock --duration 300 ``` + +## See also + +* [Spaces locks](/docs/cli/spaces/locks) — Explore all `ably spaces locks` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/spaces/locks/get.mdx b/src/pages/docs/cli/spaces/locks/get.mdx index 91c1f2d154..c89096b8d5 100644 --- a/src/pages/docs/cli/spaces/locks/get.mdx +++ b/src/pages/docs/cli/spaces/locks/get.mdx @@ -53,3 +53,8 @@ Get a specific lock: ably spaces locks get my-space my-lock ``` + +## See also + +* [Spaces locks](/docs/cli/spaces/locks) — Explore all `ably spaces locks` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/spaces/locks/index.mdx b/src/pages/docs/cli/spaces/locks/index.mdx index 1ecf9a85ac..12c3b8fc46 100644 --- a/src/pages/docs/cli/spaces/locks/index.mdx +++ b/src/pages/docs/cli/spaces/locks/index.mdx @@ -13,3 +13,8 @@ Use the `ably spaces locks` command group to manage component locking in Ably Sp | [`ably spaces locks acquire`](/docs/cli/spaces/locks/acquire) | Acquire a lock in a space. | | [`ably spaces locks get`](/docs/cli/spaces/locks/get) | Get a lock or all locks in a space. | | [`ably spaces locks subscribe`](/docs/cli/spaces/locks/subscribe) | Subscribe to lock events in a space. | + +## See also + +* [Spaces](/docs/cli/spaces) — Explore all `ably spaces` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/spaces/locks/subscribe.mdx b/src/pages/docs/cli/spaces/locks/subscribe.mdx index f8b0b33f31..72fbeb4b5e 100644 --- a/src/pages/docs/cli/spaces/locks/subscribe.mdx +++ b/src/pages/docs/cli/spaces/locks/subscribe.mdx @@ -57,3 +57,8 @@ Subscribe for a specific duration: ably spaces locks subscribe my-space --duration 60 ``` + +## See also + +* [Spaces locks](/docs/cli/spaces/locks) — Explore all `ably spaces locks` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/spaces/members/enter.mdx b/src/pages/docs/cli/spaces/members/enter.mdx index 8d4813a424..cf1fbbe935 100644 --- a/src/pages/docs/cli/spaces/members/enter.mdx +++ b/src/pages/docs/cli/spaces/members/enter.mdx @@ -69,3 +69,8 @@ Enter a space for a specific duration: ably spaces members enter my-space --duration 120 ``` + +## See also + +* [Spaces members](/docs/cli/spaces/members) — Explore all `ably spaces members` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/spaces/members/get.mdx b/src/pages/docs/cli/spaces/members/get.mdx index 35b126036c..b5a56fc3fc 100644 --- a/src/pages/docs/cli/spaces/members/get.mdx +++ b/src/pages/docs/cli/spaces/members/get.mdx @@ -49,3 +49,8 @@ Get members in JSON format: ably spaces members get my-space --json ``` + +## See also + +* [Spaces members](/docs/cli/spaces/members) — Explore all `ably spaces members` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/spaces/members/index.mdx b/src/pages/docs/cli/spaces/members/index.mdx index cf70a7cc19..36cec46f72 100644 --- a/src/pages/docs/cli/spaces/members/index.mdx +++ b/src/pages/docs/cli/spaces/members/index.mdx @@ -13,3 +13,8 @@ Use the `ably spaces members` command group to manage members in Ably Spaces. | [`ably spaces members enter`](/docs/cli/spaces/members/enter) | Enter a space and remain present until terminated. | | [`ably spaces members get`](/docs/cli/spaces/members/get) | Get all members in a space. | | [`ably spaces members subscribe`](/docs/cli/spaces/members/subscribe) | Subscribe to member presence events in a space. | + +## See also + +* [Spaces](/docs/cli/spaces) — Explore all `ably spaces` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/spaces/members/subscribe.mdx b/src/pages/docs/cli/spaces/members/subscribe.mdx index 3815a9898d..ed2da943b1 100644 --- a/src/pages/docs/cli/spaces/members/subscribe.mdx +++ b/src/pages/docs/cli/spaces/members/subscribe.mdx @@ -57,3 +57,8 @@ Subscribe for a specific duration: ably spaces members subscribe my-space --duration 60 ``` + +## See also + +* [Spaces members](/docs/cli/spaces/members) — Explore all `ably spaces members` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/spaces/occupancy/get.mdx b/src/pages/docs/cli/spaces/occupancy/get.mdx index a20da274e0..873c3ad2dc 100644 --- a/src/pages/docs/cli/spaces/occupancy/get.mdx +++ b/src/pages/docs/cli/spaces/occupancy/get.mdx @@ -49,3 +49,8 @@ Get occupancy in JSON format: ably spaces occupancy get my-space --json ``` + +## See also + +* [Spaces occupancy](/docs/cli/spaces/occupancy) — Explore all `ably spaces occupancy` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/spaces/occupancy/index.mdx b/src/pages/docs/cli/spaces/occupancy/index.mdx index 3b6e79fc0e..6d10ebfbab 100644 --- a/src/pages/docs/cli/spaces/occupancy/index.mdx +++ b/src/pages/docs/cli/spaces/occupancy/index.mdx @@ -12,3 +12,8 @@ Use the `ably spaces occupancy` command group to work with occupancy in Ably Spa | ------- | ----------- | | [`ably spaces occupancy get`](/docs/cli/spaces/occupancy/get) | Get current occupancy metrics for a space. | | [`ably spaces occupancy subscribe`](/docs/cli/spaces/occupancy/subscribe) | Subscribe to occupancy events on a space. | + +## See also + +* [Spaces](/docs/cli/spaces) — Explore all `ably spaces` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/spaces/occupancy/subscribe.mdx b/src/pages/docs/cli/spaces/occupancy/subscribe.mdx index 1c75fd2b50..9fc940a937 100644 --- a/src/pages/docs/cli/spaces/occupancy/subscribe.mdx +++ b/src/pages/docs/cli/spaces/occupancy/subscribe.mdx @@ -57,3 +57,8 @@ Subscribe for a specific duration: ably spaces occupancy subscribe my-space --duration 60 ``` + +## See also + +* [Spaces occupancy](/docs/cli/spaces/occupancy) — Explore all `ably spaces occupancy` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/spaces/subscribe.mdx b/src/pages/docs/cli/spaces/subscribe.mdx index 5984f3ad4e..12d775399a 100644 --- a/src/pages/docs/cli/spaces/subscribe.mdx +++ b/src/pages/docs/cli/spaces/subscribe.mdx @@ -57,3 +57,8 @@ Subscribe for a specific duration: ably spaces subscribe my-space --duration 60 ``` + +## See also + +* [Spaces](/docs/cli/spaces) — Explore all `ably spaces` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/stats/account.mdx b/src/pages/docs/cli/stats/account.mdx index cfc44e0b9d..bf706a71fc 100644 --- a/src/pages/docs/cli/stats/account.mdx +++ b/src/pages/docs/cli/stats/account.mdx @@ -93,3 +93,8 @@ Subscribe to live stats with a custom polling interval: ably stats account --live --interval 10 ``` + +## See also + +* [Stats](/docs/cli/stats) — Explore all `ably stats` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/stats/app.mdx b/src/pages/docs/cli/stats/app.mdx index 77b8c88623..e643119741 100644 --- a/src/pages/docs/cli/stats/app.mdx +++ b/src/pages/docs/cli/stats/app.mdx @@ -93,3 +93,8 @@ Subscribe to live stats updates: ably stats app --live ``` + +## See also + +* [Stats](/docs/cli/stats) — Explore all `ably stats` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/stats/index.mdx b/src/pages/docs/cli/stats/index.mdx index 2a0292813a..610881f14e 100644 --- a/src/pages/docs/cli/stats/index.mdx +++ b/src/pages/docs/cli/stats/index.mdx @@ -12,3 +12,7 @@ Use the `ably stats` command group to view statistics for your Ably account or a | ------- | ----------- | | [`ably stats account`](/docs/cli/stats/account) | Get account-level statistics. | | [`ably stats app`](/docs/cli/stats/app) | Get app-level statistics. | + +## See also + +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/status.mdx b/src/pages/docs/cli/status.mdx index fad67464a3..e8538529a4 100644 --- a/src/pages/docs/cli/status.mdx +++ b/src/pages/docs/cli/status.mdx @@ -45,3 +45,7 @@ Check status with JSON output: ably status --json ``` + +## See also + +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/support/ask.mdx b/src/pages/docs/cli/support/ask.mdx index 0d2cf010cf..d79742f0a2 100644 --- a/src/pages/docs/cli/support/ask.mdx +++ b/src/pages/docs/cli/support/ask.mdx @@ -61,3 +61,8 @@ Continue a previous conversation: ably support ask "Can you give me more details?" --continue ``` + +## See also + +* [Support](/docs/cli/support) — Explore all `ably support` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/support/contact.mdx b/src/pages/docs/cli/support/contact.mdx index 935d619522..bf56f7d4fe 100644 --- a/src/pages/docs/cli/support/contact.mdx +++ b/src/pages/docs/cli/support/contact.mdx @@ -21,3 +21,8 @@ Open the Ably contact page: ably support contact ``` + +## See also + +* [Support](/docs/cli/support) — Explore all `ably support` commands. +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/support/index.mdx b/src/pages/docs/cli/support/index.mdx index 8a32206da9..47eb9b1871 100644 --- a/src/pages/docs/cli/support/index.mdx +++ b/src/pages/docs/cli/support/index.mdx @@ -12,3 +12,7 @@ Use the `ably support` command group to get support and help from Ably. These co | ------- | ----------- | | [`ably support ask`](/docs/cli/support/ask) | Ask a question to the Ably AI agent. | | [`ably support contact`](/docs/cli/support/contact) | Open the Ably contact page. | + +## See also + +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/version.mdx b/src/pages/docs/cli/version.mdx index 6c760df608..205eb81b73 100644 --- a/src/pages/docs/cli/version.mdx +++ b/src/pages/docs/cli/version.mdx @@ -29,3 +29,7 @@ Display the CLI version: ably version ``` + +## See also + +* [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/platform/tools/cli.mdx b/src/pages/docs/platform/tools/cli.mdx index e0c02644ef..b3a8d483a2 100644 --- a/src/pages/docs/platform/tools/cli.mdx +++ b/src/pages/docs/platform/tools/cli.mdx @@ -4,11 +4,7 @@ meta_description: "The Ably CLI is a command-line interface for managing Ably re meta_keywords: "Ably CLI, command line, terminal, developer tools" --- - - -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](https://github.com/ably/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. It's a quick and easy way to simulate additional clients when testing how Ably works. @@ -82,40 +78,42 @@ You can use the Ably CLI for undertaking operations such as: | Operation | Description | | --------- | ----------- | | **Ably Accounts** || -| List accounts | List the accounts you have access to. | -| Switch accounts | Switch between multiple Ably accounts. | -| Account statistics | Query your account statistics. | +| [List accounts](/docs/cli/accounts/list) | List the accounts you have access to. | +| [Switch accounts](/docs/cli/accounts/switch) | Switch between multiple Ably accounts. | +| [Account statistics](/docs/cli/stats/account) | Query your account statistics. | | **Ably Apps** || -| List apps | List all apps in your account. | -| Switch apps | Switch between multiple apps. | -| Manage apps | Create and delete apps. | -| Manage API keys | Create, update and revoke API keys in an app. | -| App statistics | Query app statistics. | -| Manage rules | Create, update and delete rules in an app. | -| Logs | Query and subscribe to logs. | +| [List apps](/docs/cli/apps/list) | List all apps in your account. | +| [Switch apps](/docs/cli/apps/switch) | Switch between multiple apps. | +| [Manage apps](/docs/cli/apps) | Create and delete apps. | +| [Manage API keys](/docs/cli/auth/keys) | Create, update and revoke API keys in an app. | +| [App statistics](/docs/cli/stats/app) | Query app statistics. | +| [Manage rules](/docs/cli/apps/rules) | Create, update and delete rules in an app. | +| [Logs](/docs/cli/logs) | Query and subscribe to logs. | | **Integrations and Queues** || -| Manage integrations | List, create and delete integrations. | -| Manage queues | List, create and delete queues. | +| [Manage integrations](/docs/cli/integrations) | List, create and delete integrations. | +| [Manage queues](/docs/cli/queues) | List, create and delete queues. | | **Pub/Sub** || -| List channels | List active channels in an app. | -| Publish | Publish and batch publish messages. | -| Subscribe | Subscribe to messages on channels. | -| Presence | Enter and subscribe to the presence set of channels. | -| History | Query message history. | -| Occupancy | Fetch and subscribe to channel occupancy. | +| [List channels](/docs/cli/channels/list) | List active channels in an app. | +| [Publish](/docs/cli/channels/publish) | Publish and batch publish messages. | +| [Subscribe](/docs/cli/channels/subscribe) | Subscribe to messages on channels. | +| [Presence](/docs/cli/channels/presence) | Enter and subscribe to the presence set of channels. | +| [History](/docs/cli/channels/history) | Query message history. | +| [Occupancy](/docs/cli/channels/occupancy) | Fetch and subscribe to channel occupancy. | | **Chat** || -| List rooms | List chat rooms in an app. | -| Messages | Send and subscribe to messages. | -| Presence | Enter and subscribe to the presence set of chat rooms. | -| History | Query chat message history. | -| Occupancy | Fetch and subscribe to chat room occupancy. | -| Reactions | Send and subscribe to message-level and room-level reactions. | -| Typing indicators | Send and subscribe to typing indicators. | +| [List rooms](/docs/cli/rooms/list) | List chat rooms in an app. | +| [Messages](/docs/cli/rooms/messages) | Send and subscribe to messages. | +| [Presence](/docs/cli/rooms/presence) | Enter and subscribe to the presence set of chat rooms. | +| [History](/docs/cli/rooms/messages/history) | Query chat message history. | +| [Occupancy](/docs/cli/rooms/occupancy) | Fetch and subscribe to chat room occupancy. | +| [Reactions](/docs/cli/rooms/reactions) | Send and subscribe to message-level and room-level reactions. | +| [Typing indicators](/docs/cli/rooms/typing) | Send and subscribe to typing indicators. | | **Spaces** || -| List spaces | List spaces in an app. | -| Members | Enter and subscribe the list of members. | -| Locations | Set and subscribe to member locations. | -| Cursors | Set and subscribe to member cursors. | -| Locks | Acquire and subscribe to locks. | +| [List spaces](/docs/cli/spaces/list) | List spaces in an app. | +| [Members](/docs/cli/spaces/members) | Enter and subscribe the list of members. | +| [Locations](/docs/cli/spaces/locations) | Set and subscribe to member locations. | +| [Cursors](/docs/cli/spaces/cursors) | Set and subscribe to member cursors. | +| [Locks](/docs/cli/spaces/locks) | Acquire and subscribe to locks. | +## CLI reference +For detailed documentation on every CLI command, including flags, arguments, and usage examples, see the [CLI reference](/docs/cli). From 5883c5d60cec55d37db27b3f8e650b23c5cf95bd Mon Sep 17 00:00:00 2001 From: sacOO7 Date: Mon, 6 Apr 2026 18:05:15 +0530 Subject: [PATCH 4/9] Updated ably-cli tool page to have explicit sections for auto-complete and interactive mode --- src/pages/docs/platform/tools/cli.mdx | 45 ++++++++++++++++++++++----- 1 file changed, 37 insertions(+), 8 deletions(-) diff --git a/src/pages/docs/platform/tools/cli.mdx b/src/pages/docs/platform/tools/cli.mdx index b3a8d483a2..f4ffb443b8 100644 --- a/src/pages/docs/platform/tools/cli.mdx +++ b/src/pages/docs/platform/tools/cli.mdx @@ -17,9 +17,7 @@ The Ably CLI interacts with: ## Installation -The Ably CLI is available as an NPM package. - -1. Install the Ably CLI: +The Ably CLI is available as an NPM package, install using ```shell @@ -27,7 +25,9 @@ npm install -g @ably/cli ``` -2. Run the following to log in to your Ably account. This will prompt you to log into your Ably account and set up an [access token](/docs/platform/account/access-tokens) for the Ably CLI. You can then set the default app and API key to use back in your terminal instance: +## Usage + +Run the following to log in to your Ably account. This will prompt you to log into your Ably account and set up an [access token](/docs/platform/account/access-tokens) for the Ably CLI. You can then set the default app and API key to use back in your terminal instance: ```shell @@ -35,10 +35,6 @@ ably login ``` -3. Start running commands in the CLI to create and interact with your Ably resources. - -## Usage - After you have successfully authenticated and chosen your app and API key, you're ready to interact with Ably resources directly from your terminal. For example, open two terminal instances and subscribe to one, and publish messages in the other: @@ -114,6 +110,39 @@ You can use the Ably CLI for undertaking operations such as: | [Cursors](/docs/cli/spaces/cursors) | Set and subscribe to member cursors. | | [Locks](/docs/cli/spaces/locks) | Acquire and subscribe to locks. | +## Auto-completion + +The Ably CLI supports shell auto-completion for bash, zsh, and PowerShell. This helps you discover and use commands more efficiently. + +To set up auto-completion, run: + + +```shell +ably autocomplete +``` + + +This displays installation instructions specific to your shell. Follow them to enable tab completion for commands, subcommands, and flags. + +For more details, see the [auto-completion documentation](https://github.com/ably/ably-cli/blob/main/docs/Auto-completion.md) on GitHub. + +## Interactive mode + +The Ably CLI includes an interactive shell mode that provides a more convenient way to work with multiple commands: + + +```shell +ably-interactive +``` + + +Interactive mode provides the following features: + +* **Command history**: Previous commands are saved and can be accessed with up/down arrows. +* **Tab completion**: Full support for command and flag completion. +* **Ctrl+C handling**: A single Ctrl+C interrupts the current command and returns to the prompt. A double Ctrl+C (within 500ms) force quits the shell. +* **No "ably" prefix needed**: Commands can be typed directly, for example `channels list` instead of `ably channels list`. + ## CLI reference For detailed documentation on every CLI command, including flags, arguments, and usage examples, see the [CLI reference](/docs/cli). From 1159ee160d10e553dd41b0bd1fc9c143f1eeaa73 Mon Sep 17 00:00:00 2001 From: sacOO7 Date: Tue, 7 Apr 2026 12:49:36 +0530 Subject: [PATCH 5/9] Added cli commands to nav bar entries for proper navigation --- src/data/nav/platform.ts | 355 +++++++++++++++++- src/pages/docs/cli/accounts/current.mdx | 2 +- src/pages/docs/cli/accounts/index.mdx | 2 +- src/pages/docs/cli/accounts/list.mdx | 2 +- src/pages/docs/cli/accounts/login.mdx | 2 +- src/pages/docs/cli/accounts/logout.mdx | 2 +- src/pages/docs/cli/accounts/switch.mdx | 2 +- src/pages/docs/cli/apps/create.mdx | 2 +- src/pages/docs/cli/apps/current.mdx | 2 +- src/pages/docs/cli/apps/delete.mdx | 2 +- src/pages/docs/cli/apps/index.mdx | 2 +- src/pages/docs/cli/apps/list.mdx | 2 +- src/pages/docs/cli/apps/rules/create.mdx | 2 +- src/pages/docs/cli/apps/rules/delete.mdx | 2 +- src/pages/docs/cli/apps/rules/index.mdx | 2 +- src/pages/docs/cli/apps/rules/list.mdx | 2 +- src/pages/docs/cli/apps/rules/update.mdx | 2 +- src/pages/docs/cli/apps/switch.mdx | 2 +- src/pages/docs/cli/apps/update.mdx | 2 +- src/pages/docs/cli/auth/index.mdx | 2 +- src/pages/docs/cli/auth/issue-ably-token.mdx | 2 +- src/pages/docs/cli/auth/issue-jwt-token.mdx | 2 +- src/pages/docs/cli/auth/keys/create.mdx | 2 +- src/pages/docs/cli/auth/keys/current.mdx | 2 +- src/pages/docs/cli/auth/keys/get.mdx | 2 +- src/pages/docs/cli/auth/keys/index.mdx | 2 +- src/pages/docs/cli/auth/keys/list.mdx | 2 +- src/pages/docs/cli/auth/keys/revoke.mdx | 2 +- src/pages/docs/cli/auth/keys/switch.mdx | 2 +- src/pages/docs/cli/auth/keys/update.mdx | 2 +- src/pages/docs/cli/auth/revoke-token.mdx | 2 +- src/pages/docs/cli/autocomplete.mdx | 2 +- src/pages/docs/cli/bench/index.mdx | 2 +- src/pages/docs/cli/bench/publisher.mdx | 2 +- src/pages/docs/cli/bench/subscriber.mdx | 2 +- .../docs/cli/channels/annotations/delete.mdx | 2 +- .../docs/cli/channels/annotations/get.mdx | 2 +- .../docs/cli/channels/annotations/index.mdx | 2 +- .../docs/cli/channels/annotations/publish.mdx | 2 +- .../cli/channels/annotations/subscribe.mdx | 2 +- src/pages/docs/cli/channels/append.mdx | 2 +- src/pages/docs/cli/channels/batch-publish.mdx | 2 +- src/pages/docs/cli/channels/delete.mdx | 2 +- src/pages/docs/cli/channels/history.mdx | 2 +- src/pages/docs/cli/channels/index.mdx | 2 +- src/pages/docs/cli/channels/inspect.mdx | 2 +- src/pages/docs/cli/channels/list.mdx | 2 +- src/pages/docs/cli/channels/occupancy/get.mdx | 2 +- .../docs/cli/channels/occupancy/index.mdx | 2 +- .../docs/cli/channels/occupancy/subscribe.mdx | 2 +- .../docs/cli/channels/presence/enter.mdx | 2 +- src/pages/docs/cli/channels/presence/get.mdx | 2 +- .../docs/cli/channels/presence/index.mdx | 2 +- .../docs/cli/channels/presence/subscribe.mdx | 2 +- src/pages/docs/cli/channels/publish.mdx | 2 +- src/pages/docs/cli/channels/subscribe.mdx | 2 +- src/pages/docs/cli/channels/update.mdx | 2 +- src/pages/docs/cli/config/index.mdx | 2 +- src/pages/docs/cli/config/path.mdx | 2 +- src/pages/docs/cli/config/show.mdx | 2 +- src/pages/docs/cli/connections/index.mdx | 2 +- src/pages/docs/cli/connections/test.mdx | 2 +- src/pages/docs/cli/help.mdx | 2 +- src/pages/docs/cli/integrations/create.mdx | 2 +- src/pages/docs/cli/integrations/delete.mdx | 2 +- src/pages/docs/cli/integrations/get.mdx | 2 +- src/pages/docs/cli/integrations/index.mdx | 2 +- src/pages/docs/cli/integrations/list.mdx | 2 +- src/pages/docs/cli/integrations/update.mdx | 2 +- src/pages/docs/cli/interactive.mdx | 2 +- src/pages/docs/cli/login.mdx | 2 +- .../docs/cli/logs/channel-lifecycle/index.mdx | 2 +- .../cli/logs/channel-lifecycle/subscribe.mdx | 2 +- .../cli/logs/connection-lifecycle/history.mdx | 2 +- .../cli/logs/connection-lifecycle/index.mdx | 2 +- .../logs/connection-lifecycle/subscribe.mdx | 2 +- src/pages/docs/cli/logs/history.mdx | 2 +- src/pages/docs/cli/logs/index.mdx | 2 +- src/pages/docs/cli/logs/push/history.mdx | 2 +- src/pages/docs/cli/logs/push/index.mdx | 2 +- src/pages/docs/cli/logs/push/subscribe.mdx | 2 +- src/pages/docs/cli/logs/subscribe.mdx | 2 +- src/pages/docs/cli/push/batch-publish.mdx | 2 +- src/pages/docs/cli/push/channels/index.mdx | 2 +- .../docs/cli/push/channels/list-channels.mdx | 2 +- src/pages/docs/cli/push/channels/list.mdx | 2 +- .../docs/cli/push/channels/remove-where.mdx | 2 +- src/pages/docs/cli/push/channels/remove.mdx | 2 +- src/pages/docs/cli/push/channels/save.mdx | 2 +- src/pages/docs/cli/push/config/clear-apns.mdx | 2 +- src/pages/docs/cli/push/config/clear-fcm.mdx | 2 +- src/pages/docs/cli/push/config/index.mdx | 2 +- src/pages/docs/cli/push/config/set-apns.mdx | 2 +- src/pages/docs/cli/push/config/set-fcm.mdx | 2 +- src/pages/docs/cli/push/config/show.mdx | 2 +- src/pages/docs/cli/push/devices/get.mdx | 2 +- src/pages/docs/cli/push/devices/index.mdx | 2 +- src/pages/docs/cli/push/devices/list.mdx | 2 +- .../docs/cli/push/devices/remove-where.mdx | 2 +- src/pages/docs/cli/push/devices/remove.mdx | 2 +- src/pages/docs/cli/push/devices/save.mdx | 2 +- src/pages/docs/cli/push/index.mdx | 2 +- src/pages/docs/cli/push/publish.mdx | 2 +- src/pages/docs/cli/queues/create.mdx | 2 +- src/pages/docs/cli/queues/delete.mdx | 2 +- src/pages/docs/cli/queues/index.mdx | 2 +- src/pages/docs/cli/queues/list.mdx | 2 +- src/pages/docs/cli/rooms/index.mdx | 2 +- src/pages/docs/cli/rooms/list.mdx | 2 +- src/pages/docs/cli/rooms/messages/delete.mdx | 2 +- src/pages/docs/cli/rooms/messages/history.mdx | 2 +- src/pages/docs/cli/rooms/messages/index.mdx | 2 +- .../cli/rooms/messages/reactions/index.mdx | 2 +- .../cli/rooms/messages/reactions/remove.mdx | 2 +- .../cli/rooms/messages/reactions/send.mdx | 2 +- .../rooms/messages/reactions/subscribe.mdx | 2 +- src/pages/docs/cli/rooms/messages/send.mdx | 2 +- .../docs/cli/rooms/messages/subscribe.mdx | 2 +- src/pages/docs/cli/rooms/messages/update.mdx | 2 +- src/pages/docs/cli/rooms/occupancy/get.mdx | 2 +- src/pages/docs/cli/rooms/occupancy/index.mdx | 2 +- .../docs/cli/rooms/occupancy/subscribe.mdx | 2 +- src/pages/docs/cli/rooms/presence/enter.mdx | 2 +- src/pages/docs/cli/rooms/presence/get.mdx | 2 +- src/pages/docs/cli/rooms/presence/index.mdx | 2 +- .../docs/cli/rooms/presence/subscribe.mdx | 2 +- src/pages/docs/cli/rooms/reactions/index.mdx | 2 +- src/pages/docs/cli/rooms/reactions/send.mdx | 2 +- .../docs/cli/rooms/reactions/subscribe.mdx | 2 +- src/pages/docs/cli/rooms/typing/index.mdx | 2 +- src/pages/docs/cli/rooms/typing/keystroke.mdx | 2 +- src/pages/docs/cli/rooms/typing/subscribe.mdx | 2 +- src/pages/docs/cli/spaces/create.mdx | 2 +- src/pages/docs/cli/spaces/cursors/get.mdx | 2 +- src/pages/docs/cli/spaces/cursors/index.mdx | 2 +- src/pages/docs/cli/spaces/cursors/set.mdx | 2 +- .../docs/cli/spaces/cursors/subscribe.mdx | 2 +- src/pages/docs/cli/spaces/get.mdx | 2 +- src/pages/docs/cli/spaces/index.mdx | 2 +- src/pages/docs/cli/spaces/list.mdx | 2 +- src/pages/docs/cli/spaces/locations/get.mdx | 2 +- src/pages/docs/cli/spaces/locations/index.mdx | 2 +- src/pages/docs/cli/spaces/locations/set.mdx | 2 +- .../docs/cli/spaces/locations/subscribe.mdx | 2 +- src/pages/docs/cli/spaces/locks/acquire.mdx | 2 +- src/pages/docs/cli/spaces/locks/get.mdx | 2 +- src/pages/docs/cli/spaces/locks/index.mdx | 2 +- src/pages/docs/cli/spaces/locks/subscribe.mdx | 2 +- src/pages/docs/cli/spaces/members/enter.mdx | 2 +- src/pages/docs/cli/spaces/members/get.mdx | 2 +- src/pages/docs/cli/spaces/members/index.mdx | 2 +- .../docs/cli/spaces/members/subscribe.mdx | 2 +- src/pages/docs/cli/spaces/occupancy/get.mdx | 2 +- src/pages/docs/cli/spaces/occupancy/index.mdx | 2 +- .../docs/cli/spaces/occupancy/subscribe.mdx | 2 +- src/pages/docs/cli/spaces/subscribe.mdx | 2 +- src/pages/docs/cli/stats/account.mdx | 2 +- src/pages/docs/cli/stats/app.mdx | 2 +- src/pages/docs/cli/stats/index.mdx | 2 +- src/pages/docs/cli/status.mdx | 2 +- src/pages/docs/cli/support/ask.mdx | 2 +- src/pages/docs/cli/support/contact.mdx | 2 +- src/pages/docs/cli/support/index.mdx | 2 +- src/pages/docs/cli/version.mdx | 2 +- src/pages/docs/platform/tools/cli.mdx | 6 +- 165 files changed, 520 insertions(+), 167 deletions(-) diff --git a/src/data/nav/platform.ts b/src/data/nav/platform.ts index 4ea54e2171..118529164e 100644 --- a/src/data/nav/platform.ts +++ b/src/data/nav/platform.ts @@ -387,8 +387,361 @@ export default { name: 'Control API', }, { - link: '/docs/cli', name: 'Ably CLI Reference', + pages: [ + { + name: 'Overview', + link: '/docs/cli', + index: true, + }, + { name: 'Login', link: '/docs/cli/login' }, + { + name: 'Accounts', + pages: [ + { name: 'overview', link: '/docs/cli/accounts', index: true }, + { name: 'current', link: '/docs/cli/accounts/current' }, + { name: 'list', link: '/docs/cli/accounts/list' }, + { name: 'login', link: '/docs/cli/accounts/login' }, + { name: 'logout', link: '/docs/cli/accounts/logout' }, + { name: 'switch', link: '/docs/cli/accounts/switch' }, + ], + }, + { + name: 'Apps', + pages: [ + { name: 'overview', link: '/docs/cli/apps', index: true }, + { name: 'create', link: '/docs/cli/apps/create' }, + { name: 'current', link: '/docs/cli/apps/current' }, + { name: 'delete', link: '/docs/cli/apps/delete' }, + { name: 'list', link: '/docs/cli/apps/list' }, + { + name: 'rules', + pages: [ + { name: 'overview', link: '/docs/cli/apps/rules', index: true }, + { name: 'create', link: '/docs/cli/apps/rules/create' }, + { name: 'delete', link: '/docs/cli/apps/rules/delete' }, + { name: 'list', link: '/docs/cli/apps/rules/list' }, + { name: 'update', link: '/docs/cli/apps/rules/update' }, + ], + }, + { name: 'switch', link: '/docs/cli/apps/switch' }, + { name: 'update', link: '/docs/cli/apps/update' }, + ], + }, + { + name: 'Auth', + pages: [ + { name: 'overview', link: '/docs/cli/auth', index: true }, + { name: 'issue-ably-token', link: '/docs/cli/auth/issue-ably-token' }, + { name: 'issue-jwt-token', link: '/docs/cli/auth/issue-jwt-token' }, + { + name: 'keys', + pages: [ + { name: 'overview', link: '/docs/cli/auth/keys', index: true }, + { name: 'create', link: '/docs/cli/auth/keys/create' }, + { name: 'current', link: '/docs/cli/auth/keys/current' }, + { name: 'get', link: '/docs/cli/auth/keys/get' }, + { name: 'list', link: '/docs/cli/auth/keys/list' }, + { name: 'revoke', link: '/docs/cli/auth/keys/revoke' }, + { name: 'switch', link: '/docs/cli/auth/keys/switch' }, + { name: 'update', link: '/docs/cli/auth/keys/update' }, + ], + }, + { name: 'revoke-token', link: '/docs/cli/auth/revoke-token' }, + ], + }, + { + name: 'Bench', + pages: [ + { name: 'overview', link: '/docs/cli/bench', index: true }, + { name: 'publisher', link: '/docs/cli/bench/publisher' }, + { name: 'subscriber', link: '/docs/cli/bench/subscriber' }, + ], + }, + { + name: 'Channels', + pages: [ + { name: 'overview', link: '/docs/cli/channels', index: true }, + { + name: 'annotations', + pages: [ + { name: 'overview', link: '/docs/cli/channels/annotations', index: true }, + { name: 'delete', link: '/docs/cli/channels/annotations/delete' }, + { name: 'get', link: '/docs/cli/channels/annotations/get' }, + { name: 'publish', link: '/docs/cli/channels/annotations/publish' }, + { name: 'subscribe', link: '/docs/cli/channels/annotations/subscribe' }, + ], + }, + { name: 'append', link: '/docs/cli/channels/append' }, + { name: 'batch-publish', link: '/docs/cli/channels/batch-publish' }, + { name: 'delete', link: '/docs/cli/channels/delete' }, + { name: 'history', link: '/docs/cli/channels/history' }, + { name: 'inspect', link: '/docs/cli/channels/inspect' }, + { name: 'list', link: '/docs/cli/channels/list' }, + { + name: 'occupancy', + pages: [ + { name: 'overview', link: '/docs/cli/channels/occupancy', index: true }, + { name: 'get', link: '/docs/cli/channels/occupancy/get' }, + { name: 'subscribe', link: '/docs/cli/channels/occupancy/subscribe' }, + ], + }, + { + name: 'presence', + pages: [ + { name: 'overview', link: '/docs/cli/channels/presence', index: true }, + { name: 'enter', link: '/docs/cli/channels/presence/enter' }, + { name: 'get', link: '/docs/cli/channels/presence/get' }, + { name: 'subscribe', link: '/docs/cli/channels/presence/subscribe' }, + ], + }, + { name: 'publish', link: '/docs/cli/channels/publish' }, + { name: 'subscribe', link: '/docs/cli/channels/subscribe' }, + { name: 'update', link: '/docs/cli/channels/update' }, + ], + }, + { + name: 'Config', + pages: [ + { name: 'overview', link: '/docs/cli/config', index: true }, + { name: 'path', link: '/docs/cli/config/path' }, + { name: 'show', link: '/docs/cli/config/show' }, + ], + }, + { + name: 'Connections', + pages: [ + { name: 'overview', link: '/docs/cli/connections', index: true }, + { name: 'test', link: '/docs/cli/connections/test' }, + ], + }, + { + name: 'Integrations', + pages: [ + { name: 'overview', link: '/docs/cli/integrations', index: true }, + { name: 'create', link: '/docs/cli/integrations/create' }, + { name: 'delete', link: '/docs/cli/integrations/delete' }, + { name: 'get', link: '/docs/cli/integrations/get' }, + { name: 'list', link: '/docs/cli/integrations/list' }, + { name: 'update', link: '/docs/cli/integrations/update' }, + ], + }, + { + name: 'Logs', + pages: [ + { name: 'overview', link: '/docs/cli/logs', index: true }, + { + name: 'channel-lifecycle', + pages: [ + { name: 'overview', link: '/docs/cli/logs/channel-lifecycle', index: true }, + { name: 'subscribe', link: '/docs/cli/logs/channel-lifecycle/subscribe' }, + ], + }, + { + name: 'connection-lifecycle', + pages: [ + { name: 'overview', link: '/docs/cli/logs/connection-lifecycle', index: true }, + { name: 'history', link: '/docs/cli/logs/connection-lifecycle/history' }, + { name: 'subscribe', link: '/docs/cli/logs/connection-lifecycle/subscribe' }, + ], + }, + { name: 'history', link: '/docs/cli/logs/history' }, + { + name: 'push', + pages: [ + { name: 'overview', link: '/docs/cli/logs/push', index: true }, + { name: 'history', link: '/docs/cli/logs/push/history' }, + { name: 'subscribe', link: '/docs/cli/logs/push/subscribe' }, + ], + }, + { name: 'subscribe', link: '/docs/cli/logs/subscribe' }, + ], + }, + { + name: 'Push', + pages: [ + { name: 'overview', link: '/docs/cli/push', index: true }, + { name: 'batch-publish', link: '/docs/cli/push/batch-publish' }, + { + name: 'channels', + pages: [ + { name: 'overview', link: '/docs/cli/push/channels', index: true }, + { name: 'list', link: '/docs/cli/push/channels/list' }, + { name: 'list-channels', link: '/docs/cli/push/channels/list-channels' }, + { name: 'remove', link: '/docs/cli/push/channels/remove' }, + { name: 'remove-where', link: '/docs/cli/push/channels/remove-where' }, + { name: 'save', link: '/docs/cli/push/channels/save' }, + ], + }, + { + name: 'config', + pages: [ + { name: 'overview', link: '/docs/cli/push/config', index: true }, + { name: 'clear-apns', link: '/docs/cli/push/config/clear-apns' }, + { name: 'clear-fcm', link: '/docs/cli/push/config/clear-fcm' }, + { name: 'set-apns', link: '/docs/cli/push/config/set-apns' }, + { name: 'set-fcm', link: '/docs/cli/push/config/set-fcm' }, + { name: 'show', link: '/docs/cli/push/config/show' }, + ], + }, + { + name: 'devices', + pages: [ + { name: 'overview', link: '/docs/cli/push/devices', index: true }, + { name: 'get', link: '/docs/cli/push/devices/get' }, + { name: 'list', link: '/docs/cli/push/devices/list' }, + { name: 'remove', link: '/docs/cli/push/devices/remove' }, + { name: 'remove-where', link: '/docs/cli/push/devices/remove-where' }, + { name: 'save', link: '/docs/cli/push/devices/save' }, + ], + }, + { name: 'publish', link: '/docs/cli/push/publish' }, + ], + }, + { + name: 'Queues', + pages: [ + { name: 'overview', link: '/docs/cli/queues', index: true }, + { name: 'create', link: '/docs/cli/queues/create' }, + { name: 'delete', link: '/docs/cli/queues/delete' }, + { name: 'list', link: '/docs/cli/queues/list' }, + ], + }, + { + name: 'Rooms', + pages: [ + { name: 'overview', link: '/docs/cli/rooms', index: true }, + { name: 'list', link: '/docs/cli/rooms/list' }, + { + name: 'messages', + pages: [ + { name: 'overview', link: '/docs/cli/rooms/messages', index: true }, + { name: 'delete', link: '/docs/cli/rooms/messages/delete' }, + { name: 'history', link: '/docs/cli/rooms/messages/history' }, + { + name: 'reactions', + pages: [ + { name: 'overview', link: '/docs/cli/rooms/messages/reactions', index: true }, + { name: 'remove', link: '/docs/cli/rooms/messages/reactions/remove' }, + { name: 'send', link: '/docs/cli/rooms/messages/reactions/send' }, + { name: 'subscribe', link: '/docs/cli/rooms/messages/reactions/subscribe' }, + ], + }, + { name: 'send', link: '/docs/cli/rooms/messages/send' }, + { name: 'subscribe', link: '/docs/cli/rooms/messages/subscribe' }, + { name: 'update', link: '/docs/cli/rooms/messages/update' }, + ], + }, + { + name: 'occupancy', + pages: [ + { name: 'overview', link: '/docs/cli/rooms/occupancy', index: true }, + { name: 'get', link: '/docs/cli/rooms/occupancy/get' }, + { name: 'subscribe', link: '/docs/cli/rooms/occupancy/subscribe' }, + ], + }, + { + name: 'presence', + pages: [ + { name: 'overview', link: '/docs/cli/rooms/presence', index: true }, + { name: 'enter', link: '/docs/cli/rooms/presence/enter' }, + { name: 'get', link: '/docs/cli/rooms/presence/get' }, + { name: 'subscribe', link: '/docs/cli/rooms/presence/subscribe' }, + ], + }, + { + name: 'reactions', + pages: [ + { name: 'overview', link: '/docs/cli/rooms/reactions', index: true }, + { name: 'send', link: '/docs/cli/rooms/reactions/send' }, + { name: 'subscribe', link: '/docs/cli/rooms/reactions/subscribe' }, + ], + }, + { + name: 'typing', + pages: [ + { name: 'overview', link: '/docs/cli/rooms/typing', index: true }, + { name: 'keystroke', link: '/docs/cli/rooms/typing/keystroke' }, + { name: 'subscribe', link: '/docs/cli/rooms/typing/subscribe' }, + ], + }, + ], + }, + { + name: 'Spaces', + pages: [ + { name: 'overview', link: '/docs/cli/spaces', index: true }, + { name: 'create', link: '/docs/cli/spaces/create' }, + { + name: 'cursors', + pages: [ + { name: 'overview', link: '/docs/cli/spaces/cursors', index: true }, + { name: 'get', link: '/docs/cli/spaces/cursors/get' }, + { name: 'set', link: '/docs/cli/spaces/cursors/set' }, + { name: 'subscribe', link: '/docs/cli/spaces/cursors/subscribe' }, + ], + }, + { name: 'get', link: '/docs/cli/spaces/get' }, + { name: 'list', link: '/docs/cli/spaces/list' }, + { + name: 'locations', + pages: [ + { name: 'overview', link: '/docs/cli/spaces/locations', index: true }, + { name: 'get', link: '/docs/cli/spaces/locations/get' }, + { name: 'set', link: '/docs/cli/spaces/locations/set' }, + { name: 'subscribe', link: '/docs/cli/spaces/locations/subscribe' }, + ], + }, + { + name: 'locks', + pages: [ + { name: 'overview', link: '/docs/cli/spaces/locks', index: true }, + { name: 'acquire', link: '/docs/cli/spaces/locks/acquire' }, + { name: 'get', link: '/docs/cli/spaces/locks/get' }, + { name: 'subscribe', link: '/docs/cli/spaces/locks/subscribe' }, + ], + }, + { + name: 'members', + pages: [ + { name: 'overview', link: '/docs/cli/spaces/members', index: true }, + { name: 'enter', link: '/docs/cli/spaces/members/enter' }, + { name: 'get', link: '/docs/cli/spaces/members/get' }, + { name: 'subscribe', link: '/docs/cli/spaces/members/subscribe' }, + ], + }, + { + name: 'occupancy', + pages: [ + { name: 'overview', link: '/docs/cli/spaces/occupancy', index: true }, + { name: 'get', link: '/docs/cli/spaces/occupancy/get' }, + { name: 'subscribe', link: '/docs/cli/spaces/occupancy/subscribe' }, + ], + }, + { name: 'subscribe', link: '/docs/cli/spaces/subscribe' }, + ], + }, + { + name: 'Stats', + pages: [ + { name: 'overview', link: '/docs/cli/stats', index: true }, + { name: 'account', link: '/docs/cli/stats/account' }, + { name: 'app', link: '/docs/cli/stats/app' }, + ], + }, + { + name: 'Support', + pages: [ + { name: 'overview', link: '/docs/cli/support', index: true }, + { name: 'ask', link: '/docs/cli/support/ask' }, + { name: 'contact', link: '/docs/cli/support/contact' }, + ], + }, + { name: 'Autocomplete', link: '/docs/cli/autocomplete' }, + { name: 'Status', link: '/docs/cli/status' }, + { name: 'Version', link: '/docs/cli/version' }, + { name: 'Help', link: '/docs/cli/help' }, + ], }, ], }, diff --git a/src/pages/docs/cli/accounts/current.mdx b/src/pages/docs/cli/accounts/current.mdx index bcda95c456..f3217c61cd 100644 --- a/src/pages/docs/cli/accounts/current.mdx +++ b/src/pages/docs/cli/accounts/current.mdx @@ -1,5 +1,5 @@ --- -title: "ably accounts current" +title: "Accounts current" meta_description: "Show the current Ably account using the CLI." meta_keywords: "ably cli, cli, accounts, current account, ably accounts current" --- diff --git a/src/pages/docs/cli/accounts/index.mdx b/src/pages/docs/cli/accounts/index.mdx index 4eadec1686..e3496a1095 100644 --- a/src/pages/docs/cli/accounts/index.mdx +++ b/src/pages/docs/cli/accounts/index.mdx @@ -1,5 +1,5 @@ --- -title: "ably accounts" +title: "Accounts" meta_description: "Manage Ably accounts and configured access tokens using the CLI." meta_keywords: "ably cli, cli, accounts, authentication, account management, ably accounts" --- diff --git a/src/pages/docs/cli/accounts/list.mdx b/src/pages/docs/cli/accounts/list.mdx index af70aabfb1..83a45979a6 100644 --- a/src/pages/docs/cli/accounts/list.mdx +++ b/src/pages/docs/cli/accounts/list.mdx @@ -1,5 +1,5 @@ --- -title: "ably accounts list" +title: "Accounts list" meta_description: "List all locally configured Ably accounts using the CLI." meta_keywords: "ably cli, cli, accounts, list accounts, ably accounts list" --- diff --git a/src/pages/docs/cli/accounts/login.mdx b/src/pages/docs/cli/accounts/login.mdx index 65007fd8b1..54b784d633 100644 --- a/src/pages/docs/cli/accounts/login.mdx +++ b/src/pages/docs/cli/accounts/login.mdx @@ -1,5 +1,5 @@ --- -title: "ably accounts login" +title: "Accounts login" meta_description: "Log in to your Ably account using the CLI." meta_keywords: "ably cli, cli, accounts, login, authentication, ably accounts login" --- diff --git a/src/pages/docs/cli/accounts/logout.mdx b/src/pages/docs/cli/accounts/logout.mdx index 7587b3afad..3f33164d09 100644 --- a/src/pages/docs/cli/accounts/logout.mdx +++ b/src/pages/docs/cli/accounts/logout.mdx @@ -1,5 +1,5 @@ --- -title: "ably accounts logout" +title: "Accounts logout" meta_description: "Log out from an Ably account using the CLI." meta_keywords: "ably cli, cli, accounts, logout, authentication, ably accounts logout" --- diff --git a/src/pages/docs/cli/accounts/switch.mdx b/src/pages/docs/cli/accounts/switch.mdx index 9b25d7c061..9bbe383fc4 100644 --- a/src/pages/docs/cli/accounts/switch.mdx +++ b/src/pages/docs/cli/accounts/switch.mdx @@ -1,5 +1,5 @@ --- -title: "ably accounts switch" +title: "Accounts switch" meta_description: "Switch to a different Ably account using the CLI." meta_keywords: "ably cli, cli, accounts, switch account, ably accounts switch" --- diff --git a/src/pages/docs/cli/apps/create.mdx b/src/pages/docs/cli/apps/create.mdx index d117711c4e..db8137ad14 100644 --- a/src/pages/docs/cli/apps/create.mdx +++ b/src/pages/docs/cli/apps/create.mdx @@ -1,5 +1,5 @@ --- -title: "ably apps create" +title: "Apps create" meta_description: "Create a new Ably application using the CLI." meta_keywords: "ably cli, cli, apps, create, new application, ably apps create" --- diff --git a/src/pages/docs/cli/apps/current.mdx b/src/pages/docs/cli/apps/current.mdx index e3fd8713dd..4f59d825fc 100644 --- a/src/pages/docs/cli/apps/current.mdx +++ b/src/pages/docs/cli/apps/current.mdx @@ -1,5 +1,5 @@ --- -title: "ably apps current" +title: "Apps current" meta_description: "Show the currently selected Ably application using the CLI." meta_keywords: "ably cli, cli, apps, current, selected app, ably apps current" --- diff --git a/src/pages/docs/cli/apps/delete.mdx b/src/pages/docs/cli/apps/delete.mdx index e06f63ca1c..2e7b6b7e3b 100644 --- a/src/pages/docs/cli/apps/delete.mdx +++ b/src/pages/docs/cli/apps/delete.mdx @@ -1,5 +1,5 @@ --- -title: "ably apps delete" +title: "Apps delete" meta_description: "Permanently delete an Ably application using the CLI." meta_keywords: "ably cli, cli, apps, delete, remove application, ably apps delete" --- diff --git a/src/pages/docs/cli/apps/index.mdx b/src/pages/docs/cli/apps/index.mdx index 6f32a5f47d..fb204ff937 100644 --- a/src/pages/docs/cli/apps/index.mdx +++ b/src/pages/docs/cli/apps/index.mdx @@ -1,5 +1,5 @@ --- -title: "ably apps" +title: "Apps" meta_description: "Manage your Ably applications using the CLI." meta_keywords: "ably cli, cli, apps, applications, app management, ably apps" --- diff --git a/src/pages/docs/cli/apps/list.mdx b/src/pages/docs/cli/apps/list.mdx index b93058435c..6be761b709 100644 --- a/src/pages/docs/cli/apps/list.mdx +++ b/src/pages/docs/cli/apps/list.mdx @@ -1,5 +1,5 @@ --- -title: "ably apps list" +title: "Apps list" meta_description: "List all Ably applications in the current account using the CLI." meta_keywords: "ably cli, cli, apps, list, applications, ably apps list" --- diff --git a/src/pages/docs/cli/apps/rules/create.mdx b/src/pages/docs/cli/apps/rules/create.mdx index f8b1b42b0e..efad603d10 100644 --- a/src/pages/docs/cli/apps/rules/create.mdx +++ b/src/pages/docs/cli/apps/rules/create.mdx @@ -1,5 +1,5 @@ --- -title: "ably apps rules create" +title: "Apps rules create" meta_description: "Create a channel rule for an Ably application using the CLI." meta_keywords: "ably cli, cli, apps, rules, create, channel rule, namespace, ably apps rules create" --- diff --git a/src/pages/docs/cli/apps/rules/delete.mdx b/src/pages/docs/cli/apps/rules/delete.mdx index 567ff619b6..0ab9e7e7f5 100644 --- a/src/pages/docs/cli/apps/rules/delete.mdx +++ b/src/pages/docs/cli/apps/rules/delete.mdx @@ -1,5 +1,5 @@ --- -title: "ably apps rules delete" +title: "Apps rules delete" meta_description: "Delete a channel rule from an Ably application using the CLI." meta_keywords: "ably cli, cli, apps, rules, delete, remove, channel rule, ably apps rules delete" --- diff --git a/src/pages/docs/cli/apps/rules/index.mdx b/src/pages/docs/cli/apps/rules/index.mdx index cc2b9656d4..bad7f47016 100644 --- a/src/pages/docs/cli/apps/rules/index.mdx +++ b/src/pages/docs/cli/apps/rules/index.mdx @@ -1,5 +1,5 @@ --- -title: "ably apps rules" +title: "Apps rules" meta_description: "Manage channel rules for Ably applications using the CLI." meta_keywords: "ably cli, cli, apps, rules, namespaces, channel rules, ably apps rules" --- diff --git a/src/pages/docs/cli/apps/rules/list.mdx b/src/pages/docs/cli/apps/rules/list.mdx index f495f82327..9e551634d6 100644 --- a/src/pages/docs/cli/apps/rules/list.mdx +++ b/src/pages/docs/cli/apps/rules/list.mdx @@ -1,5 +1,5 @@ --- -title: "ably apps rules list" +title: "Apps rules list" meta_description: "List channel rules for an Ably application using the CLI." meta_keywords: "ably cli, cli, apps, rules, list, channel rules, namespaces, ably apps rules list" --- diff --git a/src/pages/docs/cli/apps/rules/update.mdx b/src/pages/docs/cli/apps/rules/update.mdx index 003377fa67..31bfbd73e6 100644 --- a/src/pages/docs/cli/apps/rules/update.mdx +++ b/src/pages/docs/cli/apps/rules/update.mdx @@ -1,5 +1,5 @@ --- -title: "ably apps rules update" +title: "Apps rules update" meta_description: "Update a channel rule for an Ably application using the CLI." meta_keywords: "ably cli, cli, apps, rules, update, modify, channel rule, ably apps rules update" --- diff --git a/src/pages/docs/cli/apps/switch.mdx b/src/pages/docs/cli/apps/switch.mdx index c4d59a4b72..28e5e7f1b5 100644 --- a/src/pages/docs/cli/apps/switch.mdx +++ b/src/pages/docs/cli/apps/switch.mdx @@ -1,5 +1,5 @@ --- -title: "ably apps switch" +title: "Apps switch" meta_description: "Switch to a different Ably application using the CLI." meta_keywords: "ably cli, cli, apps, switch, change app, ably apps switch" --- diff --git a/src/pages/docs/cli/apps/update.mdx b/src/pages/docs/cli/apps/update.mdx index 6250f94bbe..2f23cd11b1 100644 --- a/src/pages/docs/cli/apps/update.mdx +++ b/src/pages/docs/cli/apps/update.mdx @@ -1,5 +1,5 @@ --- -title: "ably apps update" +title: "Apps update" meta_description: "Update an Ably application's configuration using the CLI." meta_keywords: "ably cli, cli, apps, update, modify application, ably apps update" --- diff --git a/src/pages/docs/cli/auth/index.mdx b/src/pages/docs/cli/auth/index.mdx index f1e7bdcca2..f1a0f5cf58 100644 --- a/src/pages/docs/cli/auth/index.mdx +++ b/src/pages/docs/cli/auth/index.mdx @@ -1,5 +1,5 @@ --- -title: "ably auth" +title: "Auth" meta_description: "Manage authentication, API keys, and tokens using the CLI." meta_keywords: "ably cli, cli, auth, authentication, api keys, tokens, ably auth" --- diff --git a/src/pages/docs/cli/auth/issue-ably-token.mdx b/src/pages/docs/cli/auth/issue-ably-token.mdx index ebe727c62c..b06246a951 100644 --- a/src/pages/docs/cli/auth/issue-ably-token.mdx +++ b/src/pages/docs/cli/auth/issue-ably-token.mdx @@ -1,5 +1,5 @@ --- -title: "ably auth issue-ably-token" +title: "Auth issue-ably-token" meta_description: "Create an Ably Token with specified capabilities using the CLI." meta_keywords: "ably cli, cli, auth, token, issue token, ably token, ably auth issue-ably-token" --- diff --git a/src/pages/docs/cli/auth/issue-jwt-token.mdx b/src/pages/docs/cli/auth/issue-jwt-token.mdx index d6db76b1ed..061f2d01d0 100644 --- a/src/pages/docs/cli/auth/issue-jwt-token.mdx +++ b/src/pages/docs/cli/auth/issue-jwt-token.mdx @@ -1,5 +1,5 @@ --- -title: "ably auth issue-jwt-token" +title: "Auth issue-jwt-token" meta_description: "Create an Ably JWT token with specified capabilities using the CLI." meta_keywords: "ably cli, cli, auth, jwt, jwt token, issue jwt token, ably auth issue-jwt-token" --- diff --git a/src/pages/docs/cli/auth/keys/create.mdx b/src/pages/docs/cli/auth/keys/create.mdx index 9b0b7d6ac4..1e9515c9a3 100644 --- a/src/pages/docs/cli/auth/keys/create.mdx +++ b/src/pages/docs/cli/auth/keys/create.mdx @@ -1,5 +1,5 @@ --- -title: "ably auth keys create" +title: "Auth keys create" meta_description: "Create a new API key for an Ably app using the CLI." meta_keywords: "ably cli, cli, auth, keys, create key, api key, ably auth keys create" --- diff --git a/src/pages/docs/cli/auth/keys/current.mdx b/src/pages/docs/cli/auth/keys/current.mdx index 9765818b87..6137eb25d0 100644 --- a/src/pages/docs/cli/auth/keys/current.mdx +++ b/src/pages/docs/cli/auth/keys/current.mdx @@ -1,5 +1,5 @@ --- -title: "ably auth keys current" +title: "Auth keys current" meta_description: "Show the current API key for the selected Ably app using the CLI." meta_keywords: "ably cli, cli, auth, keys, current key, api key, ably auth keys current" --- diff --git a/src/pages/docs/cli/auth/keys/get.mdx b/src/pages/docs/cli/auth/keys/get.mdx index caf9b5ce5b..77595bae8a 100644 --- a/src/pages/docs/cli/auth/keys/get.mdx +++ b/src/pages/docs/cli/auth/keys/get.mdx @@ -1,5 +1,5 @@ --- -title: "ably auth keys get" +title: "Auth keys get" meta_description: "Get details for a specific API key using the CLI." meta_keywords: "ably cli, cli, auth, keys, get key, api key details, ably auth keys get" --- diff --git a/src/pages/docs/cli/auth/keys/index.mdx b/src/pages/docs/cli/auth/keys/index.mdx index f38b67abba..c2d1ad77ee 100644 --- a/src/pages/docs/cli/auth/keys/index.mdx +++ b/src/pages/docs/cli/auth/keys/index.mdx @@ -1,5 +1,5 @@ --- -title: "ably auth keys" +title: "Auth keys" meta_description: "Manage API keys for Ably apps using the CLI." meta_keywords: "ably cli, cli, auth, keys, api keys, key management, ably auth keys" --- diff --git a/src/pages/docs/cli/auth/keys/list.mdx b/src/pages/docs/cli/auth/keys/list.mdx index f5a304727d..b898caa803 100644 --- a/src/pages/docs/cli/auth/keys/list.mdx +++ b/src/pages/docs/cli/auth/keys/list.mdx @@ -1,5 +1,5 @@ --- -title: "ably auth keys list" +title: "Auth keys list" meta_description: "List all API keys for an Ably app using the CLI." meta_keywords: "ably cli, cli, auth, keys, list keys, api keys, ably auth keys list" --- diff --git a/src/pages/docs/cli/auth/keys/revoke.mdx b/src/pages/docs/cli/auth/keys/revoke.mdx index c2377748e0..0077474f62 100644 --- a/src/pages/docs/cli/auth/keys/revoke.mdx +++ b/src/pages/docs/cli/auth/keys/revoke.mdx @@ -1,5 +1,5 @@ --- -title: "ably auth keys revoke" +title: "Auth keys revoke" meta_description: "Permanently revoke an API key using the CLI." meta_keywords: "ably cli, cli, auth, keys, revoke key, api key revocation, ably auth keys revoke" --- diff --git a/src/pages/docs/cli/auth/keys/switch.mdx b/src/pages/docs/cli/auth/keys/switch.mdx index 36019ebb60..8e7c0bffcd 100644 --- a/src/pages/docs/cli/auth/keys/switch.mdx +++ b/src/pages/docs/cli/auth/keys/switch.mdx @@ -1,5 +1,5 @@ --- -title: "ably auth keys switch" +title: "Auth keys switch" meta_description: "Switch to a different API key for the current Ably app using the CLI." meta_keywords: "ably cli, cli, auth, keys, switch key, api key, ably auth keys switch" --- diff --git a/src/pages/docs/cli/auth/keys/update.mdx b/src/pages/docs/cli/auth/keys/update.mdx index 266bb51d22..598261c489 100644 --- a/src/pages/docs/cli/auth/keys/update.mdx +++ b/src/pages/docs/cli/auth/keys/update.mdx @@ -1,5 +1,5 @@ --- -title: "ably auth keys update" +title: "Auth keys update" meta_description: "Update an API key's properties using the CLI." meta_keywords: "ably cli, cli, auth, keys, update key, api key, ably auth keys update" --- diff --git a/src/pages/docs/cli/auth/revoke-token.mdx b/src/pages/docs/cli/auth/revoke-token.mdx index 45ee0d386c..94480973a7 100644 --- a/src/pages/docs/cli/auth/revoke-token.mdx +++ b/src/pages/docs/cli/auth/revoke-token.mdx @@ -1,5 +1,5 @@ --- -title: "ably auth revoke-token" +title: "Auth revoke-token" meta_description: "Revoke an Ably token using the CLI." meta_keywords: "ably cli, cli, auth, revoke token, token revocation, ably auth revoke-token" --- diff --git a/src/pages/docs/cli/autocomplete.mdx b/src/pages/docs/cli/autocomplete.mdx index d0b7dcb6db..d7a8c92ddc 100644 --- a/src/pages/docs/cli/autocomplete.mdx +++ b/src/pages/docs/cli/autocomplete.mdx @@ -1,5 +1,5 @@ --- -title: "ably autocomplete" +title: "Autocomplete" meta_description: "Display autocomplete installation instructions for the Ably CLI." meta_keywords: "ably cli, cli, autocomplete, shell completion, bash, zsh, powershell" --- diff --git a/src/pages/docs/cli/bench/index.mdx b/src/pages/docs/cli/bench/index.mdx index 73407927cb..77b5aa974a 100644 --- a/src/pages/docs/cli/bench/index.mdx +++ b/src/pages/docs/cli/bench/index.mdx @@ -1,5 +1,5 @@ --- -title: "ably bench" +title: "Bench" meta_description: "Performance benchmarking commands." meta_keywords: "ably cli, cli, bench, benchmark, performance, ably bench" --- diff --git a/src/pages/docs/cli/bench/publisher.mdx b/src/pages/docs/cli/bench/publisher.mdx index 2dc65ca164..4f9b90c7bd 100644 --- a/src/pages/docs/cli/bench/publisher.mdx +++ b/src/pages/docs/cli/bench/publisher.mdx @@ -1,5 +1,5 @@ --- -title: "ably bench publisher" +title: "Bench publisher" meta_description: "Run a publisher benchmark test using the Ably CLI." meta_keywords: "ably cli, cli, bench, publisher, benchmark, performance, ably bench publisher" --- diff --git a/src/pages/docs/cli/bench/subscriber.mdx b/src/pages/docs/cli/bench/subscriber.mdx index c2cd245a10..0180fe951c 100644 --- a/src/pages/docs/cli/bench/subscriber.mdx +++ b/src/pages/docs/cli/bench/subscriber.mdx @@ -1,5 +1,5 @@ --- -title: "ably bench subscriber" +title: "Bench subscriber" meta_description: "Run a subscriber benchmark test using the Ably CLI." meta_keywords: "ably cli, cli, bench, subscriber, benchmark, performance, ably bench subscriber" --- diff --git a/src/pages/docs/cli/channels/annotations/delete.mdx b/src/pages/docs/cli/channels/annotations/delete.mdx index b10ebe1d2c..3c18990b2f 100644 --- a/src/pages/docs/cli/channels/annotations/delete.mdx +++ b/src/pages/docs/cli/channels/annotations/delete.mdx @@ -1,5 +1,5 @@ --- -title: "ably channels annotations delete" +title: "Channels annotations delete" meta_description: "Delete an annotation from an Ably Pub/Sub channel message using the CLI." meta_keywords: "ably cli, cli, channels, annotations, delete, reactions, ably channels annotations delete" --- diff --git a/src/pages/docs/cli/channels/annotations/get.mdx b/src/pages/docs/cli/channels/annotations/get.mdx index 7a09032706..27e17320e1 100644 --- a/src/pages/docs/cli/channels/annotations/get.mdx +++ b/src/pages/docs/cli/channels/annotations/get.mdx @@ -1,5 +1,5 @@ --- -title: "ably channels annotations get" +title: "Channels annotations get" meta_description: "Get annotations for an Ably Pub/Sub channel message using the CLI." meta_keywords: "ably cli, cli, channels, annotations, get, reactions, ably channels annotations get" --- diff --git a/src/pages/docs/cli/channels/annotations/index.mdx b/src/pages/docs/cli/channels/annotations/index.mdx index c052db3725..4b0341cf43 100644 --- a/src/pages/docs/cli/channels/annotations/index.mdx +++ b/src/pages/docs/cli/channels/annotations/index.mdx @@ -1,5 +1,5 @@ --- -title: "ably channels annotations" +title: "Channels annotations" meta_description: "Manage annotations on Ably Pub/Sub channel messages using the CLI." meta_keywords: "ably cli, cli, channels, annotations, reactions, metrics, ably channels annotations" --- diff --git a/src/pages/docs/cli/channels/annotations/publish.mdx b/src/pages/docs/cli/channels/annotations/publish.mdx index 1e04b14698..d88af16115 100644 --- a/src/pages/docs/cli/channels/annotations/publish.mdx +++ b/src/pages/docs/cli/channels/annotations/publish.mdx @@ -1,5 +1,5 @@ --- -title: "ably channels annotations publish" +title: "Channels annotations publish" meta_description: "Publish an annotation on an Ably Pub/Sub channel message using the CLI." meta_keywords: "ably cli, cli, channels, annotations, publish, reactions, ably channels annotations publish" --- diff --git a/src/pages/docs/cli/channels/annotations/subscribe.mdx b/src/pages/docs/cli/channels/annotations/subscribe.mdx index 1cebca46f2..f9ff69de4a 100644 --- a/src/pages/docs/cli/channels/annotations/subscribe.mdx +++ b/src/pages/docs/cli/channels/annotations/subscribe.mdx @@ -1,5 +1,5 @@ --- -title: "ably channels annotations subscribe" +title: "Channels annotations subscribe" meta_description: "Subscribe to annotations on an Ably Pub/Sub channel using the CLI." meta_keywords: "ably cli, cli, channels, annotations, subscribe, reactions, ably channels annotations subscribe" --- diff --git a/src/pages/docs/cli/channels/append.mdx b/src/pages/docs/cli/channels/append.mdx index d43f722314..6d2778cfce 100644 --- a/src/pages/docs/cli/channels/append.mdx +++ b/src/pages/docs/cli/channels/append.mdx @@ -1,5 +1,5 @@ --- -title: "ably channels append" +title: "Channels append" meta_description: "Append data to a message on an Ably Pub/Sub channel using the CLI." meta_keywords: "ably cli, cli, channels, append, message, pub/sub, ably channels append" --- diff --git a/src/pages/docs/cli/channels/batch-publish.mdx b/src/pages/docs/cli/channels/batch-publish.mdx index eb3a42d2b6..48e9ed4600 100644 --- a/src/pages/docs/cli/channels/batch-publish.mdx +++ b/src/pages/docs/cli/channels/batch-publish.mdx @@ -1,5 +1,5 @@ --- -title: "ably channels batch-publish" +title: "Channels batch-publish" meta_description: "Publish a message to multiple Ably Pub/Sub channels at once using the CLI." meta_keywords: "ably cli, cli, channels, batch-publish, batch, publish, pub/sub, ably channels batch-publish" --- diff --git a/src/pages/docs/cli/channels/delete.mdx b/src/pages/docs/cli/channels/delete.mdx index 6921557788..6cf18bf566 100644 --- a/src/pages/docs/cli/channels/delete.mdx +++ b/src/pages/docs/cli/channels/delete.mdx @@ -1,5 +1,5 @@ --- -title: "ably channels delete" +title: "Channels delete" meta_description: "Delete a message on an Ably Pub/Sub channel using the CLI." meta_keywords: "ably cli, cli, channels, delete, message, pub/sub, ably channels delete" --- diff --git a/src/pages/docs/cli/channels/history.mdx b/src/pages/docs/cli/channels/history.mdx index ae2a330675..0503b421c8 100644 --- a/src/pages/docs/cli/channels/history.mdx +++ b/src/pages/docs/cli/channels/history.mdx @@ -1,5 +1,5 @@ --- -title: "ably channels history" +title: "Channels history" meta_description: "Retrieve message history for an Ably Pub/Sub channel using the CLI." meta_keywords: "ably cli, cli, channels, history, messages, pub/sub, ably channels history" --- diff --git a/src/pages/docs/cli/channels/index.mdx b/src/pages/docs/cli/channels/index.mdx index c6164b28dd..a0c9d6350e 100644 --- a/src/pages/docs/cli/channels/index.mdx +++ b/src/pages/docs/cli/channels/index.mdx @@ -1,5 +1,5 @@ --- -title: "ably channels" +title: "Channels" meta_description: "Interact with Ably Pub/Sub channels using the CLI." meta_keywords: "ably cli, cli, channels, pub/sub, publish, subscribe, presence, occupancy, ably channels" --- diff --git a/src/pages/docs/cli/channels/inspect.mdx b/src/pages/docs/cli/channels/inspect.mdx index ac76645309..ec7d94391b 100644 --- a/src/pages/docs/cli/channels/inspect.mdx +++ b/src/pages/docs/cli/channels/inspect.mdx @@ -1,5 +1,5 @@ --- -title: "ably channels inspect" +title: "Channels inspect" meta_description: "Open the Ably dashboard to inspect a specific channel using the CLI." meta_keywords: "ably cli, cli, channels, inspect, dashboard, pub/sub, ably channels inspect" --- diff --git a/src/pages/docs/cli/channels/list.mdx b/src/pages/docs/cli/channels/list.mdx index 09da4cfdbd..faa7c33237 100644 --- a/src/pages/docs/cli/channels/list.mdx +++ b/src/pages/docs/cli/channels/list.mdx @@ -1,5 +1,5 @@ --- -title: "ably channels list" +title: "Channels list" meta_description: "List active channels using the Ably CLI." meta_keywords: "ably cli, cli, channels, list, active channels, enumeration, ably channels list" --- diff --git a/src/pages/docs/cli/channels/occupancy/get.mdx b/src/pages/docs/cli/channels/occupancy/get.mdx index 96f63e7ac1..d35ef298c4 100644 --- a/src/pages/docs/cli/channels/occupancy/get.mdx +++ b/src/pages/docs/cli/channels/occupancy/get.mdx @@ -1,5 +1,5 @@ --- -title: "ably channels occupancy get" +title: "Channels occupancy get" meta_description: "Get current occupancy for an Ably Pub/Sub channel using the CLI." meta_keywords: "ably cli, cli, channels, occupancy, get, connections, subscribers, ably channels occupancy get" --- diff --git a/src/pages/docs/cli/channels/occupancy/index.mdx b/src/pages/docs/cli/channels/occupancy/index.mdx index a699751e47..cfc717a857 100644 --- a/src/pages/docs/cli/channels/occupancy/index.mdx +++ b/src/pages/docs/cli/channels/occupancy/index.mdx @@ -1,5 +1,5 @@ --- -title: "ably channels occupancy" +title: "Channels occupancy" meta_description: "Monitor channel occupancy using the Ably CLI." meta_keywords: "ably cli, cli, channels, occupancy, connections, subscribers, ably channels occupancy" --- diff --git a/src/pages/docs/cli/channels/occupancy/subscribe.mdx b/src/pages/docs/cli/channels/occupancy/subscribe.mdx index 19c041ceea..e3de2fd983 100644 --- a/src/pages/docs/cli/channels/occupancy/subscribe.mdx +++ b/src/pages/docs/cli/channels/occupancy/subscribe.mdx @@ -1,5 +1,5 @@ --- -title: "ably channels occupancy subscribe" +title: "Channels occupancy subscribe" meta_description: "Subscribe to occupancy updates on an Ably Pub/Sub channel using the CLI." meta_keywords: "ably cli, cli, channels, occupancy, subscribe, connections, subscribers, ably channels occupancy subscribe" --- diff --git a/src/pages/docs/cli/channels/presence/enter.mdx b/src/pages/docs/cli/channels/presence/enter.mdx index bbc8d5d215..d4edc1d3e7 100644 --- a/src/pages/docs/cli/channels/presence/enter.mdx +++ b/src/pages/docs/cli/channels/presence/enter.mdx @@ -1,5 +1,5 @@ --- -title: "ably channels presence enter" +title: "Channels presence enter" meta_description: "Enter presence on an Ably Pub/Sub channel using the CLI." meta_keywords: "ably cli, cli, channels, presence, enter, members, ably channels presence enter" --- diff --git a/src/pages/docs/cli/channels/presence/get.mdx b/src/pages/docs/cli/channels/presence/get.mdx index 67025d15fd..caa15461af 100644 --- a/src/pages/docs/cli/channels/presence/get.mdx +++ b/src/pages/docs/cli/channels/presence/get.mdx @@ -1,5 +1,5 @@ --- -title: "ably channels presence get" +title: "Channels presence get" meta_description: "Get all current presence members on an Ably Pub/Sub channel using the CLI." meta_keywords: "ably cli, cli, channels, presence, get, members, ably channels presence get" --- diff --git a/src/pages/docs/cli/channels/presence/index.mdx b/src/pages/docs/cli/channels/presence/index.mdx index e63c010eca..fe871b0292 100644 --- a/src/pages/docs/cli/channels/presence/index.mdx +++ b/src/pages/docs/cli/channels/presence/index.mdx @@ -1,5 +1,5 @@ --- -title: "ably channels presence" +title: "Channels presence" meta_description: "Manage presence on Ably Pub/Sub channels using the CLI." meta_keywords: "ably cli, cli, channels, presence, members, ably channels presence" --- diff --git a/src/pages/docs/cli/channels/presence/subscribe.mdx b/src/pages/docs/cli/channels/presence/subscribe.mdx index 15dd63ea42..ff6f224c16 100644 --- a/src/pages/docs/cli/channels/presence/subscribe.mdx +++ b/src/pages/docs/cli/channels/presence/subscribe.mdx @@ -1,5 +1,5 @@ --- -title: "ably channels presence subscribe" +title: "Channels presence subscribe" meta_description: "Subscribe to presence events on an Ably Pub/Sub channel using the CLI." meta_keywords: "ably cli, cli, channels, presence, subscribe, events, members, ably channels presence subscribe" --- diff --git a/src/pages/docs/cli/channels/publish.mdx b/src/pages/docs/cli/channels/publish.mdx index b635225e58..716ca45197 100644 --- a/src/pages/docs/cli/channels/publish.mdx +++ b/src/pages/docs/cli/channels/publish.mdx @@ -1,5 +1,5 @@ --- -title: "ably channels publish" +title: "Channels publish" meta_description: "Publish a message to an Ably Pub/Sub channel using the CLI." meta_keywords: "ably cli, cli, channels, publish, message, pub/sub, ably channels publish" --- diff --git a/src/pages/docs/cli/channels/subscribe.mdx b/src/pages/docs/cli/channels/subscribe.mdx index 6d0022333a..44ecb61db3 100644 --- a/src/pages/docs/cli/channels/subscribe.mdx +++ b/src/pages/docs/cli/channels/subscribe.mdx @@ -1,5 +1,5 @@ --- -title: "ably channels subscribe" +title: "Channels subscribe" meta_description: "Subscribe to messages on one or more Ably Pub/Sub channels using the CLI." meta_keywords: "ably cli, cli, channels, subscribe, messages, pub/sub, ably channels subscribe" --- diff --git a/src/pages/docs/cli/channels/update.mdx b/src/pages/docs/cli/channels/update.mdx index 4d1a493338..2bd6513752 100644 --- a/src/pages/docs/cli/channels/update.mdx +++ b/src/pages/docs/cli/channels/update.mdx @@ -1,5 +1,5 @@ --- -title: "ably channels update" +title: "Channels update" meta_description: "Update a message on an Ably Pub/Sub channel using the CLI." meta_keywords: "ably cli, cli, channels, update, message, pub/sub, ably channels update" --- diff --git a/src/pages/docs/cli/config/index.mdx b/src/pages/docs/cli/config/index.mdx index 40dd8dd4dc..f07356a365 100644 --- a/src/pages/docs/cli/config/index.mdx +++ b/src/pages/docs/cli/config/index.mdx @@ -1,5 +1,5 @@ --- -title: "ably config" +title: "Config" meta_description: "Manage Ably CLI configuration." meta_keywords: "ably cli, cli, config, configuration, ably config" --- diff --git a/src/pages/docs/cli/config/path.mdx b/src/pages/docs/cli/config/path.mdx index f315b79687..0594583a20 100644 --- a/src/pages/docs/cli/config/path.mdx +++ b/src/pages/docs/cli/config/path.mdx @@ -1,5 +1,5 @@ --- -title: "ably config path" +title: "Config path" meta_description: "Print the path to the Ably CLI config file." meta_keywords: "ably cli, cli, config, path, configuration file, ably config path" --- diff --git a/src/pages/docs/cli/config/show.mdx b/src/pages/docs/cli/config/show.mdx index cb115b34ef..31108e3fd2 100644 --- a/src/pages/docs/cli/config/show.mdx +++ b/src/pages/docs/cli/config/show.mdx @@ -1,5 +1,5 @@ --- -title: "ably config show" +title: "Config show" meta_description: "Display the contents of the Ably CLI config file." meta_keywords: "ably cli, cli, config, show, configuration, ably config show" --- diff --git a/src/pages/docs/cli/connections/index.mdx b/src/pages/docs/cli/connections/index.mdx index e947e03978..dee2bb92de 100644 --- a/src/pages/docs/cli/connections/index.mdx +++ b/src/pages/docs/cli/connections/index.mdx @@ -1,5 +1,5 @@ --- -title: "ably connections" +title: "Connections" meta_description: "Test connections to Ably." meta_keywords: "ably cli, cli, connections, test, connectivity, ably connections" --- diff --git a/src/pages/docs/cli/connections/test.mdx b/src/pages/docs/cli/connections/test.mdx index bb4fb9a946..290429f86e 100644 --- a/src/pages/docs/cli/connections/test.mdx +++ b/src/pages/docs/cli/connections/test.mdx @@ -1,5 +1,5 @@ --- -title: "ably connections test" +title: "Connections test" meta_description: "Test connection to Ably." meta_keywords: "ably cli, cli, connections, test, connectivity, transport, ably connections test" --- diff --git a/src/pages/docs/cli/help.mdx b/src/pages/docs/cli/help.mdx index feab1b29fc..4b5441b938 100644 --- a/src/pages/docs/cli/help.mdx +++ b/src/pages/docs/cli/help.mdx @@ -1,5 +1,5 @@ --- -title: "ably help" +title: "Help" meta_description: "Display help information for Ably CLI commands." meta_keywords: "ably cli, cli, help, command help, ably help" --- diff --git a/src/pages/docs/cli/integrations/create.mdx b/src/pages/docs/cli/integrations/create.mdx index e2bdb6c80a..e3a62ad370 100644 --- a/src/pages/docs/cli/integrations/create.mdx +++ b/src/pages/docs/cli/integrations/create.mdx @@ -1,5 +1,5 @@ --- -title: "ably integrations create" +title: "Integrations create" meta_description: "Create an integration rule using the Ably CLI." meta_keywords: "ably cli, cli, integrations, create, rule, webhook, ably integrations create" --- diff --git a/src/pages/docs/cli/integrations/delete.mdx b/src/pages/docs/cli/integrations/delete.mdx index 9fea9386bb..7d5320d285 100644 --- a/src/pages/docs/cli/integrations/delete.mdx +++ b/src/pages/docs/cli/integrations/delete.mdx @@ -1,5 +1,5 @@ --- -title: "ably integrations delete" +title: "Integrations delete" meta_description: "Delete an integration rule using the Ably CLI." meta_keywords: "ably cli, cli, integrations, delete, rule, ably integrations delete" --- diff --git a/src/pages/docs/cli/integrations/get.mdx b/src/pages/docs/cli/integrations/get.mdx index 2e4340d106..849b8c9c48 100644 --- a/src/pages/docs/cli/integrations/get.mdx +++ b/src/pages/docs/cli/integrations/get.mdx @@ -1,5 +1,5 @@ --- -title: "ably integrations get" +title: "Integrations get" meta_description: "Get an integration rule by ID using the Ably CLI." meta_keywords: "ably cli, cli, integrations, get, rule, ably integrations get" --- diff --git a/src/pages/docs/cli/integrations/index.mdx b/src/pages/docs/cli/integrations/index.mdx index 3a91515bf4..7451b98161 100644 --- a/src/pages/docs/cli/integrations/index.mdx +++ b/src/pages/docs/cli/integrations/index.mdx @@ -1,5 +1,5 @@ --- -title: "ably integrations" +title: "Integrations" meta_description: "Manage Ably integrations with external services." meta_keywords: "ably cli, cli, integrations, rules, webhooks, ably integrations" --- diff --git a/src/pages/docs/cli/integrations/list.mdx b/src/pages/docs/cli/integrations/list.mdx index eb76b4f87b..cf0662b6e8 100644 --- a/src/pages/docs/cli/integrations/list.mdx +++ b/src/pages/docs/cli/integrations/list.mdx @@ -1,5 +1,5 @@ --- -title: "ably integrations list" +title: "Integrations list" meta_description: "List all integration rules using the Ably CLI." meta_keywords: "ably cli, cli, integrations, list, rules, ably integrations list" --- diff --git a/src/pages/docs/cli/integrations/update.mdx b/src/pages/docs/cli/integrations/update.mdx index 3839fc45a8..20951133d7 100644 --- a/src/pages/docs/cli/integrations/update.mdx +++ b/src/pages/docs/cli/integrations/update.mdx @@ -1,5 +1,5 @@ --- -title: "ably integrations update" +title: "Integrations update" meta_description: "Update an integration rule using the Ably CLI." meta_keywords: "ably cli, cli, integrations, update, rule, ably integrations update" --- diff --git a/src/pages/docs/cli/interactive.mdx b/src/pages/docs/cli/interactive.mdx index badc12b191..35db4c4f3b 100644 --- a/src/pages/docs/cli/interactive.mdx +++ b/src/pages/docs/cli/interactive.mdx @@ -1,5 +1,5 @@ --- -title: "ably interactive" +title: "Interactive" meta_description: "Launch an interactive Ably CLI shell." meta_keywords: "ably cli, cli, interactive, shell, ably interactive" --- diff --git a/src/pages/docs/cli/login.mdx b/src/pages/docs/cli/login.mdx index a94d1bff32..8b66198817 100644 --- a/src/pages/docs/cli/login.mdx +++ b/src/pages/docs/cli/login.mdx @@ -1,5 +1,5 @@ --- -title: "ably login" +title: "Login" meta_description: "Log in to your Ably account using the CLI." meta_keywords: "ably cli, cli, login, authentication, ably login" --- diff --git a/src/pages/docs/cli/logs/channel-lifecycle/index.mdx b/src/pages/docs/cli/logs/channel-lifecycle/index.mdx index aa8fda8dc6..1757c9b737 100644 --- a/src/pages/docs/cli/logs/channel-lifecycle/index.mdx +++ b/src/pages/docs/cli/logs/channel-lifecycle/index.mdx @@ -1,5 +1,5 @@ --- -title: "ably logs channel-lifecycle" +title: "Logs channel-lifecycle" meta_description: "Stream logs from the channel lifecycle meta channel using the Ably CLI." meta_keywords: "ably cli, cli, logs, channel lifecycle, meta channel, ably logs channel-lifecycle" --- diff --git a/src/pages/docs/cli/logs/channel-lifecycle/subscribe.mdx b/src/pages/docs/cli/logs/channel-lifecycle/subscribe.mdx index c7a27b319b..3b205c4ecd 100644 --- a/src/pages/docs/cli/logs/channel-lifecycle/subscribe.mdx +++ b/src/pages/docs/cli/logs/channel-lifecycle/subscribe.mdx @@ -1,5 +1,5 @@ --- -title: "ably logs channel-lifecycle subscribe" +title: "Logs channel-lifecycle subscribe" meta_description: "Stream logs from the channel lifecycle meta channel using the Ably CLI." meta_keywords: "ably cli, cli, logs, channel lifecycle, subscribe, meta channel, ably logs channel-lifecycle subscribe" --- diff --git a/src/pages/docs/cli/logs/connection-lifecycle/history.mdx b/src/pages/docs/cli/logs/connection-lifecycle/history.mdx index bfd641cca3..7211f7b773 100644 --- a/src/pages/docs/cli/logs/connection-lifecycle/history.mdx +++ b/src/pages/docs/cli/logs/connection-lifecycle/history.mdx @@ -1,5 +1,5 @@ --- -title: "ably logs connection-lifecycle history" +title: "Logs connection-lifecycle history" meta_description: "Retrieve connection lifecycle log history using the Ably CLI." meta_keywords: "ably cli, cli, logs, connection lifecycle, history, ably logs connection-lifecycle history" --- diff --git a/src/pages/docs/cli/logs/connection-lifecycle/index.mdx b/src/pages/docs/cli/logs/connection-lifecycle/index.mdx index ffdea5c62d..d6c258006a 100644 --- a/src/pages/docs/cli/logs/connection-lifecycle/index.mdx +++ b/src/pages/docs/cli/logs/connection-lifecycle/index.mdx @@ -1,5 +1,5 @@ --- -title: "ably logs connection-lifecycle" +title: "Logs connection-lifecycle" meta_description: "Stream and retrieve connection lifecycle logs using the Ably CLI." meta_keywords: "ably cli, cli, logs, connection lifecycle, subscribe, history, ably logs connection-lifecycle" --- diff --git a/src/pages/docs/cli/logs/connection-lifecycle/subscribe.mdx b/src/pages/docs/cli/logs/connection-lifecycle/subscribe.mdx index 9d9a13d461..0c30d589ff 100644 --- a/src/pages/docs/cli/logs/connection-lifecycle/subscribe.mdx +++ b/src/pages/docs/cli/logs/connection-lifecycle/subscribe.mdx @@ -1,5 +1,5 @@ --- -title: "ably logs connection-lifecycle subscribe" +title: "Logs connection-lifecycle subscribe" meta_description: "Subscribe to live connection lifecycle logs using the Ably CLI." meta_keywords: "ably cli, cli, logs, connection lifecycle, subscribe, ably logs connection-lifecycle subscribe" --- diff --git a/src/pages/docs/cli/logs/history.mdx b/src/pages/docs/cli/logs/history.mdx index 0f6d4ae89a..0a47542b82 100644 --- a/src/pages/docs/cli/logs/history.mdx +++ b/src/pages/docs/cli/logs/history.mdx @@ -1,5 +1,5 @@ --- -title: "ably logs history" +title: "Logs history" meta_description: "Retrieve application log history using the Ably CLI." meta_keywords: "ably cli, cli, logs, history, retrieve, ably logs history" --- diff --git a/src/pages/docs/cli/logs/index.mdx b/src/pages/docs/cli/logs/index.mdx index 3dabc58a8f..e4f775040f 100644 --- a/src/pages/docs/cli/logs/index.mdx +++ b/src/pages/docs/cli/logs/index.mdx @@ -1,5 +1,5 @@ --- -title: "ably logs" +title: "Logs" meta_description: "Stream and retrieve logs from Ably using the CLI." meta_keywords: "ably cli, cli, logs, stream, subscribe, history, channel lifecycle, connection lifecycle, push, ably logs" --- diff --git a/src/pages/docs/cli/logs/push/history.mdx b/src/pages/docs/cli/logs/push/history.mdx index 03c5cf9943..d060fae657 100644 --- a/src/pages/docs/cli/logs/push/history.mdx +++ b/src/pages/docs/cli/logs/push/history.mdx @@ -1,5 +1,5 @@ --- -title: "ably logs push history" +title: "Logs push history" meta_description: "Retrieve push notification log history using the Ably CLI." meta_keywords: "ably cli, cli, logs, push, history, notifications, ably logs push history" --- diff --git a/src/pages/docs/cli/logs/push/index.mdx b/src/pages/docs/cli/logs/push/index.mdx index 94b2668abb..5137c23fa5 100644 --- a/src/pages/docs/cli/logs/push/index.mdx +++ b/src/pages/docs/cli/logs/push/index.mdx @@ -1,5 +1,5 @@ --- -title: "ably logs push" +title: "Logs push" meta_description: "Stream and retrieve push notification logs using the Ably CLI." meta_keywords: "ably cli, cli, logs, push, notifications, subscribe, history, ably logs push" --- diff --git a/src/pages/docs/cli/logs/push/subscribe.mdx b/src/pages/docs/cli/logs/push/subscribe.mdx index 52a32e985a..771ad0561d 100644 --- a/src/pages/docs/cli/logs/push/subscribe.mdx +++ b/src/pages/docs/cli/logs/push/subscribe.mdx @@ -1,5 +1,5 @@ --- -title: "ably logs push subscribe" +title: "Logs push subscribe" meta_description: "Stream logs from the push notifications meta channel using the Ably CLI." meta_keywords: "ably cli, cli, logs, push, subscribe, notifications, meta channel, ably logs push subscribe" --- diff --git a/src/pages/docs/cli/logs/subscribe.mdx b/src/pages/docs/cli/logs/subscribe.mdx index 67e6ca01b8..5d7126e6c0 100644 --- a/src/pages/docs/cli/logs/subscribe.mdx +++ b/src/pages/docs/cli/logs/subscribe.mdx @@ -1,5 +1,5 @@ --- -title: "ably logs subscribe" +title: "Logs subscribe" meta_description: "Subscribe to live app logs using the Ably CLI." meta_keywords: "ably cli, cli, logs, subscribe, stream, live, ably logs subscribe" --- diff --git a/src/pages/docs/cli/push/batch-publish.mdx b/src/pages/docs/cli/push/batch-publish.mdx index 22f584408b..68aa77655e 100644 --- a/src/pages/docs/cli/push/batch-publish.mdx +++ b/src/pages/docs/cli/push/batch-publish.mdx @@ -1,5 +1,5 @@ --- -title: "ably push batch-publish" +title: "Push batch-publish" meta_description: "Publish push notifications to multiple recipients in a batch using the Ably CLI." meta_keywords: "ably cli, cli, push, batch-publish, notifications, batch, ably push batch-publish" --- diff --git a/src/pages/docs/cli/push/channels/index.mdx b/src/pages/docs/cli/push/channels/index.mdx index 0a9f031b71..65881c549c 100644 --- a/src/pages/docs/cli/push/channels/index.mdx +++ b/src/pages/docs/cli/push/channels/index.mdx @@ -1,5 +1,5 @@ --- -title: "ably push channels" +title: "Push channels" meta_description: "Manage push notification channel subscriptions using the Ably CLI." meta_keywords: "ably cli, cli, push, channels, subscriptions, ably push channels" --- diff --git a/src/pages/docs/cli/push/channels/list-channels.mdx b/src/pages/docs/cli/push/channels/list-channels.mdx index d3d409c7ce..d9aa2af74e 100644 --- a/src/pages/docs/cli/push/channels/list-channels.mdx +++ b/src/pages/docs/cli/push/channels/list-channels.mdx @@ -1,5 +1,5 @@ --- -title: "ably push channels list-channels" +title: "Push channels list-channels" meta_description: "List channels with push subscriptions using the Ably CLI." meta_keywords: "ably cli, cli, push, channels, list-channels, subscriptions, ably push channels list-channels" --- diff --git a/src/pages/docs/cli/push/channels/list.mdx b/src/pages/docs/cli/push/channels/list.mdx index a7a6bd51a4..41fb63a5b8 100644 --- a/src/pages/docs/cli/push/channels/list.mdx +++ b/src/pages/docs/cli/push/channels/list.mdx @@ -1,5 +1,5 @@ --- -title: "ably push channels list" +title: "Push channels list" meta_description: "List push channel subscriptions using the Ably CLI." meta_keywords: "ably cli, cli, push, channels, list, subscriptions, ably push channels list" --- diff --git a/src/pages/docs/cli/push/channels/remove-where.mdx b/src/pages/docs/cli/push/channels/remove-where.mdx index 5fc9ca795b..525d4ee1ad 100644 --- a/src/pages/docs/cli/push/channels/remove-where.mdx +++ b/src/pages/docs/cli/push/channels/remove-where.mdx @@ -1,5 +1,5 @@ --- -title: "ably push channels remove-where" +title: "Push channels remove-where" meta_description: "Remove push channel subscriptions matching filter criteria using the Ably CLI." meta_keywords: "ably cli, cli, push, channels, remove-where, filter, ably push channels remove-where" --- diff --git a/src/pages/docs/cli/push/channels/remove.mdx b/src/pages/docs/cli/push/channels/remove.mdx index 2610f07692..b95d827139 100644 --- a/src/pages/docs/cli/push/channels/remove.mdx +++ b/src/pages/docs/cli/push/channels/remove.mdx @@ -1,5 +1,5 @@ --- -title: "ably push channels remove" +title: "Push channels remove" meta_description: "Remove a push channel subscription using the Ably CLI." meta_keywords: "ably cli, cli, push, channels, remove, unsubscribe, ably push channels remove" --- diff --git a/src/pages/docs/cli/push/channels/save.mdx b/src/pages/docs/cli/push/channels/save.mdx index 1a679d49ae..fd3ce18ab0 100644 --- a/src/pages/docs/cli/push/channels/save.mdx +++ b/src/pages/docs/cli/push/channels/save.mdx @@ -1,5 +1,5 @@ --- -title: "ably push channels save" +title: "Push channels save" meta_description: "Subscribe a device or client to push notifications on a channel using the Ably CLI." meta_keywords: "ably cli, cli, push, channels, save, subscribe, device, client, ably push channels save" --- diff --git a/src/pages/docs/cli/push/config/clear-apns.mdx b/src/pages/docs/cli/push/config/clear-apns.mdx index 63d6ccc23f..21c3f1b4c2 100644 --- a/src/pages/docs/cli/push/config/clear-apns.mdx +++ b/src/pages/docs/cli/push/config/clear-apns.mdx @@ -1,5 +1,5 @@ --- -title: "ably push config clear-apns" +title: "Push config clear-apns" meta_description: "Clear APNs push notification configuration for an Ably app using the CLI." meta_keywords: "ably cli, cli, push, config, clear-apns, apns, apple, ably push config clear-apns" --- diff --git a/src/pages/docs/cli/push/config/clear-fcm.mdx b/src/pages/docs/cli/push/config/clear-fcm.mdx index 08231f1aef..ddbab10744 100644 --- a/src/pages/docs/cli/push/config/clear-fcm.mdx +++ b/src/pages/docs/cli/push/config/clear-fcm.mdx @@ -1,5 +1,5 @@ --- -title: "ably push config clear-fcm" +title: "Push config clear-fcm" meta_description: "Clear FCM push notification configuration for an Ably app using the CLI." meta_keywords: "ably cli, cli, push, config, clear-fcm, fcm, firebase, ably push config clear-fcm" --- diff --git a/src/pages/docs/cli/push/config/index.mdx b/src/pages/docs/cli/push/config/index.mdx index d8630bef5d..feda2026e7 100644 --- a/src/pages/docs/cli/push/config/index.mdx +++ b/src/pages/docs/cli/push/config/index.mdx @@ -1,5 +1,5 @@ --- -title: "ably push config" +title: "Push config" meta_description: "Manage push notification configuration using the Ably CLI." meta_keywords: "ably cli, cli, push, config, configuration, apns, fcm, ably push config" --- diff --git a/src/pages/docs/cli/push/config/set-apns.mdx b/src/pages/docs/cli/push/config/set-apns.mdx index eb6d620d65..502cdd9778 100644 --- a/src/pages/docs/cli/push/config/set-apns.mdx +++ b/src/pages/docs/cli/push/config/set-apns.mdx @@ -1,5 +1,5 @@ --- -title: "ably push config set-apns" +title: "Push config set-apns" meta_description: "Configure APNs push notifications for an Ably app using the CLI." meta_keywords: "ably cli, cli, push, config, set-apns, apns, apple, ios, ably push config set-apns" --- diff --git a/src/pages/docs/cli/push/config/set-fcm.mdx b/src/pages/docs/cli/push/config/set-fcm.mdx index 8d96567522..c7c025c9a1 100644 --- a/src/pages/docs/cli/push/config/set-fcm.mdx +++ b/src/pages/docs/cli/push/config/set-fcm.mdx @@ -1,5 +1,5 @@ --- -title: "ably push config set-fcm" +title: "Push config set-fcm" meta_description: "Configure FCM push notifications for an Ably app using the CLI." meta_keywords: "ably cli, cli, push, config, set-fcm, fcm, firebase, android, ably push config set-fcm" --- diff --git a/src/pages/docs/cli/push/config/show.mdx b/src/pages/docs/cli/push/config/show.mdx index 413c3605a9..c916099902 100644 --- a/src/pages/docs/cli/push/config/show.mdx +++ b/src/pages/docs/cli/push/config/show.mdx @@ -1,5 +1,5 @@ --- -title: "ably push config show" +title: "Push config show" meta_description: "Show push notification configuration for an Ably app using the CLI." meta_keywords: "ably cli, cli, push, config, show, configuration, ably push config show" --- diff --git a/src/pages/docs/cli/push/devices/get.mdx b/src/pages/docs/cli/push/devices/get.mdx index d579ab8783..30a6bf5d3e 100644 --- a/src/pages/docs/cli/push/devices/get.mdx +++ b/src/pages/docs/cli/push/devices/get.mdx @@ -1,5 +1,5 @@ --- -title: "ably push devices get" +title: "Push devices get" meta_description: "Get details of a push device registration using the Ably CLI." meta_keywords: "ably cli, cli, push, devices, get, registration, details, ably push devices get" --- diff --git a/src/pages/docs/cli/push/devices/index.mdx b/src/pages/docs/cli/push/devices/index.mdx index 8ef7bcf556..712f2ab009 100644 --- a/src/pages/docs/cli/push/devices/index.mdx +++ b/src/pages/docs/cli/push/devices/index.mdx @@ -1,5 +1,5 @@ --- -title: "ably push devices" +title: "Push devices" meta_description: "Manage push notification device registrations using the Ably CLI." meta_keywords: "ably cli, cli, push, devices, registrations, ably push devices" --- diff --git a/src/pages/docs/cli/push/devices/list.mdx b/src/pages/docs/cli/push/devices/list.mdx index d9b43ac7dc..9b1243c5b7 100644 --- a/src/pages/docs/cli/push/devices/list.mdx +++ b/src/pages/docs/cli/push/devices/list.mdx @@ -1,5 +1,5 @@ --- -title: "ably push devices list" +title: "Push devices list" meta_description: "List push device registrations using the Ably CLI." meta_keywords: "ably cli, cli, push, devices, list, registrations, ably push devices list" --- diff --git a/src/pages/docs/cli/push/devices/remove-where.mdx b/src/pages/docs/cli/push/devices/remove-where.mdx index bfda9990aa..0e07ce5567 100644 --- a/src/pages/docs/cli/push/devices/remove-where.mdx +++ b/src/pages/docs/cli/push/devices/remove-where.mdx @@ -1,5 +1,5 @@ --- -title: "ably push devices remove-where" +title: "Push devices remove-where" meta_description: "Remove push device registrations matching filter criteria using the Ably CLI." meta_keywords: "ably cli, cli, push, devices, remove-where, filter, ably push devices remove-where" --- diff --git a/src/pages/docs/cli/push/devices/remove.mdx b/src/pages/docs/cli/push/devices/remove.mdx index ae0d964585..404fb00d41 100644 --- a/src/pages/docs/cli/push/devices/remove.mdx +++ b/src/pages/docs/cli/push/devices/remove.mdx @@ -1,5 +1,5 @@ --- -title: "ably push devices remove" +title: "Push devices remove" meta_description: "Remove a push device registration using the Ably CLI." meta_keywords: "ably cli, cli, push, devices, remove, unregister, ably push devices remove" --- diff --git a/src/pages/docs/cli/push/devices/save.mdx b/src/pages/docs/cli/push/devices/save.mdx index def6c4f724..3c6ebd54eb 100644 --- a/src/pages/docs/cli/push/devices/save.mdx +++ b/src/pages/docs/cli/push/devices/save.mdx @@ -1,5 +1,5 @@ --- -title: "ably push devices save" +title: "Push devices save" meta_description: "Register or update a push device using the Ably CLI." meta_keywords: "ably cli, cli, push, devices, save, register, update, ably push devices save" --- diff --git a/src/pages/docs/cli/push/index.mdx b/src/pages/docs/cli/push/index.mdx index 04f1e728bb..7ab55c111e 100644 --- a/src/pages/docs/cli/push/index.mdx +++ b/src/pages/docs/cli/push/index.mdx @@ -1,5 +1,5 @@ --- -title: "ably push" +title: "Push" meta_description: "Manage push notifications using the Ably CLI." meta_keywords: "ably cli, cli, push, notifications, publish, devices, channels, config, ably push" --- diff --git a/src/pages/docs/cli/push/publish.mdx b/src/pages/docs/cli/push/publish.mdx index 1e7b504970..4346c2d825 100644 --- a/src/pages/docs/cli/push/publish.mdx +++ b/src/pages/docs/cli/push/publish.mdx @@ -1,5 +1,5 @@ --- -title: "ably push publish" +title: "Push publish" meta_description: "Publish a push notification to a device, client, or channel using the Ably CLI." meta_keywords: "ably cli, cli, push, publish, notification, device, client, channel, ably push publish" --- diff --git a/src/pages/docs/cli/queues/create.mdx b/src/pages/docs/cli/queues/create.mdx index 4317163966..047abcd6b1 100644 --- a/src/pages/docs/cli/queues/create.mdx +++ b/src/pages/docs/cli/queues/create.mdx @@ -1,5 +1,5 @@ --- -title: "ably queues create" +title: "Queues create" meta_description: "Create a queue using the Ably CLI." meta_keywords: "ably cli, cli, queues, create, message queue, ably queues create" --- diff --git a/src/pages/docs/cli/queues/delete.mdx b/src/pages/docs/cli/queues/delete.mdx index b75f9777e1..a69c977cd0 100644 --- a/src/pages/docs/cli/queues/delete.mdx +++ b/src/pages/docs/cli/queues/delete.mdx @@ -1,5 +1,5 @@ --- -title: "ably queues delete" +title: "Queues delete" meta_description: "Delete a queue using the Ably CLI." meta_keywords: "ably cli, cli, queues, delete, message queue, ably queues delete" --- diff --git a/src/pages/docs/cli/queues/index.mdx b/src/pages/docs/cli/queues/index.mdx index 835701bb0d..851cd520e1 100644 --- a/src/pages/docs/cli/queues/index.mdx +++ b/src/pages/docs/cli/queues/index.mdx @@ -1,5 +1,5 @@ --- -title: "ably queues" +title: "Queues" meta_description: "Manage Ably queues." meta_keywords: "ably cli, cli, queues, message queues, ably queues" --- diff --git a/src/pages/docs/cli/queues/list.mdx b/src/pages/docs/cli/queues/list.mdx index ad234f1f4c..a103648ca2 100644 --- a/src/pages/docs/cli/queues/list.mdx +++ b/src/pages/docs/cli/queues/list.mdx @@ -1,5 +1,5 @@ --- -title: "ably queues list" +title: "Queues list" meta_description: "List all queues using the Ably CLI." meta_keywords: "ably cli, cli, queues, list, message queues, ably queues list" --- diff --git a/src/pages/docs/cli/rooms/index.mdx b/src/pages/docs/cli/rooms/index.mdx index 07bff21270..5a4abff1ed 100644 --- a/src/pages/docs/cli/rooms/index.mdx +++ b/src/pages/docs/cli/rooms/index.mdx @@ -1,5 +1,5 @@ --- -title: "ably rooms" +title: "Rooms" meta_description: "Interact with Ably Chat rooms using the CLI." meta_keywords: "ably cli, cli, rooms, chat, messages, presence, occupancy, reactions, typing, ably rooms" --- diff --git a/src/pages/docs/cli/rooms/list.mdx b/src/pages/docs/cli/rooms/list.mdx index 7442d33a9c..e8b6357da0 100644 --- a/src/pages/docs/cli/rooms/list.mdx +++ b/src/pages/docs/cli/rooms/list.mdx @@ -1,5 +1,5 @@ --- -title: "ably rooms list" +title: "Rooms list" meta_description: "List active Ably Chat rooms using the CLI." meta_keywords: "ably cli, cli, rooms, list, chat, ably rooms list" --- diff --git a/src/pages/docs/cli/rooms/messages/delete.mdx b/src/pages/docs/cli/rooms/messages/delete.mdx index 554753bfdd..bb1c316fac 100644 --- a/src/pages/docs/cli/rooms/messages/delete.mdx +++ b/src/pages/docs/cli/rooms/messages/delete.mdx @@ -1,5 +1,5 @@ --- -title: "ably rooms messages delete" +title: "Rooms messages delete" meta_description: "Delete a message in an Ably Chat room using the CLI." meta_keywords: "ably cli, cli, rooms, messages, delete, chat, ably rooms messages delete" --- diff --git a/src/pages/docs/cli/rooms/messages/history.mdx b/src/pages/docs/cli/rooms/messages/history.mdx index 9c25976508..8f47620953 100644 --- a/src/pages/docs/cli/rooms/messages/history.mdx +++ b/src/pages/docs/cli/rooms/messages/history.mdx @@ -1,5 +1,5 @@ --- -title: "ably rooms messages history" +title: "Rooms messages history" meta_description: "Get historical messages from an Ably Chat room using the CLI." meta_keywords: "ably cli, cli, rooms, messages, history, chat, ably rooms messages history" --- diff --git a/src/pages/docs/cli/rooms/messages/index.mdx b/src/pages/docs/cli/rooms/messages/index.mdx index cdeb1d1955..a47342d94b 100644 --- a/src/pages/docs/cli/rooms/messages/index.mdx +++ b/src/pages/docs/cli/rooms/messages/index.mdx @@ -1,5 +1,5 @@ --- -title: "ably rooms messages" +title: "Rooms messages" meta_description: "Commands for working with chat messages in Ably Chat rooms using the CLI." meta_keywords: "ably cli, cli, rooms, messages, chat, send, subscribe, history, ably rooms messages" --- diff --git a/src/pages/docs/cli/rooms/messages/reactions/index.mdx b/src/pages/docs/cli/rooms/messages/reactions/index.mdx index 76615d5356..afea9dc30d 100644 --- a/src/pages/docs/cli/rooms/messages/reactions/index.mdx +++ b/src/pages/docs/cli/rooms/messages/reactions/index.mdx @@ -1,5 +1,5 @@ --- -title: "ably rooms messages reactions" +title: "Rooms messages reactions" meta_description: "Commands for working with message reactions in Ably Chat rooms using the CLI." meta_keywords: "ably cli, cli, rooms, messages, reactions, chat, ably rooms messages reactions" --- diff --git a/src/pages/docs/cli/rooms/messages/reactions/remove.mdx b/src/pages/docs/cli/rooms/messages/reactions/remove.mdx index 01735af531..790ab3c833 100644 --- a/src/pages/docs/cli/rooms/messages/reactions/remove.mdx +++ b/src/pages/docs/cli/rooms/messages/reactions/remove.mdx @@ -1,5 +1,5 @@ --- -title: "ably rooms messages reactions remove" +title: "Rooms messages reactions remove" meta_description: "Remove a reaction from a message in an Ably Chat room using the CLI." meta_keywords: "ably cli, cli, rooms, messages, reactions, remove, chat, ably rooms messages reactions remove" --- diff --git a/src/pages/docs/cli/rooms/messages/reactions/send.mdx b/src/pages/docs/cli/rooms/messages/reactions/send.mdx index 3b3aa94b18..f43c26062b 100644 --- a/src/pages/docs/cli/rooms/messages/reactions/send.mdx +++ b/src/pages/docs/cli/rooms/messages/reactions/send.mdx @@ -1,5 +1,5 @@ --- -title: "ably rooms messages reactions send" +title: "Rooms messages reactions send" meta_description: "Send a reaction to a message in an Ably Chat room using the CLI." meta_keywords: "ably cli, cli, rooms, messages, reactions, send, chat, ably rooms messages reactions send" --- diff --git a/src/pages/docs/cli/rooms/messages/reactions/subscribe.mdx b/src/pages/docs/cli/rooms/messages/reactions/subscribe.mdx index 72fc32ae79..af087790ff 100644 --- a/src/pages/docs/cli/rooms/messages/reactions/subscribe.mdx +++ b/src/pages/docs/cli/rooms/messages/reactions/subscribe.mdx @@ -1,5 +1,5 @@ --- -title: "ably rooms messages reactions subscribe" +title: "Rooms messages reactions subscribe" meta_description: "Subscribe to message reactions in an Ably Chat room using the CLI." meta_keywords: "ably cli, cli, rooms, messages, reactions, subscribe, chat, ably rooms messages reactions subscribe" --- diff --git a/src/pages/docs/cli/rooms/messages/send.mdx b/src/pages/docs/cli/rooms/messages/send.mdx index c593492e5c..432499299c 100644 --- a/src/pages/docs/cli/rooms/messages/send.mdx +++ b/src/pages/docs/cli/rooms/messages/send.mdx @@ -1,5 +1,5 @@ --- -title: "ably rooms messages send" +title: "Rooms messages send" meta_description: "Send a message to an Ably Chat room using the CLI." meta_keywords: "ably cli, cli, rooms, messages, send, chat, ably rooms messages send" --- diff --git a/src/pages/docs/cli/rooms/messages/subscribe.mdx b/src/pages/docs/cli/rooms/messages/subscribe.mdx index 4b000d23c3..dddec19397 100644 --- a/src/pages/docs/cli/rooms/messages/subscribe.mdx +++ b/src/pages/docs/cli/rooms/messages/subscribe.mdx @@ -1,5 +1,5 @@ --- -title: "ably rooms messages subscribe" +title: "Rooms messages subscribe" meta_description: "Subscribe to messages in one or more Ably Chat rooms using the CLI." meta_keywords: "ably cli, cli, rooms, messages, subscribe, chat, ably rooms messages subscribe" --- diff --git a/src/pages/docs/cli/rooms/messages/update.mdx b/src/pages/docs/cli/rooms/messages/update.mdx index 4c3aa18a8f..fef3790f75 100644 --- a/src/pages/docs/cli/rooms/messages/update.mdx +++ b/src/pages/docs/cli/rooms/messages/update.mdx @@ -1,5 +1,5 @@ --- -title: "ably rooms messages update" +title: "Rooms messages update" meta_description: "Update a message in an Ably Chat room using the CLI." meta_keywords: "ably cli, cli, rooms, messages, update, chat, ably rooms messages update" --- diff --git a/src/pages/docs/cli/rooms/occupancy/get.mdx b/src/pages/docs/cli/rooms/occupancy/get.mdx index 78d251a1b6..29882dd2fa 100644 --- a/src/pages/docs/cli/rooms/occupancy/get.mdx +++ b/src/pages/docs/cli/rooms/occupancy/get.mdx @@ -1,5 +1,5 @@ --- -title: "ably rooms occupancy get" +title: "Rooms occupancy get" meta_description: "Get current occupancy metrics for an Ably Chat room using the CLI." meta_keywords: "ably cli, cli, rooms, occupancy, get, chat, metrics, ably rooms occupancy get" --- diff --git a/src/pages/docs/cli/rooms/occupancy/index.mdx b/src/pages/docs/cli/rooms/occupancy/index.mdx index 8ad35d417a..99fda76952 100644 --- a/src/pages/docs/cli/rooms/occupancy/index.mdx +++ b/src/pages/docs/cli/rooms/occupancy/index.mdx @@ -1,5 +1,5 @@ --- -title: "ably rooms occupancy" +title: "Rooms occupancy" meta_description: "Commands for monitoring room occupancy in Ably Chat using the CLI." meta_keywords: "ably cli, cli, rooms, occupancy, chat, metrics, ably rooms occupancy" --- diff --git a/src/pages/docs/cli/rooms/occupancy/subscribe.mdx b/src/pages/docs/cli/rooms/occupancy/subscribe.mdx index 70af4fd7b8..a1f762b541 100644 --- a/src/pages/docs/cli/rooms/occupancy/subscribe.mdx +++ b/src/pages/docs/cli/rooms/occupancy/subscribe.mdx @@ -1,5 +1,5 @@ --- -title: "ably rooms occupancy subscribe" +title: "Rooms occupancy subscribe" meta_description: "Subscribe to real-time occupancy metrics for an Ably Chat room using the CLI." meta_keywords: "ably cli, cli, rooms, occupancy, subscribe, chat, metrics, ably rooms occupancy subscribe" --- diff --git a/src/pages/docs/cli/rooms/presence/enter.mdx b/src/pages/docs/cli/rooms/presence/enter.mdx index fceed09fff..4c9041872d 100644 --- a/src/pages/docs/cli/rooms/presence/enter.mdx +++ b/src/pages/docs/cli/rooms/presence/enter.mdx @@ -1,5 +1,5 @@ --- -title: "ably rooms presence enter" +title: "Rooms presence enter" meta_description: "Enter presence in an Ably Chat room using the CLI." meta_keywords: "ably cli, cli, rooms, presence, enter, chat, ably rooms presence enter" --- diff --git a/src/pages/docs/cli/rooms/presence/get.mdx b/src/pages/docs/cli/rooms/presence/get.mdx index d20fe0c6bf..c2270771ee 100644 --- a/src/pages/docs/cli/rooms/presence/get.mdx +++ b/src/pages/docs/cli/rooms/presence/get.mdx @@ -1,5 +1,5 @@ --- -title: "ably rooms presence get" +title: "Rooms presence get" meta_description: "Get current presence members in an Ably Chat room using the CLI." meta_keywords: "ably cli, cli, rooms, presence, get, chat, members, ably rooms presence get" --- diff --git a/src/pages/docs/cli/rooms/presence/index.mdx b/src/pages/docs/cli/rooms/presence/index.mdx index e3d7b9784d..a74c02eabf 100644 --- a/src/pages/docs/cli/rooms/presence/index.mdx +++ b/src/pages/docs/cli/rooms/presence/index.mdx @@ -1,5 +1,5 @@ --- -title: "ably rooms presence" +title: "Rooms presence" meta_description: "Commands for working with presence in Ably Chat rooms using the CLI." meta_keywords: "ably cli, cli, rooms, presence, chat, members, ably rooms presence" --- diff --git a/src/pages/docs/cli/rooms/presence/subscribe.mdx b/src/pages/docs/cli/rooms/presence/subscribe.mdx index a18ccecb46..14c7952e59 100644 --- a/src/pages/docs/cli/rooms/presence/subscribe.mdx +++ b/src/pages/docs/cli/rooms/presence/subscribe.mdx @@ -1,5 +1,5 @@ --- -title: "ably rooms presence subscribe" +title: "Rooms presence subscribe" meta_description: "Subscribe to presence events in an Ably Chat room using the CLI." meta_keywords: "ably cli, cli, rooms, presence, subscribe, chat, events, ably rooms presence subscribe" --- diff --git a/src/pages/docs/cli/rooms/reactions/index.mdx b/src/pages/docs/cli/rooms/reactions/index.mdx index b63cdf6857..fbda8bc6d6 100644 --- a/src/pages/docs/cli/rooms/reactions/index.mdx +++ b/src/pages/docs/cli/rooms/reactions/index.mdx @@ -1,5 +1,5 @@ --- -title: "ably rooms reactions" +title: "Rooms reactions" meta_description: "Commands for working with room-level reactions in Ably Chat using the CLI." meta_keywords: "ably cli, cli, rooms, reactions, chat, emoji, ably rooms reactions" --- diff --git a/src/pages/docs/cli/rooms/reactions/send.mdx b/src/pages/docs/cli/rooms/reactions/send.mdx index c5b5002d86..7da43d15fb 100644 --- a/src/pages/docs/cli/rooms/reactions/send.mdx +++ b/src/pages/docs/cli/rooms/reactions/send.mdx @@ -1,5 +1,5 @@ --- -title: "ably rooms reactions send" +title: "Rooms reactions send" meta_description: "Send a reaction in an Ably Chat room using the CLI." meta_keywords: "ably cli, cli, rooms, reactions, send, chat, emoji, ably rooms reactions send" --- diff --git a/src/pages/docs/cli/rooms/reactions/subscribe.mdx b/src/pages/docs/cli/rooms/reactions/subscribe.mdx index 6fb41539bf..89ed7a15e9 100644 --- a/src/pages/docs/cli/rooms/reactions/subscribe.mdx +++ b/src/pages/docs/cli/rooms/reactions/subscribe.mdx @@ -1,5 +1,5 @@ --- -title: "ably rooms reactions subscribe" +title: "Rooms reactions subscribe" meta_description: "Subscribe to reactions in an Ably Chat room using the CLI." meta_keywords: "ably cli, cli, rooms, reactions, subscribe, chat, emoji, ably rooms reactions subscribe" --- diff --git a/src/pages/docs/cli/rooms/typing/index.mdx b/src/pages/docs/cli/rooms/typing/index.mdx index 885e184c0f..2ccbec948b 100644 --- a/src/pages/docs/cli/rooms/typing/index.mdx +++ b/src/pages/docs/cli/rooms/typing/index.mdx @@ -1,5 +1,5 @@ --- -title: "ably rooms typing" +title: "Rooms typing" meta_description: "Commands for working with typing indicators in Ably Chat rooms using the CLI." meta_keywords: "ably cli, cli, rooms, typing, chat, indicators, ably rooms typing" --- diff --git a/src/pages/docs/cli/rooms/typing/keystroke.mdx b/src/pages/docs/cli/rooms/typing/keystroke.mdx index 8c9f3e8587..317aa4f3ed 100644 --- a/src/pages/docs/cli/rooms/typing/keystroke.mdx +++ b/src/pages/docs/cli/rooms/typing/keystroke.mdx @@ -1,5 +1,5 @@ --- -title: "ably rooms typing keystroke" +title: "Rooms typing keystroke" meta_description: "Send a typing indicator in an Ably Chat room using the CLI." meta_keywords: "ably cli, cli, rooms, typing, keystroke, chat, indicator, ably rooms typing keystroke" --- diff --git a/src/pages/docs/cli/rooms/typing/subscribe.mdx b/src/pages/docs/cli/rooms/typing/subscribe.mdx index 90b28f633c..97d5dc37d5 100644 --- a/src/pages/docs/cli/rooms/typing/subscribe.mdx +++ b/src/pages/docs/cli/rooms/typing/subscribe.mdx @@ -1,5 +1,5 @@ --- -title: "ably rooms typing subscribe" +title: "Rooms typing subscribe" meta_description: "Subscribe to typing indicators in an Ably Chat room using the CLI." meta_keywords: "ably cli, cli, rooms, typing, subscribe, chat, indicators, ably rooms typing subscribe" --- diff --git a/src/pages/docs/cli/spaces/create.mdx b/src/pages/docs/cli/spaces/create.mdx index dae0fe5e05..f765dc5406 100644 --- a/src/pages/docs/cli/spaces/create.mdx +++ b/src/pages/docs/cli/spaces/create.mdx @@ -1,5 +1,5 @@ --- -title: "ably spaces create" +title: "Spaces create" meta_description: "Initialize an Ably Space without entering it using the CLI." meta_keywords: "ably cli, cli, spaces, create, initialize, ably spaces create" --- diff --git a/src/pages/docs/cli/spaces/cursors/get.mdx b/src/pages/docs/cli/spaces/cursors/get.mdx index 1e1736ea19..631976be53 100644 --- a/src/pages/docs/cli/spaces/cursors/get.mdx +++ b/src/pages/docs/cli/spaces/cursors/get.mdx @@ -1,5 +1,5 @@ --- -title: "ably spaces cursors get" +title: "Spaces cursors get" meta_description: "Get all current cursors in an Ably Space using the CLI." meta_keywords: "ably cli, cli, spaces, cursors, get, position, ably spaces cursors get" --- diff --git a/src/pages/docs/cli/spaces/cursors/index.mdx b/src/pages/docs/cli/spaces/cursors/index.mdx index 3152daf955..0484c4ca9c 100644 --- a/src/pages/docs/cli/spaces/cursors/index.mdx +++ b/src/pages/docs/cli/spaces/cursors/index.mdx @@ -1,5 +1,5 @@ --- -title: "ably spaces cursors" +title: "Spaces cursors" meta_description: "Commands for cursor management in Ably Spaces using the CLI." meta_keywords: "ably cli, cli, spaces, cursors, position, tracking, ably spaces cursors" --- diff --git a/src/pages/docs/cli/spaces/cursors/set.mdx b/src/pages/docs/cli/spaces/cursors/set.mdx index 572130742d..66d06fcd10 100644 --- a/src/pages/docs/cli/spaces/cursors/set.mdx +++ b/src/pages/docs/cli/spaces/cursors/set.mdx @@ -1,5 +1,5 @@ --- -title: "ably spaces cursors set" +title: "Spaces cursors set" meta_description: "Set a cursor with position data in an Ably Space using the CLI." meta_keywords: "ably cli, cli, spaces, cursors, set, position, ably spaces cursors set" --- diff --git a/src/pages/docs/cli/spaces/cursors/subscribe.mdx b/src/pages/docs/cli/spaces/cursors/subscribe.mdx index 26f44327f6..aaa6fbfed0 100644 --- a/src/pages/docs/cli/spaces/cursors/subscribe.mdx +++ b/src/pages/docs/cli/spaces/cursors/subscribe.mdx @@ -1,5 +1,5 @@ --- -title: "ably spaces cursors subscribe" +title: "Spaces cursors subscribe" meta_description: "Subscribe to cursor movements in an Ably Space using the CLI." meta_keywords: "ably cli, cli, spaces, cursors, subscribe, movements, ably spaces cursors subscribe" --- diff --git a/src/pages/docs/cli/spaces/get.mdx b/src/pages/docs/cli/spaces/get.mdx index 8c8aa0a994..35ac2f6e11 100644 --- a/src/pages/docs/cli/spaces/get.mdx +++ b/src/pages/docs/cli/spaces/get.mdx @@ -1,5 +1,5 @@ --- -title: "ably spaces get" +title: "Spaces get" meta_description: "Get the current state of an Ably Space using the CLI." meta_keywords: "ably cli, cli, spaces, get, state, ably spaces get" --- diff --git a/src/pages/docs/cli/spaces/index.mdx b/src/pages/docs/cli/spaces/index.mdx index 6dc39e59a6..b41de4db80 100644 --- a/src/pages/docs/cli/spaces/index.mdx +++ b/src/pages/docs/cli/spaces/index.mdx @@ -1,5 +1,5 @@ --- -title: "ably spaces" +title: "Spaces" meta_description: "Interact with Ably Spaces using the CLI." meta_keywords: "ably cli, cli, spaces, cursors, locations, locks, members, occupancy, ably spaces" --- diff --git a/src/pages/docs/cli/spaces/list.mdx b/src/pages/docs/cli/spaces/list.mdx index cfa5591cc9..65db39dc45 100644 --- a/src/pages/docs/cli/spaces/list.mdx +++ b/src/pages/docs/cli/spaces/list.mdx @@ -1,5 +1,5 @@ --- -title: "ably spaces list" +title: "Spaces list" meta_description: "List active Ably Spaces using the CLI." meta_keywords: "ably cli, cli, spaces, list, active, ably spaces list" --- diff --git a/src/pages/docs/cli/spaces/locations/get.mdx b/src/pages/docs/cli/spaces/locations/get.mdx index 05d2025ee4..999ee265d6 100644 --- a/src/pages/docs/cli/spaces/locations/get.mdx +++ b/src/pages/docs/cli/spaces/locations/get.mdx @@ -1,5 +1,5 @@ --- -title: "ably spaces locations get" +title: "Spaces locations get" meta_description: "Get all current locations in an Ably Space using the CLI." meta_keywords: "ably cli, cli, spaces, locations, get, ably spaces locations get" --- diff --git a/src/pages/docs/cli/spaces/locations/index.mdx b/src/pages/docs/cli/spaces/locations/index.mdx index 062965f576..d5b63e6f72 100644 --- a/src/pages/docs/cli/spaces/locations/index.mdx +++ b/src/pages/docs/cli/spaces/locations/index.mdx @@ -1,5 +1,5 @@ --- -title: "ably spaces locations" +title: "Spaces locations" meta_description: "Commands for location management in Ably Spaces using the CLI." meta_keywords: "ably cli, cli, spaces, locations, tracking, ably spaces locations" --- diff --git a/src/pages/docs/cli/spaces/locations/set.mdx b/src/pages/docs/cli/spaces/locations/set.mdx index 33bd672971..68f8d4d61e 100644 --- a/src/pages/docs/cli/spaces/locations/set.mdx +++ b/src/pages/docs/cli/spaces/locations/set.mdx @@ -1,5 +1,5 @@ --- -title: "ably spaces locations set" +title: "Spaces locations set" meta_description: "Set location in an Ably Space using the CLI." meta_keywords: "ably cli, cli, spaces, locations, set, ably spaces locations set" --- diff --git a/src/pages/docs/cli/spaces/locations/subscribe.mdx b/src/pages/docs/cli/spaces/locations/subscribe.mdx index 9aeb8699ae..f2c703ad6e 100644 --- a/src/pages/docs/cli/spaces/locations/subscribe.mdx +++ b/src/pages/docs/cli/spaces/locations/subscribe.mdx @@ -1,5 +1,5 @@ --- -title: "ably spaces locations subscribe" +title: "Spaces locations subscribe" meta_description: "Subscribe to location updates for members in an Ably Space using the CLI." meta_keywords: "ably cli, cli, spaces, locations, subscribe, updates, ably spaces locations subscribe" --- diff --git a/src/pages/docs/cli/spaces/locks/acquire.mdx b/src/pages/docs/cli/spaces/locks/acquire.mdx index d353e6499c..e4d153d56e 100644 --- a/src/pages/docs/cli/spaces/locks/acquire.mdx +++ b/src/pages/docs/cli/spaces/locks/acquire.mdx @@ -1,5 +1,5 @@ --- -title: "ably spaces locks acquire" +title: "Spaces locks acquire" meta_description: "Acquire a lock in an Ably Space using the CLI." meta_keywords: "ably cli, cli, spaces, locks, acquire, locking, ably spaces locks acquire" --- diff --git a/src/pages/docs/cli/spaces/locks/get.mdx b/src/pages/docs/cli/spaces/locks/get.mdx index c89096b8d5..f6d8d39454 100644 --- a/src/pages/docs/cli/spaces/locks/get.mdx +++ b/src/pages/docs/cli/spaces/locks/get.mdx @@ -1,5 +1,5 @@ --- -title: "ably spaces locks get" +title: "Spaces locks get" meta_description: "Get a lock or all locks in an Ably Space using the CLI." meta_keywords: "ably cli, cli, spaces, locks, get, ably spaces locks get" --- diff --git a/src/pages/docs/cli/spaces/locks/index.mdx b/src/pages/docs/cli/spaces/locks/index.mdx index 12c3b8fc46..577f998315 100644 --- a/src/pages/docs/cli/spaces/locks/index.mdx +++ b/src/pages/docs/cli/spaces/locks/index.mdx @@ -1,5 +1,5 @@ --- -title: "ably spaces locks" +title: "Spaces locks" meta_description: "Commands for component locking in Ably Spaces using the CLI." meta_keywords: "ably cli, cli, spaces, locks, locking, components, ably spaces locks" --- diff --git a/src/pages/docs/cli/spaces/locks/subscribe.mdx b/src/pages/docs/cli/spaces/locks/subscribe.mdx index 72fbeb4b5e..cd5b5b2f0d 100644 --- a/src/pages/docs/cli/spaces/locks/subscribe.mdx +++ b/src/pages/docs/cli/spaces/locks/subscribe.mdx @@ -1,5 +1,5 @@ --- -title: "ably spaces locks subscribe" +title: "Spaces locks subscribe" meta_description: "Subscribe to lock events in an Ably Space using the CLI." meta_keywords: "ably cli, cli, spaces, locks, subscribe, events, ably spaces locks subscribe" --- diff --git a/src/pages/docs/cli/spaces/members/enter.mdx b/src/pages/docs/cli/spaces/members/enter.mdx index cf1fbbe935..d3d2e0cb56 100644 --- a/src/pages/docs/cli/spaces/members/enter.mdx +++ b/src/pages/docs/cli/spaces/members/enter.mdx @@ -1,5 +1,5 @@ --- -title: "ably spaces members enter" +title: "Spaces members enter" meta_description: "Enter an Ably Space and remain present until terminated using the CLI." meta_keywords: "ably cli, cli, spaces, members, enter, presence, ably spaces members enter" --- diff --git a/src/pages/docs/cli/spaces/members/get.mdx b/src/pages/docs/cli/spaces/members/get.mdx index b5a56fc3fc..27de6a3e6c 100644 --- a/src/pages/docs/cli/spaces/members/get.mdx +++ b/src/pages/docs/cli/spaces/members/get.mdx @@ -1,5 +1,5 @@ --- -title: "ably spaces members get" +title: "Spaces members get" meta_description: "Get all members in an Ably Space using the CLI." meta_keywords: "ably cli, cli, spaces, members, get, presence, ably spaces members get" --- diff --git a/src/pages/docs/cli/spaces/members/index.mdx b/src/pages/docs/cli/spaces/members/index.mdx index 36cec46f72..0fab305db0 100644 --- a/src/pages/docs/cli/spaces/members/index.mdx +++ b/src/pages/docs/cli/spaces/members/index.mdx @@ -1,5 +1,5 @@ --- -title: "ably spaces members" +title: "Spaces members" meta_description: "Commands for managing members in Ably Spaces using the CLI." meta_keywords: "ably cli, cli, spaces, members, presence, ably spaces members" --- diff --git a/src/pages/docs/cli/spaces/members/subscribe.mdx b/src/pages/docs/cli/spaces/members/subscribe.mdx index ed2da943b1..6c57097248 100644 --- a/src/pages/docs/cli/spaces/members/subscribe.mdx +++ b/src/pages/docs/cli/spaces/members/subscribe.mdx @@ -1,5 +1,5 @@ --- -title: "ably spaces members subscribe" +title: "Spaces members subscribe" meta_description: "Subscribe to member presence events in an Ably Space using the CLI." meta_keywords: "ably cli, cli, spaces, members, subscribe, presence, events, ably spaces members subscribe" --- diff --git a/src/pages/docs/cli/spaces/occupancy/get.mdx b/src/pages/docs/cli/spaces/occupancy/get.mdx index 873c3ad2dc..83bb8cf808 100644 --- a/src/pages/docs/cli/spaces/occupancy/get.mdx +++ b/src/pages/docs/cli/spaces/occupancy/get.mdx @@ -1,5 +1,5 @@ --- -title: "ably spaces occupancy get" +title: "Spaces occupancy get" meta_description: "Get current occupancy metrics for an Ably Space using the CLI." meta_keywords: "ably cli, cli, spaces, occupancy, get, metrics, ably spaces occupancy get" --- diff --git a/src/pages/docs/cli/spaces/occupancy/index.mdx b/src/pages/docs/cli/spaces/occupancy/index.mdx index 6d10ebfbab..783a9e7948 100644 --- a/src/pages/docs/cli/spaces/occupancy/index.mdx +++ b/src/pages/docs/cli/spaces/occupancy/index.mdx @@ -1,5 +1,5 @@ --- -title: "ably spaces occupancy" +title: "Spaces occupancy" meta_description: "Commands for working with occupancy in Ably Spaces using the CLI." meta_keywords: "ably cli, cli, spaces, occupancy, metrics, ably spaces occupancy" --- diff --git a/src/pages/docs/cli/spaces/occupancy/subscribe.mdx b/src/pages/docs/cli/spaces/occupancy/subscribe.mdx index 9fc940a937..972e7ad418 100644 --- a/src/pages/docs/cli/spaces/occupancy/subscribe.mdx +++ b/src/pages/docs/cli/spaces/occupancy/subscribe.mdx @@ -1,5 +1,5 @@ --- -title: "ably spaces occupancy subscribe" +title: "Spaces occupancy subscribe" meta_description: "Subscribe to occupancy events on an Ably Space using the CLI." meta_keywords: "ably cli, cli, spaces, occupancy, subscribe, events, ably spaces occupancy subscribe" --- diff --git a/src/pages/docs/cli/spaces/subscribe.mdx b/src/pages/docs/cli/spaces/subscribe.mdx index 12d775399a..99cdac8bf9 100644 --- a/src/pages/docs/cli/spaces/subscribe.mdx +++ b/src/pages/docs/cli/spaces/subscribe.mdx @@ -1,5 +1,5 @@ --- -title: "ably spaces subscribe" +title: "Spaces subscribe" meta_description: "Subscribe to member and location update events in an Ably Space using the CLI." meta_keywords: "ably cli, cli, spaces, subscribe, events, members, locations, ably spaces subscribe" --- diff --git a/src/pages/docs/cli/stats/account.mdx b/src/pages/docs/cli/stats/account.mdx index bf706a71fc..dc8934afc4 100644 --- a/src/pages/docs/cli/stats/account.mdx +++ b/src/pages/docs/cli/stats/account.mdx @@ -1,5 +1,5 @@ --- -title: "ably stats account" +title: "Stats account" meta_description: "Get account-level statistics with optional live updates using the CLI." meta_keywords: "ably cli, cli, stats, statistics, account, live, ably stats account" --- diff --git a/src/pages/docs/cli/stats/app.mdx b/src/pages/docs/cli/stats/app.mdx index e643119741..814a57931b 100644 --- a/src/pages/docs/cli/stats/app.mdx +++ b/src/pages/docs/cli/stats/app.mdx @@ -1,5 +1,5 @@ --- -title: "ably stats app" +title: "Stats app" meta_description: "Get app-level statistics with optional live updates using the CLI." meta_keywords: "ably cli, cli, stats, statistics, app, live, ably stats app" --- diff --git a/src/pages/docs/cli/stats/index.mdx b/src/pages/docs/cli/stats/index.mdx index 610881f14e..e27744966b 100644 --- a/src/pages/docs/cli/stats/index.mdx +++ b/src/pages/docs/cli/stats/index.mdx @@ -1,5 +1,5 @@ --- -title: "ably stats" +title: "Stats" meta_description: "View statistics for your Ably account or apps." meta_keywords: "ably cli, cli, stats, statistics, account, app, ably stats" --- diff --git a/src/pages/docs/cli/status.mdx b/src/pages/docs/cli/status.mdx index e8538529a4..c35e1f7975 100644 --- a/src/pages/docs/cli/status.mdx +++ b/src/pages/docs/cli/status.mdx @@ -1,5 +1,5 @@ --- -title: "ably status" +title: "Status" meta_description: "Check the status of Ably services using the CLI." meta_keywords: "ably cli, cli, status, service status, ably status" --- diff --git a/src/pages/docs/cli/support/ask.mdx b/src/pages/docs/cli/support/ask.mdx index d79742f0a2..ae6682df98 100644 --- a/src/pages/docs/cli/support/ask.mdx +++ b/src/pages/docs/cli/support/ask.mdx @@ -1,5 +1,5 @@ --- -title: "ably support ask" +title: "Support ask" meta_description: "Ask a question to the Ably AI agent for help using the CLI." meta_keywords: "ably cli, cli, support, ask, ai, question, ably support ask" --- diff --git a/src/pages/docs/cli/support/contact.mdx b/src/pages/docs/cli/support/contact.mdx index bf56f7d4fe..211720dee2 100644 --- a/src/pages/docs/cli/support/contact.mdx +++ b/src/pages/docs/cli/support/contact.mdx @@ -1,5 +1,5 @@ --- -title: "ably support contact" +title: "Support contact" meta_description: "Contact Ably for assistance using the CLI." meta_keywords: "ably cli, cli, support, contact, help, ably support contact" --- diff --git a/src/pages/docs/cli/support/index.mdx b/src/pages/docs/cli/support/index.mdx index 47eb9b1871..e1f7d789dc 100644 --- a/src/pages/docs/cli/support/index.mdx +++ b/src/pages/docs/cli/support/index.mdx @@ -1,5 +1,5 @@ --- -title: "ably support" +title: "Support" meta_description: "Get support and help from Ably." meta_keywords: "ably cli, cli, support, help, ask, contact, ably support" --- diff --git a/src/pages/docs/cli/version.mdx b/src/pages/docs/cli/version.mdx index 205eb81b73..8e71c2e109 100644 --- a/src/pages/docs/cli/version.mdx +++ b/src/pages/docs/cli/version.mdx @@ -1,5 +1,5 @@ --- -title: "ably version" +title: "Version" meta_description: "Display the version of the Ably CLI." meta_keywords: "ably cli, cli, version, ably version" --- diff --git a/src/pages/docs/platform/tools/cli.mdx b/src/pages/docs/platform/tools/cli.mdx index f4ffb443b8..0ee013097d 100644 --- a/src/pages/docs/platform/tools/cli.mdx +++ b/src/pages/docs/platform/tools/cli.mdx @@ -17,7 +17,7 @@ The Ably CLI interacts with: ## Installation -The Ably CLI is available as an NPM package, install using +The Ably CLI is available as an NPM package. Install it using: ```shell @@ -124,7 +124,7 @@ ably autocomplete This displays installation instructions specific to your shell. Follow them to enable tab completion for commands, subcommands, and flags. -For more details, see the [auto-completion documentation](https://github.com/ably/ably-cli/blob/main/docs/Auto-completion.md) on GitHub. +For more details, see the auto-completion [CLI reference](/docs/cli/autocomplete) and [github documentation](https://github.com/ably/ably-cli/blob/main/docs/Auto-completion.md). ## Interactive mode @@ -145,4 +145,4 @@ Interactive mode provides the following features: ## CLI reference -For detailed documentation on every CLI command, including flags, arguments, and usage examples, see the [CLI reference](/docs/cli). +See the [CLI reference](/docs/cli), for detailed documentation on every CLI command, including flags, arguments, and usage examples. From e747bf62430851b2b514a314b44b5e65249bd21e Mon Sep 17 00:00:00 2001 From: sacOO7 Date: Tue, 7 Apr 2026 13:18:24 +0530 Subject: [PATCH 6/9] Refactored and reordered headings for channels, rooms and spaces sub-commands --- src/pages/docs/cli/channels/index.mdx | 14 ++++++------- src/pages/docs/cli/push/index.mdx | 8 +++---- src/pages/docs/cli/rooms/index.mdx | 24 ++++++++++----------- src/pages/docs/cli/spaces/index.mdx | 30 +++++++++++++-------------- src/pages/docs/cli/stats/index.mdx | 7 ++++++- 5 files changed, 44 insertions(+), 39 deletions(-) diff --git a/src/pages/docs/cli/channels/index.mdx b/src/pages/docs/cli/channels/index.mdx index a0c9d6350e..e24c1a1ea9 100644 --- a/src/pages/docs/cli/channels/index.mdx +++ b/src/pages/docs/cli/channels/index.mdx @@ -6,7 +6,7 @@ meta_keywords: "ably cli, cli, channels, pub/sub, publish, subscribe, presence, Use the `ably channels` command group to interact with Ably Pub/Sub channels. These commands enable you to publish and subscribe to messages, manage presence, monitor occupancy, and work with annotations. -## Publishing and subscribing +## Message publishing and subscribing | Command | Description | | ------- | ----------- | @@ -18,7 +18,7 @@ Use the `ably channels` command group to interact with Ably Pub/Sub channels. Th | [`ably channels update`](/docs/cli/channels/update) | Update a message on a channel. | | [`ably channels delete`](/docs/cli/channels/delete) | Delete a message on a channel. | -## Annotations +## Message Annotations | Command | Description | | ------- | ----------- | @@ -32,12 +32,12 @@ Use the `ably channels` command group to interact with Ably Pub/Sub channels. Th | Command | Description | | ------- | ----------- | -| [`ably channels presence`](/docs/cli/channels/presence) | Manage presence on channels. | -| [`ably channels presence enter`](/docs/cli/channels/presence/enter) | Enter presence on a channel. | +| [`ably channels presence`](/docs/cli/channels/presence) | Manage presence members on channels. | +| [`ably channels presence enter`](/docs/cli/channels/presence/enter) | Enter presence member on a channel. | | [`ably channels presence get`](/docs/cli/channels/presence/get) | Get current presence members on a channel. | -| [`ably channels presence subscribe`](/docs/cli/channels/presence/subscribe) | Subscribe to presence events on a channel. | +| [`ably channels presence subscribe`](/docs/cli/channels/presence/subscribe) | Subscribe to presence member events on a channel. | -## Occupancy +## Channel Occupancy | Command | Description | | ------- | ----------- | @@ -45,7 +45,7 @@ Use the `ably channels` command group to interact with Ably Pub/Sub channels. Th | [`ably channels occupancy get`](/docs/cli/channels/occupancy/get) | Get current occupancy for a channel. | | [`ably channels occupancy subscribe`](/docs/cli/channels/occupancy/subscribe) | Subscribe to occupancy updates on a channel. | -## Channel management +## Channels management | Command | Description | | ------- | ----------- | diff --git a/src/pages/docs/cli/push/index.mdx b/src/pages/docs/cli/push/index.mdx index 7ab55c111e..663112d943 100644 --- a/src/pages/docs/cli/push/index.mdx +++ b/src/pages/docs/cli/push/index.mdx @@ -6,14 +6,14 @@ meta_keywords: "ably cli, cli, push, notifications, publish, devices, channels, Use the `ably push` command group to manage push notifications. These commands enable you to publish notifications, manage channel subscriptions, configure push services, and manage device registrations. -## Publishing +## Publish notifications | Command | Description | | ------- | ----------- | | [`ably push publish`](/docs/cli/push/publish) | Publish a push notification to a device, client, or channel. | | [`ably push batch-publish`](/docs/cli/push/batch-publish) | Publish push notifications to multiple recipients in a batch. | -## Channel subscriptions +## Manage push channels | Command | Description | | ------- | ----------- | @@ -24,7 +24,7 @@ Use the `ably push` command group to manage push notifications. These commands e | [`ably push channels remove`](/docs/cli/push/channels/remove) | Remove a push channel subscription. | | [`ably push channels remove-where`](/docs/cli/push/channels/remove-where) | Remove push channel subscriptions matching filter criteria. | -## Configuration +## Manage push configuration | Command | Description | | ------- | ----------- | @@ -35,7 +35,7 @@ Use the `ably push` command group to manage push notifications. These commands e | [`ably push config clear-apns`](/docs/cli/push/config/clear-apns) | Clear APNs push notification configuration for an app. | | [`ably push config clear-fcm`](/docs/cli/push/config/clear-fcm) | Clear FCM push notification configuration for an app. | -## Device registrations +## Manage device registrations | Command | Description | | ------- | ----------- | diff --git a/src/pages/docs/cli/rooms/index.mdx b/src/pages/docs/cli/rooms/index.mdx index 5a4abff1ed..1bf7b43ae2 100644 --- a/src/pages/docs/cli/rooms/index.mdx +++ b/src/pages/docs/cli/rooms/index.mdx @@ -12,7 +12,7 @@ Use the `ably rooms` command group to interact with Ably Chat rooms. These comma | ------- | ----------- | | [`ably rooms list`](/docs/cli/rooms/list) | List active chat rooms. | -## Messages +## Publish messages | Command | Description | | ------- | ----------- | @@ -23,7 +23,7 @@ Use the `ably rooms` command group to interact with Ably Chat rooms. These comma | [`ably rooms messages update`](/docs/cli/rooms/messages/update) | Update a message in a chat room. | | [`ably rooms messages delete`](/docs/cli/rooms/messages/delete) | Delete a message in a chat room. | -## Message reactions +## Publish message reactions | Command | Description | | ------- | ----------- | @@ -32,15 +32,7 @@ Use the `ably rooms` command group to interact with Ably Chat rooms. These comma | [`ably rooms messages reactions subscribe`](/docs/cli/rooms/messages/reactions/subscribe) | Subscribe to message reactions. | | [`ably rooms messages reactions remove`](/docs/cli/rooms/messages/reactions/remove) | Remove a reaction from a message. | -## Occupancy - -| Command | Description | -| ------- | ----------- | -| [`ably rooms occupancy`](/docs/cli/rooms/occupancy) | Commands for monitoring room occupancy. | -| [`ably rooms occupancy get`](/docs/cli/rooms/occupancy/get) | Get current occupancy metrics for a room. | -| [`ably rooms occupancy subscribe`](/docs/cli/rooms/occupancy/subscribe) | Subscribe to real-time occupancy metrics. | - -## Presence +## Room presence | Command | Description | | ------- | ----------- | @@ -57,7 +49,7 @@ Use the `ably rooms` command group to interact with Ably Chat rooms. These comma | [`ably rooms reactions send`](/docs/cli/rooms/reactions/send) | Send a reaction in a chat room. | | [`ably rooms reactions subscribe`](/docs/cli/rooms/reactions/subscribe) | Subscribe to reactions in a chat room. | -## Typing indicators +## Room Typing | Command | Description | | ------- | ----------- | @@ -65,6 +57,14 @@ Use the `ably rooms` command group to interact with Ably Chat rooms. These comma | [`ably rooms typing keystroke`](/docs/cli/rooms/typing/keystroke) | Send a typing indicator in a chat room. | | [`ably rooms typing subscribe`](/docs/cli/rooms/typing/subscribe) | Subscribe to typing indicators in a chat room. | +## Room occupancy + +| Command | Description | +| ------- | ----------- | +| [`ably rooms occupancy`](/docs/cli/rooms/occupancy) | Commands for monitoring room occupancy. | +| [`ably rooms occupancy get`](/docs/cli/rooms/occupancy/get) | Get current occupancy metrics for a room. | +| [`ably rooms occupancy subscribe`](/docs/cli/rooms/occupancy/subscribe) | Subscribe to real-time occupancy metrics. | + ## See also * [CLI reference](/docs/cli) — Full list of available commands. diff --git a/src/pages/docs/cli/spaces/index.mdx b/src/pages/docs/cli/spaces/index.mdx index b41de4db80..8a119d5770 100644 --- a/src/pages/docs/cli/spaces/index.mdx +++ b/src/pages/docs/cli/spaces/index.mdx @@ -6,7 +6,7 @@ meta_keywords: "ably cli, cli, spaces, cursors, locations, locks, members, occup Use the `ably spaces` command group to interact with Ably Spaces. These commands enable you to create and manage spaces, track cursors, locations, locks, members, and occupancy. -## Space management +## Spaces management | Command | Description | | ------- | ----------- | @@ -15,14 +15,14 @@ Use the `ably spaces` command group to interact with Ably Spaces. These commands | [`ably spaces list`](/docs/cli/spaces/list) | List active spaces. | | [`ably spaces subscribe`](/docs/cli/spaces/subscribe) | Subscribe to member and location update events in a space. | -## Cursors +## Members | Command | Description | | ------- | ----------- | -| [`ably spaces cursors`](/docs/cli/spaces/cursors) | Commands for cursor management in Ably Spaces. | -| [`ably spaces cursors get`](/docs/cli/spaces/cursors/get) | Get all current cursors in a space. | -| [`ably spaces cursors set`](/docs/cli/spaces/cursors/set) | Set a cursor with position data in a space. | -| [`ably spaces cursors subscribe`](/docs/cli/spaces/cursors/subscribe) | Subscribe to cursor movements in a space. | +| [`ably spaces members`](/docs/cli/spaces/members) | Commands for managing members in Ably Spaces. | +| [`ably spaces members enter`](/docs/cli/spaces/members/enter) | Enter a space and remain present until terminated. | +| [`ably spaces members get`](/docs/cli/spaces/members/get) | Get all members in a space. | +| [`ably spaces members subscribe`](/docs/cli/spaces/members/subscribe) | Subscribe to member presence events in a space. | ## Locations @@ -33,6 +33,15 @@ Use the `ably spaces` command group to interact with Ably Spaces. These commands | [`ably spaces locations set`](/docs/cli/spaces/locations/set) | Set location in a space. | | [`ably spaces locations subscribe`](/docs/cli/spaces/locations/subscribe) | Subscribe to location updates for members in a space. | +## Cursors + +| Command | Description | +| ------- | ----------- | +| [`ably spaces cursors`](/docs/cli/spaces/cursors) | Commands for cursor management in Ably Spaces. | +| [`ably spaces cursors get`](/docs/cli/spaces/cursors/get) | Get all current cursors in a space. | +| [`ably spaces cursors set`](/docs/cli/spaces/cursors/set) | Set a cursor with position data in a space. | +| [`ably spaces cursors subscribe`](/docs/cli/spaces/cursors/subscribe) | Subscribe to cursor movements in a space. | + ## Locks | Command | Description | @@ -42,15 +51,6 @@ Use the `ably spaces` command group to interact with Ably Spaces. These commands | [`ably spaces locks get`](/docs/cli/spaces/locks/get) | Get a lock or all locks in a space. | | [`ably spaces locks subscribe`](/docs/cli/spaces/locks/subscribe) | Subscribe to lock events in a space. | -## Members - -| Command | Description | -| ------- | ----------- | -| [`ably spaces members`](/docs/cli/spaces/members) | Commands for managing members in Ably Spaces. | -| [`ably spaces members enter`](/docs/cli/spaces/members/enter) | Enter a space and remain present until terminated. | -| [`ably spaces members get`](/docs/cli/spaces/members/get) | Get all members in a space. | -| [`ably spaces members subscribe`](/docs/cli/spaces/members/subscribe) | Subscribe to member presence events in a space. | - ## Occupancy | Command | Description | diff --git a/src/pages/docs/cli/stats/index.mdx b/src/pages/docs/cli/stats/index.mdx index e27744966b..2e18a65a0b 100644 --- a/src/pages/docs/cli/stats/index.mdx +++ b/src/pages/docs/cli/stats/index.mdx @@ -6,11 +6,16 @@ meta_keywords: "ably cli, cli, stats, statistics, account, app, ably stats" Use the `ably stats` command group to view statistics for your Ably account or apps. These commands enable you to retrieve usage metrics and subscribe to live stats updates. -## Subcommands +## Account stats | Command | Description | | ------- | ----------- | | [`ably stats account`](/docs/cli/stats/account) | Get account-level statistics. | + +## App stats + +| Command | Description | +| ------- | ----------- | | [`ably stats app`](/docs/cli/stats/app) | Get app-level statistics. | ## See also From 5c05a16065ff3ae716869fecfc22eefb93499d0c Mon Sep 17 00:00:00 2001 From: sacOO7 Date: Tue, 7 Apr 2026 13:50:18 +0530 Subject: [PATCH 7/9] - Added output format for apps and accounts - Marked `--json` and `--mutable-json` flags as mutually exclusive --- src/pages/docs/cli/accounts/current.mdx | 18 ++++++++++--- src/pages/docs/cli/accounts/list.mdx | 17 +++++++++--- src/pages/docs/cli/accounts/login.mdx | 5 ++-- src/pages/docs/cli/accounts/logout.mdx | 5 ++-- src/pages/docs/cli/accounts/switch.mdx | 5 ++-- src/pages/docs/cli/apps/create.mdx | 5 ++-- src/pages/docs/cli/apps/current.mdx | 5 ++-- src/pages/docs/cli/apps/delete.mdx | 5 ++-- src/pages/docs/cli/apps/list.mdx | 5 ++-- src/pages/docs/cli/apps/rules/create.mdx | 7 +++-- src/pages/docs/cli/apps/rules/delete.mdx | 7 +++-- src/pages/docs/cli/apps/rules/list.mdx | 26 ++++++++++++++++--- src/pages/docs/cli/apps/rules/update.mdx | 7 +++-- src/pages/docs/cli/apps/switch.mdx | 5 ++-- src/pages/docs/cli/apps/update.mdx | 5 ++-- src/pages/docs/cli/auth/issue-ably-token.mdx | 5 ++-- src/pages/docs/cli/auth/issue-jwt-token.mdx | 5 ++-- src/pages/docs/cli/auth/keys/create.mdx | 5 ++-- src/pages/docs/cli/auth/keys/current.mdx | 5 ++-- src/pages/docs/cli/auth/keys/get.mdx | 5 ++-- src/pages/docs/cli/auth/keys/list.mdx | 5 ++-- src/pages/docs/cli/auth/keys/revoke.mdx | 5 ++-- src/pages/docs/cli/auth/keys/switch.mdx | 5 ++-- src/pages/docs/cli/auth/keys/update.mdx | 5 ++-- src/pages/docs/cli/auth/revoke-token.mdx | 5 ++-- src/pages/docs/cli/bench/publisher.mdx | 5 ++-- src/pages/docs/cli/bench/subscriber.mdx | 5 ++-- .../docs/cli/channels/annotations/delete.mdx | 5 ++-- .../docs/cli/channels/annotations/get.mdx | 5 ++-- .../docs/cli/channels/annotations/publish.mdx | 5 ++-- .../cli/channels/annotations/subscribe.mdx | 5 ++-- src/pages/docs/cli/channels/append.mdx | 5 ++-- src/pages/docs/cli/channels/batch-publish.mdx | 5 ++-- src/pages/docs/cli/channels/delete.mdx | 5 ++-- src/pages/docs/cli/channels/history.mdx | 5 ++-- src/pages/docs/cli/channels/inspect.mdx | 5 ++-- src/pages/docs/cli/channels/list.mdx | 5 ++-- src/pages/docs/cli/channels/occupancy/get.mdx | 5 ++-- .../docs/cli/channels/occupancy/subscribe.mdx | 5 ++-- .../docs/cli/channels/presence/enter.mdx | 5 ++-- src/pages/docs/cli/channels/presence/get.mdx | 5 ++-- .../docs/cli/channels/presence/subscribe.mdx | 5 ++-- src/pages/docs/cli/channels/publish.mdx | 5 ++-- src/pages/docs/cli/channels/subscribe.mdx | 5 ++-- src/pages/docs/cli/channels/update.mdx | 5 ++-- src/pages/docs/cli/config/path.mdx | 5 ++-- src/pages/docs/cli/config/show.mdx | 5 ++-- src/pages/docs/cli/connections/test.mdx | 5 ++-- src/pages/docs/cli/index.mdx | 6 ++--- src/pages/docs/cli/integrations/create.mdx | 5 ++-- src/pages/docs/cli/integrations/delete.mdx | 5 ++-- src/pages/docs/cli/integrations/get.mdx | 5 ++-- src/pages/docs/cli/integrations/list.mdx | 5 ++-- src/pages/docs/cli/integrations/update.mdx | 5 ++-- src/pages/docs/cli/interactive.mdx | 5 ++-- src/pages/docs/cli/login.mdx | 5 ++-- .../cli/logs/channel-lifecycle/subscribe.mdx | 5 ++-- .../cli/logs/connection-lifecycle/history.mdx | 5 ++-- .../logs/connection-lifecycle/subscribe.mdx | 5 ++-- src/pages/docs/cli/logs/history.mdx | 5 ++-- src/pages/docs/cli/logs/push/history.mdx | 5 ++-- src/pages/docs/cli/logs/push/subscribe.mdx | 5 ++-- src/pages/docs/cli/logs/subscribe.mdx | 5 ++-- src/pages/docs/cli/push/batch-publish.mdx | 5 ++-- .../docs/cli/push/channels/list-channels.mdx | 5 ++-- src/pages/docs/cli/push/channels/list.mdx | 5 ++-- .../docs/cli/push/channels/remove-where.mdx | 5 ++-- src/pages/docs/cli/push/channels/remove.mdx | 5 ++-- src/pages/docs/cli/push/channels/save.mdx | 5 ++-- src/pages/docs/cli/push/config/clear-apns.mdx | 5 ++-- src/pages/docs/cli/push/config/clear-fcm.mdx | 5 ++-- src/pages/docs/cli/push/config/set-apns.mdx | 5 ++-- src/pages/docs/cli/push/config/set-fcm.mdx | 5 ++-- src/pages/docs/cli/push/config/show.mdx | 5 ++-- src/pages/docs/cli/push/devices/get.mdx | 5 ++-- src/pages/docs/cli/push/devices/list.mdx | 5 ++-- .../docs/cli/push/devices/remove-where.mdx | 5 ++-- src/pages/docs/cli/push/devices/remove.mdx | 5 ++-- src/pages/docs/cli/push/devices/save.mdx | 5 ++-- src/pages/docs/cli/push/publish.mdx | 5 ++-- src/pages/docs/cli/queues/create.mdx | 5 ++-- src/pages/docs/cli/queues/delete.mdx | 5 ++-- src/pages/docs/cli/queues/list.mdx | 5 ++-- src/pages/docs/cli/rooms/list.mdx | 5 ++-- src/pages/docs/cli/rooms/messages/delete.mdx | 5 ++-- src/pages/docs/cli/rooms/messages/history.mdx | 5 ++-- .../cli/rooms/messages/reactions/remove.mdx | 5 ++-- .../cli/rooms/messages/reactions/send.mdx | 5 ++-- .../rooms/messages/reactions/subscribe.mdx | 5 ++-- src/pages/docs/cli/rooms/messages/send.mdx | 5 ++-- .../docs/cli/rooms/messages/subscribe.mdx | 5 ++-- src/pages/docs/cli/rooms/messages/update.mdx | 5 ++-- src/pages/docs/cli/rooms/occupancy/get.mdx | 5 ++-- .../docs/cli/rooms/occupancy/subscribe.mdx | 5 ++-- src/pages/docs/cli/rooms/presence/enter.mdx | 5 ++-- src/pages/docs/cli/rooms/presence/get.mdx | 5 ++-- .../docs/cli/rooms/presence/subscribe.mdx | 5 ++-- src/pages/docs/cli/rooms/reactions/send.mdx | 5 ++-- .../docs/cli/rooms/reactions/subscribe.mdx | 5 ++-- src/pages/docs/cli/rooms/typing/keystroke.mdx | 5 ++-- src/pages/docs/cli/rooms/typing/subscribe.mdx | 5 ++-- src/pages/docs/cli/spaces/create.mdx | 5 ++-- src/pages/docs/cli/spaces/cursors/get.mdx | 5 ++-- src/pages/docs/cli/spaces/cursors/set.mdx | 5 ++-- .../docs/cli/spaces/cursors/subscribe.mdx | 5 ++-- src/pages/docs/cli/spaces/get.mdx | 5 ++-- src/pages/docs/cli/spaces/list.mdx | 5 ++-- src/pages/docs/cli/spaces/locations/get.mdx | 5 ++-- src/pages/docs/cli/spaces/locations/set.mdx | 5 ++-- .../docs/cli/spaces/locations/subscribe.mdx | 5 ++-- src/pages/docs/cli/spaces/locks/acquire.mdx | 5 ++-- src/pages/docs/cli/spaces/locks/get.mdx | 5 ++-- src/pages/docs/cli/spaces/locks/subscribe.mdx | 5 ++-- src/pages/docs/cli/spaces/members/enter.mdx | 5 ++-- src/pages/docs/cli/spaces/members/get.mdx | 5 ++-- .../docs/cli/spaces/members/subscribe.mdx | 5 ++-- src/pages/docs/cli/spaces/occupancy/get.mdx | 5 ++-- .../docs/cli/spaces/occupancy/subscribe.mdx | 5 ++-- src/pages/docs/cli/spaces/subscribe.mdx | 5 ++-- src/pages/docs/cli/stats/account.mdx | 18 ++++++++++--- src/pages/docs/cli/stats/app.mdx | 5 ++-- src/pages/docs/cli/status.mdx | 5 ++-- src/pages/docs/cli/support/ask.mdx | 5 ++-- src/pages/docs/cli/version.mdx | 5 ++-- 124 files changed, 310 insertions(+), 376 deletions(-) diff --git a/src/pages/docs/cli/accounts/current.mdx b/src/pages/docs/cli/accounts/current.mdx index f3217c61cd..0c029ddbcc 100644 --- a/src/pages/docs/cli/accounts/current.mdx +++ b/src/pages/docs/cli/accounts/current.mdx @@ -18,9 +18,8 @@ ably accounts current [flags] The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples @@ -40,6 +39,19 @@ ably accounts current --json ``` +## Output + +The `ably accounts current` command displays: + +| Property | Description | +| -------- | ----------- | +| Account | The account name and ID. | +| User | The email address of the logged-in user. | +| Apps configured | Number of apps configured for this account. | +| Current App | The currently selected app name and ID. | +| Current API Key | The API key being used. | +| Key Label | The label of the current API key. | + ## See also * [Accounts](/docs/cli/accounts) — Explore all `ably accounts` commands. diff --git a/src/pages/docs/cli/accounts/list.mdx b/src/pages/docs/cli/accounts/list.mdx index 83a45979a6..b605b51ce4 100644 --- a/src/pages/docs/cli/accounts/list.mdx +++ b/src/pages/docs/cli/accounts/list.mdx @@ -18,9 +18,8 @@ ably accounts list [flags] The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples @@ -40,6 +39,18 @@ ably accounts list --json ``` +## Output + +The `ably accounts list` command displays list of accounts in format: + +| Property | Description | +| -------- | ----------- | +| Account | The account name and ID. | +| Name | The alias name of the account, if one is configured. | +| User | The email address of the logged-in user. | +| Apps | Number of apps configured for this account. | +| Current App | The currently selected app name and ID. | + ## See also * [Accounts](/docs/cli/accounts) — Explore all `ably accounts` commands. diff --git a/src/pages/docs/cli/accounts/login.mdx b/src/pages/docs/cli/accounts/login.mdx index 54b784d633..628e6ea72c 100644 --- a/src/pages/docs/cli/accounts/login.mdx +++ b/src/pages/docs/cli/accounts/login.mdx @@ -36,9 +36,8 @@ Prevent the CLI from automatically opening a browser window for authentication. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/accounts/logout.mdx b/src/pages/docs/cli/accounts/logout.mdx index 3f33164d09..229bca2c74 100644 --- a/src/pages/docs/cli/accounts/logout.mdx +++ b/src/pages/docs/cli/accounts/logout.mdx @@ -32,9 +32,8 @@ Skip the confirmation prompt and log out immediately. Required when using `--jso The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/accounts/switch.mdx b/src/pages/docs/cli/accounts/switch.mdx index 9bbe383fc4..8aa5f58a5a 100644 --- a/src/pages/docs/cli/accounts/switch.mdx +++ b/src/pages/docs/cli/accounts/switch.mdx @@ -24,9 +24,8 @@ An optional account alias to switch to. If not provided, the CLI displays an int The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/apps/create.mdx b/src/pages/docs/cli/apps/create.mdx index db8137ad14..d9cd2bbc15 100644 --- a/src/pages/docs/cli/apps/create.mdx +++ b/src/pages/docs/cli/apps/create.mdx @@ -28,9 +28,8 @@ Restrict the application to TLS connections only. When enabled, all connections The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/apps/current.mdx b/src/pages/docs/cli/apps/current.mdx index 4f59d825fc..30a5566b6f 100644 --- a/src/pages/docs/cli/apps/current.mdx +++ b/src/pages/docs/cli/apps/current.mdx @@ -16,9 +16,8 @@ Use the `ably apps current` command to display information about the currently s The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/apps/delete.mdx b/src/pages/docs/cli/apps/delete.mdx index 2e7b6b7e3b..6d1ea4827b 100644 --- a/src/pages/docs/cli/apps/delete.mdx +++ b/src/pages/docs/cli/apps/delete.mdx @@ -40,9 +40,8 @@ Skip the confirmation prompt and delete the application immediately. Required wh The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/apps/list.mdx b/src/pages/docs/cli/apps/list.mdx index 6be761b709..1f3a000560 100644 --- a/src/pages/docs/cli/apps/list.mdx +++ b/src/pages/docs/cli/apps/list.mdx @@ -24,9 +24,8 @@ The maximum number of results to return. Defaults to `100`. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/apps/rules/create.mdx b/src/pages/docs/cli/apps/rules/create.mdx index efad603d10..683a77e363 100644 --- a/src/pages/docs/cli/apps/rules/create.mdx +++ b/src/pages/docs/cli/apps/rules/create.mdx @@ -10,7 +10,7 @@ ably apps rules create --name [flags] ``` -Use the `ably apps rules create` command to create a new channel rule for an Ably application. Channel rules define behavior for channels matching a specific namespace. +Use the `ably apps rules create` command to create a new [channel rule](/docs/channels/channel-rules-namespaces) for an Ably application. Channel rules define behavior for channels matching a specific namespace. ## Flags @@ -76,9 +76,8 @@ The conflation key for matching channels. Only applicable when `--conflation-ena The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/apps/rules/delete.mdx b/src/pages/docs/cli/apps/rules/delete.mdx index 0ab9e7e7f5..25e1576836 100644 --- a/src/pages/docs/cli/apps/rules/delete.mdx +++ b/src/pages/docs/cli/apps/rules/delete.mdx @@ -10,7 +10,7 @@ ably apps rules delete [flags] ``` -Use the `ably apps rules delete` command to delete a channel rule from an Ably application. +Use the `ably apps rules delete` command to delete a [channel rule](/docs/channels/channel-rules-namespaces) from an Ably application. ## Arguments @@ -36,9 +36,8 @@ Skip the confirmation prompt and delete the rule immediately. Required when usin The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/apps/rules/list.mdx b/src/pages/docs/cli/apps/rules/list.mdx index 9e551634d6..fc23643680 100644 --- a/src/pages/docs/cli/apps/rules/list.mdx +++ b/src/pages/docs/cli/apps/rules/list.mdx @@ -10,7 +10,7 @@ ably apps rules list [flags] ``` -Use the `ably apps rules list` command to list all channel rules configured for an Ably application. +Use the `ably apps rules list` command to list all [channel rules](/docs/channels/channel-rules-namespaces) configured for an Ably application. ## Flags @@ -28,9 +28,8 @@ The maximum number of results to return. Defaults to `100`. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples @@ -50,6 +49,25 @@ ably apps rules list --app aBcDe1 ``` +## Output + +The `ably apps channel-rules list` command displays: + +| Property | Description | +| -------- | ----------- | +| **Rule Count** | Total number of channel rules found | +| **Channel Rule ID** | The unique identifier for each rule | +| **Persisted** | Whether messages are persisted for channels matching this rule | +| **Push Enabled** | Whether push notifications are enabled | +| **Authenticated** | Whether clients must be authenticated | +| **Persist Last Message** | Whether only the last message is persisted | +| **Populate Channel Registry** | Whether to populate the channel registry | +| **Batching Enabled** | Whether message batching is enabled | +| **Conflation Enabled** | Whether message conflation is enabled | +| **TLS Only** | Whether TLS is enforced | +| **Created** | When the rule was created | +| **Updated** | When the rule was last updated | + ## See also * [Apps rules](/docs/cli/apps/rules) — Explore all `ably apps rules` commands. diff --git a/src/pages/docs/cli/apps/rules/update.mdx b/src/pages/docs/cli/apps/rules/update.mdx index 31bfbd73e6..9bfa58fbe1 100644 --- a/src/pages/docs/cli/apps/rules/update.mdx +++ b/src/pages/docs/cli/apps/rules/update.mdx @@ -10,7 +10,7 @@ ably apps rules update [flags] ``` -Use the `ably apps rules update` command to update an existing channel rule for an Ably application. +Use the `ably apps rules update` command to update an existing a [channel rule](/docs/channels/channel-rules-namespaces) for an Ably application. ## Arguments @@ -84,9 +84,8 @@ The conflation key for matching channels. Only applicable when `--conflation-ena The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/apps/switch.mdx b/src/pages/docs/cli/apps/switch.mdx index 28e5e7f1b5..42784e379b 100644 --- a/src/pages/docs/cli/apps/switch.mdx +++ b/src/pages/docs/cli/apps/switch.mdx @@ -24,9 +24,8 @@ The ID of the application to switch to. If not specified, the CLI will display a The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/apps/update.mdx b/src/pages/docs/cli/apps/update.mdx index 2f23cd11b1..f31f178bf7 100644 --- a/src/pages/docs/cli/apps/update.mdx +++ b/src/pages/docs/cli/apps/update.mdx @@ -36,9 +36,8 @@ Restrict the application to TLS connections only. When enabled, all connections The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/auth/issue-ably-token.mdx b/src/pages/docs/cli/auth/issue-ably-token.mdx index b06246a951..26918e0509 100644 --- a/src/pages/docs/cli/auth/issue-ably-token.mdx +++ b/src/pages/docs/cli/auth/issue-ably-token.mdx @@ -42,9 +42,8 @@ Output only the token string, without any additional information. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/auth/issue-jwt-token.mdx b/src/pages/docs/cli/auth/issue-jwt-token.mdx index 061f2d01d0..49fca42428 100644 --- a/src/pages/docs/cli/auth/issue-jwt-token.mdx +++ b/src/pages/docs/cli/auth/issue-jwt-token.mdx @@ -42,9 +42,8 @@ Output only the token string, without any additional information. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/auth/keys/create.mdx b/src/pages/docs/cli/auth/keys/create.mdx index 1e9515c9a3..3232021ed1 100644 --- a/src/pages/docs/cli/auth/keys/create.mdx +++ b/src/pages/docs/cli/auth/keys/create.mdx @@ -34,9 +34,8 @@ A JSON string specifying the [capabilities](/docs/auth/capabilities) for the key The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/auth/keys/current.mdx b/src/pages/docs/cli/auth/keys/current.mdx index 6137eb25d0..3352227f31 100644 --- a/src/pages/docs/cli/auth/keys/current.mdx +++ b/src/pages/docs/cli/auth/keys/current.mdx @@ -26,9 +26,8 @@ The app ID to show the current key for. Uses the currently selected app if not s The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/auth/keys/get.mdx b/src/pages/docs/cli/auth/keys/get.mdx index 77595bae8a..00ca405e10 100644 --- a/src/pages/docs/cli/auth/keys/get.mdx +++ b/src/pages/docs/cli/auth/keys/get.mdx @@ -34,9 +34,8 @@ The app ID the key belongs to. Uses the currently selected app if not specified. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/auth/keys/list.mdx b/src/pages/docs/cli/auth/keys/list.mdx index b898caa803..3656812d72 100644 --- a/src/pages/docs/cli/auth/keys/list.mdx +++ b/src/pages/docs/cli/auth/keys/list.mdx @@ -30,9 +30,8 @@ The maximum number of keys to return. Defaults to `100`. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/auth/keys/revoke.mdx b/src/pages/docs/cli/auth/keys/revoke.mdx index 0077474f62..cc014b3dfe 100644 --- a/src/pages/docs/cli/auth/keys/revoke.mdx +++ b/src/pages/docs/cli/auth/keys/revoke.mdx @@ -38,9 +38,8 @@ Skip the confirmation prompt and revoke the key immediately. Required when using The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/auth/keys/switch.mdx b/src/pages/docs/cli/auth/keys/switch.mdx index 8e7c0bffcd..cc93810d2e 100644 --- a/src/pages/docs/cli/auth/keys/switch.mdx +++ b/src/pages/docs/cli/auth/keys/switch.mdx @@ -32,9 +32,8 @@ The app ID to switch keys for. Uses the currently selected app if not specified. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/auth/keys/update.mdx b/src/pages/docs/cli/auth/keys/update.mdx index 598261c489..a8db3d7a98 100644 --- a/src/pages/docs/cli/auth/keys/update.mdx +++ b/src/pages/docs/cli/auth/keys/update.mdx @@ -42,9 +42,8 @@ A comma-separated list of new [capabilities](/docs/auth/capabilities) for the ke The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/auth/revoke-token.mdx b/src/pages/docs/cli/auth/revoke-token.mdx index 94480973a7..0b535a30e4 100644 --- a/src/pages/docs/cli/auth/revoke-token.mdx +++ b/src/pages/docs/cli/auth/revoke-token.mdx @@ -38,9 +38,8 @@ The client ID to revoke tokens for. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/bench/publisher.mdx b/src/pages/docs/cli/bench/publisher.mdx index 4f9b90c7bd..a0d11a58e4 100644 --- a/src/pages/docs/cli/bench/publisher.mdx +++ b/src/pages/docs/cli/bench/publisher.mdx @@ -52,9 +52,8 @@ The client ID to use for the benchmark. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/bench/subscriber.mdx b/src/pages/docs/cli/bench/subscriber.mdx index 0180fe951c..30cd48877c 100644 --- a/src/pages/docs/cli/bench/subscriber.mdx +++ b/src/pages/docs/cli/bench/subscriber.mdx @@ -36,9 +36,8 @@ The client ID to use for the benchmark. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/channels/annotations/delete.mdx b/src/pages/docs/cli/channels/annotations/delete.mdx index 3c18990b2f..a2cb88847a 100644 --- a/src/pages/docs/cli/channels/annotations/delete.mdx +++ b/src/pages/docs/cli/channels/annotations/delete.mdx @@ -44,9 +44,8 @@ A client ID to use when deleting the annotation. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/channels/annotations/get.mdx b/src/pages/docs/cli/channels/annotations/get.mdx index 27e17320e1..90b05ec396 100644 --- a/src/pages/docs/cli/channels/annotations/get.mdx +++ b/src/pages/docs/cli/channels/annotations/get.mdx @@ -36,9 +36,8 @@ The maximum number of annotations to return. Defaults to `100`. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/channels/annotations/publish.mdx b/src/pages/docs/cli/channels/annotations/publish.mdx index d88af16115..159d05e435 100644 --- a/src/pages/docs/cli/channels/annotations/publish.mdx +++ b/src/pages/docs/cli/channels/annotations/publish.mdx @@ -56,9 +56,8 @@ A client ID to use when publishing the annotation. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/channels/annotations/subscribe.mdx b/src/pages/docs/cli/channels/annotations/subscribe.mdx index f9ff69de4a..2ddc367585 100644 --- a/src/pages/docs/cli/channels/annotations/subscribe.mdx +++ b/src/pages/docs/cli/channels/annotations/subscribe.mdx @@ -44,9 +44,8 @@ A client ID to use when subscribing. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/channels/append.mdx b/src/pages/docs/cli/channels/append.mdx index 6d2778cfce..3210cb1798 100644 --- a/src/pages/docs/cli/channels/append.mdx +++ b/src/pages/docs/cli/channels/append.mdx @@ -52,9 +52,8 @@ A client ID to use when appending the message. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/channels/batch-publish.mdx b/src/pages/docs/cli/channels/batch-publish.mdx index 48e9ed4600..fdc0e11202 100644 --- a/src/pages/docs/cli/channels/batch-publish.mdx +++ b/src/pages/docs/cli/channels/batch-publish.mdx @@ -48,9 +48,8 @@ The event name for the message. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/channels/delete.mdx b/src/pages/docs/cli/channels/delete.mdx index 6cf18bf566..315558bf1e 100644 --- a/src/pages/docs/cli/channels/delete.mdx +++ b/src/pages/docs/cli/channels/delete.mdx @@ -40,9 +40,8 @@ A client ID to use when deleting the message. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/channels/history.mdx b/src/pages/docs/cli/channels/history.mdx index 0503b421c8..f7c44aae86 100644 --- a/src/pages/docs/cli/channels/history.mdx +++ b/src/pages/docs/cli/channels/history.mdx @@ -48,9 +48,8 @@ The maximum number of messages to retrieve. Defaults to `50`. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/channels/inspect.mdx b/src/pages/docs/cli/channels/inspect.mdx index ec7d94391b..389aa417be 100644 --- a/src/pages/docs/cli/channels/inspect.mdx +++ b/src/pages/docs/cli/channels/inspect.mdx @@ -32,9 +32,8 @@ The app ID or name to inspect the channel for. Overrides the currently selected The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/channels/list.mdx b/src/pages/docs/cli/channels/list.mdx index faa7c33237..75e91bca6d 100644 --- a/src/pages/docs/cli/channels/list.mdx +++ b/src/pages/docs/cli/channels/list.mdx @@ -28,9 +28,8 @@ Filter channels by a name prefix. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/channels/occupancy/get.mdx b/src/pages/docs/cli/channels/occupancy/get.mdx index d35ef298c4..556598a25e 100644 --- a/src/pages/docs/cli/channels/occupancy/get.mdx +++ b/src/pages/docs/cli/channels/occupancy/get.mdx @@ -28,9 +28,8 @@ You can optionally pass the following flags to the `ably channels occupancy get` The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/channels/occupancy/subscribe.mdx b/src/pages/docs/cli/channels/occupancy/subscribe.mdx index e3de2fd983..a514483ea4 100644 --- a/src/pages/docs/cli/channels/occupancy/subscribe.mdx +++ b/src/pages/docs/cli/channels/occupancy/subscribe.mdx @@ -36,9 +36,8 @@ A client ID to use when subscribing. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/channels/presence/enter.mdx b/src/pages/docs/cli/channels/presence/enter.mdx index d4edc1d3e7..a13e170cb5 100644 --- a/src/pages/docs/cli/channels/presence/enter.mdx +++ b/src/pages/docs/cli/channels/presence/enter.mdx @@ -48,9 +48,8 @@ A client ID to use when entering presence. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/channels/presence/get.mdx b/src/pages/docs/cli/channels/presence/get.mdx index caa15461af..8e1c98f5de 100644 --- a/src/pages/docs/cli/channels/presence/get.mdx +++ b/src/pages/docs/cli/channels/presence/get.mdx @@ -32,9 +32,8 @@ The maximum number of presence members to return. Defaults to `100`. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/channels/presence/subscribe.mdx b/src/pages/docs/cli/channels/presence/subscribe.mdx index ff6f224c16..9b8a41b89d 100644 --- a/src/pages/docs/cli/channels/presence/subscribe.mdx +++ b/src/pages/docs/cli/channels/presence/subscribe.mdx @@ -36,9 +36,8 @@ A client ID to use when subscribing. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/channels/publish.mdx b/src/pages/docs/cli/channels/publish.mdx index 716ca45197..886087babc 100644 --- a/src/pages/docs/cli/channels/publish.mdx +++ b/src/pages/docs/cli/channels/publish.mdx @@ -56,9 +56,8 @@ A client ID to use when publishing the message. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/channels/subscribe.mdx b/src/pages/docs/cli/channels/subscribe.mdx index 44ecb61db3..51bfcc671b 100644 --- a/src/pages/docs/cli/channels/subscribe.mdx +++ b/src/pages/docs/cli/channels/subscribe.mdx @@ -52,9 +52,8 @@ A client ID to use when subscribing. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/channels/update.mdx b/src/pages/docs/cli/channels/update.mdx index 2bd6513752..84ead1fdcb 100644 --- a/src/pages/docs/cli/channels/update.mdx +++ b/src/pages/docs/cli/channels/update.mdx @@ -52,9 +52,8 @@ A client ID to use when updating the message. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/config/path.mdx b/src/pages/docs/cli/config/path.mdx index 0594583a20..aa7bc2003c 100644 --- a/src/pages/docs/cli/config/path.mdx +++ b/src/pages/docs/cli/config/path.mdx @@ -16,9 +16,8 @@ Use the `ably config path` command to print the path to the Ably CLI config file The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/config/show.mdx b/src/pages/docs/cli/config/show.mdx index 31108e3fd2..8fe03d1d4c 100644 --- a/src/pages/docs/cli/config/show.mdx +++ b/src/pages/docs/cli/config/show.mdx @@ -16,9 +16,8 @@ Use the `ably config show` command to display the contents of the Ably CLI confi The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/connections/test.mdx b/src/pages/docs/cli/connections/test.mdx index 290429f86e..21712846e0 100644 --- a/src/pages/docs/cli/connections/test.mdx +++ b/src/pages/docs/cli/connections/test.mdx @@ -28,9 +28,8 @@ The client ID to use for the connection test. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/index.mdx b/src/pages/docs/cli/index.mdx index 66608954c8..df20b49fd4 100644 --- a/src/pages/docs/cli/index.mdx +++ b/src/pages/docs/cli/index.mdx @@ -14,15 +14,15 @@ The following global flags are available on most CLI commands: ### `--json` -Output results in JSON format. +Output results in JSON format. Mutually exclusive with `--pretty-json`. ### `--pretty-json` -Output results in colorized JSON format. +Output results in colorized JSON format. Mutually exclusive with `--json`. ### `--verbose | -v` -Enable verbose logging. +Enable verbose logging. Can be combined with `--json` or `--pretty-json`. ## Commands diff --git a/src/pages/docs/cli/integrations/create.mdx b/src/pages/docs/cli/integrations/create.mdx index e3a62ad370..b7fcc92fa8 100644 --- a/src/pages/docs/cli/integrations/create.mdx +++ b/src/pages/docs/cli/integrations/create.mdx @@ -48,9 +48,8 @@ The initial status of the integration rule. Valid options are `enabled` or `disa The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/integrations/delete.mdx b/src/pages/docs/cli/integrations/delete.mdx index 7d5320d285..a3dd98cf3e 100644 --- a/src/pages/docs/cli/integrations/delete.mdx +++ b/src/pages/docs/cli/integrations/delete.mdx @@ -36,9 +36,8 @@ Skip the confirmation prompt and delete the integration rule immediately. Requir The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/integrations/get.mdx b/src/pages/docs/cli/integrations/get.mdx index 849b8c9c48..70d90547b5 100644 --- a/src/pages/docs/cli/integrations/get.mdx +++ b/src/pages/docs/cli/integrations/get.mdx @@ -32,9 +32,8 @@ The app ID that the integration rule belongs to. If not specified, the currently The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/integrations/list.mdx b/src/pages/docs/cli/integrations/list.mdx index cf0662b6e8..4ad5982451 100644 --- a/src/pages/docs/cli/integrations/list.mdx +++ b/src/pages/docs/cli/integrations/list.mdx @@ -28,9 +28,8 @@ The maximum number of integration rules to return. The default value is `100`. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/integrations/update.mdx b/src/pages/docs/cli/integrations/update.mdx index 20951133d7..53613b63ce 100644 --- a/src/pages/docs/cli/integrations/update.mdx +++ b/src/pages/docs/cli/integrations/update.mdx @@ -56,9 +56,8 @@ Update the target URL for the integration rule. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/interactive.mdx b/src/pages/docs/cli/interactive.mdx index 35db4c4f3b..0bf7e9d2f3 100644 --- a/src/pages/docs/cli/interactive.mdx +++ b/src/pages/docs/cli/interactive.mdx @@ -20,9 +20,8 @@ This feature is in ALPHA and may change in future releases. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/login.mdx b/src/pages/docs/cli/login.mdx index 8b66198817..893e274b4b 100644 --- a/src/pages/docs/cli/login.mdx +++ b/src/pages/docs/cli/login.mdx @@ -42,9 +42,8 @@ Prevent the CLI from automatically opening a browser for authentication. Use thi The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/logs/channel-lifecycle/subscribe.mdx b/src/pages/docs/cli/logs/channel-lifecycle/subscribe.mdx index 3b205c4ecd..0fb016072f 100644 --- a/src/pages/docs/cli/logs/channel-lifecycle/subscribe.mdx +++ b/src/pages/docs/cli/logs/channel-lifecycle/subscribe.mdx @@ -32,9 +32,8 @@ A client ID to use when subscribing. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/logs/connection-lifecycle/history.mdx b/src/pages/docs/cli/logs/connection-lifecycle/history.mdx index 7211f7b773..8d928d0c02 100644 --- a/src/pages/docs/cli/logs/connection-lifecycle/history.mdx +++ b/src/pages/docs/cli/logs/connection-lifecycle/history.mdx @@ -36,9 +36,8 @@ The end of the time range to retrieve logs from. Accepts ISO 8601, Unix millisec The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/logs/connection-lifecycle/subscribe.mdx b/src/pages/docs/cli/logs/connection-lifecycle/subscribe.mdx index 0c30d589ff..82e7e0b89c 100644 --- a/src/pages/docs/cli/logs/connection-lifecycle/subscribe.mdx +++ b/src/pages/docs/cli/logs/connection-lifecycle/subscribe.mdx @@ -32,9 +32,8 @@ A client ID to use when subscribing. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/logs/history.mdx b/src/pages/docs/cli/logs/history.mdx index 0a47542b82..9c869528fc 100644 --- a/src/pages/docs/cli/logs/history.mdx +++ b/src/pages/docs/cli/logs/history.mdx @@ -36,9 +36,8 @@ The end of the time range to retrieve logs from. Accepts ISO 8601, Unix millisec The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/logs/push/history.mdx b/src/pages/docs/cli/logs/push/history.mdx index d060fae657..f980325e2b 100644 --- a/src/pages/docs/cli/logs/push/history.mdx +++ b/src/pages/docs/cli/logs/push/history.mdx @@ -36,9 +36,8 @@ The end of the time range to retrieve logs from. Accepts ISO 8601, Unix millisec The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/logs/push/subscribe.mdx b/src/pages/docs/cli/logs/push/subscribe.mdx index 771ad0561d..f6cede6bfb 100644 --- a/src/pages/docs/cli/logs/push/subscribe.mdx +++ b/src/pages/docs/cli/logs/push/subscribe.mdx @@ -32,9 +32,8 @@ A client ID to use when subscribing. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/logs/subscribe.mdx b/src/pages/docs/cli/logs/subscribe.mdx index 5d7126e6c0..ad8ca10e48 100644 --- a/src/pages/docs/cli/logs/subscribe.mdx +++ b/src/pages/docs/cli/logs/subscribe.mdx @@ -36,9 +36,8 @@ A client ID to use when subscribing. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/push/batch-publish.mdx b/src/pages/docs/cli/push/batch-publish.mdx index 68aa77655e..1313a4e0e7 100644 --- a/src/pages/docs/cli/push/batch-publish.mdx +++ b/src/pages/docs/cli/push/batch-publish.mdx @@ -32,9 +32,8 @@ Skip confirmation when publishing to channels. Required when using `--json`. The The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/push/channels/list-channels.mdx b/src/pages/docs/cli/push/channels/list-channels.mdx index d9aa2af74e..5be5dcea35 100644 --- a/src/pages/docs/cli/push/channels/list-channels.mdx +++ b/src/pages/docs/cli/push/channels/list-channels.mdx @@ -24,9 +24,8 @@ The maximum number of channels to retrieve. Defaults to `100`. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/push/channels/list.mdx b/src/pages/docs/cli/push/channels/list.mdx index 41fb63a5b8..ccd375f118 100644 --- a/src/pages/docs/cli/push/channels/list.mdx +++ b/src/pages/docs/cli/push/channels/list.mdx @@ -36,9 +36,8 @@ The maximum number of subscriptions to retrieve. Defaults to `100`. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/push/channels/remove-where.mdx b/src/pages/docs/cli/push/channels/remove-where.mdx index 525d4ee1ad..7fc507101e 100644 --- a/src/pages/docs/cli/push/channels/remove-where.mdx +++ b/src/pages/docs/cli/push/channels/remove-where.mdx @@ -36,9 +36,8 @@ Skip confirmation prompt. Required when using `--json`. The default is `false`. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/push/channels/remove.mdx b/src/pages/docs/cli/push/channels/remove.mdx index b95d827139..2b00c405e2 100644 --- a/src/pages/docs/cli/push/channels/remove.mdx +++ b/src/pages/docs/cli/push/channels/remove.mdx @@ -36,9 +36,8 @@ Skip confirmation prompt. Required when using `--json`. The default is `false`. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/push/channels/save.mdx b/src/pages/docs/cli/push/channels/save.mdx index fd3ce18ab0..de51fc3163 100644 --- a/src/pages/docs/cli/push/channels/save.mdx +++ b/src/pages/docs/cli/push/channels/save.mdx @@ -32,9 +32,8 @@ The client ID to subscribe. Exclusive with `--device-id`. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/push/config/clear-apns.mdx b/src/pages/docs/cli/push/config/clear-apns.mdx index 21c3f1b4c2..e3f9c7b50e 100644 --- a/src/pages/docs/cli/push/config/clear-apns.mdx +++ b/src/pages/docs/cli/push/config/clear-apns.mdx @@ -28,9 +28,8 @@ Skip confirmation prompt. Required when using `--json`. The default is `false`. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/push/config/clear-fcm.mdx b/src/pages/docs/cli/push/config/clear-fcm.mdx index ddbab10744..420dfe8cf3 100644 --- a/src/pages/docs/cli/push/config/clear-fcm.mdx +++ b/src/pages/docs/cli/push/config/clear-fcm.mdx @@ -28,9 +28,8 @@ Skip confirmation prompt. Required when using `--json`. The default is `false`. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/push/config/set-apns.mdx b/src/pages/docs/cli/push/config/set-apns.mdx index 502cdd9778..de78d59d1d 100644 --- a/src/pages/docs/cli/push/config/set-apns.mdx +++ b/src/pages/docs/cli/push/config/set-apns.mdx @@ -52,9 +52,8 @@ The bundle ID for the app. Required when using `--key-file`. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/push/config/set-fcm.mdx b/src/pages/docs/cli/push/config/set-fcm.mdx index c7c025c9a1..7170a9cb1a 100644 --- a/src/pages/docs/cli/push/config/set-fcm.mdx +++ b/src/pages/docs/cli/push/config/set-fcm.mdx @@ -28,9 +28,8 @@ The path to the FCM service account JSON file. Required. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/push/config/show.mdx b/src/pages/docs/cli/push/config/show.mdx index c916099902..8c072a4d63 100644 --- a/src/pages/docs/cli/push/config/show.mdx +++ b/src/pages/docs/cli/push/config/show.mdx @@ -24,9 +24,8 @@ The app ID to show configuration for. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/push/devices/get.mdx b/src/pages/docs/cli/push/devices/get.mdx index 30a6bf5d3e..0a92e76493 100644 --- a/src/pages/docs/cli/push/devices/get.mdx +++ b/src/pages/docs/cli/push/devices/get.mdx @@ -24,9 +24,8 @@ The ID of the device to retrieve details for. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/push/devices/list.mdx b/src/pages/docs/cli/push/devices/list.mdx index 9b1243c5b7..70ae5a4147 100644 --- a/src/pages/docs/cli/push/devices/list.mdx +++ b/src/pages/docs/cli/push/devices/list.mdx @@ -36,9 +36,8 @@ The maximum number of registrations to retrieve. Defaults to `100`. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/push/devices/remove-where.mdx b/src/pages/docs/cli/push/devices/remove-where.mdx index 0e07ce5567..2a5bb634f0 100644 --- a/src/pages/docs/cli/push/devices/remove-where.mdx +++ b/src/pages/docs/cli/push/devices/remove-where.mdx @@ -32,9 +32,8 @@ Skip confirmation prompt. Required when using `--json`. The default is `false`. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/push/devices/remove.mdx b/src/pages/docs/cli/push/devices/remove.mdx index 404fb00d41..0bbd8c40f7 100644 --- a/src/pages/docs/cli/push/devices/remove.mdx +++ b/src/pages/docs/cli/push/devices/remove.mdx @@ -32,9 +32,8 @@ Skip confirmation prompt. Required when using `--json`. The default is `false`. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/push/devices/save.mdx b/src/pages/docs/cli/push/devices/save.mdx index 3c6ebd54eb..6c0f967da6 100644 --- a/src/pages/docs/cli/push/devices/save.mdx +++ b/src/pages/docs/cli/push/devices/save.mdx @@ -64,9 +64,8 @@ Full device registration JSON, or a file path prefixed with `@`. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/push/publish.mdx b/src/pages/docs/cli/push/publish.mdx index 4346c2d825..dca3a51636 100644 --- a/src/pages/docs/cli/push/publish.mdx +++ b/src/pages/docs/cli/push/publish.mdx @@ -88,9 +88,8 @@ Skip confirmation prompt. Required when using `--json`. The default is `false`. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/queues/create.mdx b/src/pages/docs/cli/queues/create.mdx index 047abcd6b1..9cebd82edf 100644 --- a/src/pages/docs/cli/queues/create.mdx +++ b/src/pages/docs/cli/queues/create.mdx @@ -40,9 +40,8 @@ The time-to-live for messages in the queue, in seconds. The default value is `60 The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/queues/delete.mdx b/src/pages/docs/cli/queues/delete.mdx index a69c977cd0..f2ab41e8e0 100644 --- a/src/pages/docs/cli/queues/delete.mdx +++ b/src/pages/docs/cli/queues/delete.mdx @@ -36,9 +36,8 @@ Skip the confirmation prompt and delete the queue immediately. Required when usi The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/queues/list.mdx b/src/pages/docs/cli/queues/list.mdx index a103648ca2..08e10bf5b8 100644 --- a/src/pages/docs/cli/queues/list.mdx +++ b/src/pages/docs/cli/queues/list.mdx @@ -28,9 +28,8 @@ The maximum number of queues to return. The default value is `100`. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/rooms/list.mdx b/src/pages/docs/cli/rooms/list.mdx index e8b6357da0..9495e20e20 100644 --- a/src/pages/docs/cli/rooms/list.mdx +++ b/src/pages/docs/cli/rooms/list.mdx @@ -28,9 +28,8 @@ Filter rooms by a name prefix. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/rooms/messages/delete.mdx b/src/pages/docs/cli/rooms/messages/delete.mdx index bb1c316fac..5fbead78f6 100644 --- a/src/pages/docs/cli/rooms/messages/delete.mdx +++ b/src/pages/docs/cli/rooms/messages/delete.mdx @@ -40,9 +40,8 @@ A client ID to use when deleting the message. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/rooms/messages/history.mdx b/src/pages/docs/cli/rooms/messages/history.mdx index 8f47620953..9b02cf1c04 100644 --- a/src/pages/docs/cli/rooms/messages/history.mdx +++ b/src/pages/docs/cli/rooms/messages/history.mdx @@ -48,9 +48,8 @@ The end of the time range to query. Accepts ISO 8601, Unix timestamp, or relativ The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/rooms/messages/reactions/remove.mdx b/src/pages/docs/cli/rooms/messages/reactions/remove.mdx index 790ab3c833..6d77400ee6 100644 --- a/src/pages/docs/cli/rooms/messages/reactions/remove.mdx +++ b/src/pages/docs/cli/rooms/messages/reactions/remove.mdx @@ -44,9 +44,8 @@ A client ID to use when removing the reaction. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/rooms/messages/reactions/send.mdx b/src/pages/docs/cli/rooms/messages/reactions/send.mdx index f43c26062b..44a6f33a99 100644 --- a/src/pages/docs/cli/rooms/messages/reactions/send.mdx +++ b/src/pages/docs/cli/rooms/messages/reactions/send.mdx @@ -48,9 +48,8 @@ A client ID to use when sending the reaction. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/rooms/messages/reactions/subscribe.mdx b/src/pages/docs/cli/rooms/messages/reactions/subscribe.mdx index af087790ff..21048652d4 100644 --- a/src/pages/docs/cli/rooms/messages/reactions/subscribe.mdx +++ b/src/pages/docs/cli/rooms/messages/reactions/subscribe.mdx @@ -40,9 +40,8 @@ A client ID to use for the subscription. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/rooms/messages/send.mdx b/src/pages/docs/cli/rooms/messages/send.mdx index 432499299c..085a25f382 100644 --- a/src/pages/docs/cli/rooms/messages/send.mdx +++ b/src/pages/docs/cli/rooms/messages/send.mdx @@ -52,9 +52,8 @@ A client ID to use when sending the message. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/rooms/messages/subscribe.mdx b/src/pages/docs/cli/rooms/messages/subscribe.mdx index dddec19397..860c1531b5 100644 --- a/src/pages/docs/cli/rooms/messages/subscribe.mdx +++ b/src/pages/docs/cli/rooms/messages/subscribe.mdx @@ -44,9 +44,8 @@ A client ID to use for the subscription. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/rooms/messages/update.mdx b/src/pages/docs/cli/rooms/messages/update.mdx index fef3790f75..657d6d6a24 100644 --- a/src/pages/docs/cli/rooms/messages/update.mdx +++ b/src/pages/docs/cli/rooms/messages/update.mdx @@ -52,9 +52,8 @@ A client ID to use when updating the message. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/rooms/occupancy/get.mdx b/src/pages/docs/cli/rooms/occupancy/get.mdx index 29882dd2fa..ea0a8931d0 100644 --- a/src/pages/docs/cli/rooms/occupancy/get.mdx +++ b/src/pages/docs/cli/rooms/occupancy/get.mdx @@ -28,9 +28,8 @@ You can optionally pass the following flags to the `ably rooms occupancy get` co The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/rooms/occupancy/subscribe.mdx b/src/pages/docs/cli/rooms/occupancy/subscribe.mdx index a1f762b541..ba575e89d7 100644 --- a/src/pages/docs/cli/rooms/occupancy/subscribe.mdx +++ b/src/pages/docs/cli/rooms/occupancy/subscribe.mdx @@ -36,9 +36,8 @@ A client ID to use for the subscription. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/rooms/presence/enter.mdx b/src/pages/docs/cli/rooms/presence/enter.mdx index 4c9041872d..da24bd3bd7 100644 --- a/src/pages/docs/cli/rooms/presence/enter.mdx +++ b/src/pages/docs/cli/rooms/presence/enter.mdx @@ -48,9 +48,8 @@ A client ID to use when entering presence. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/rooms/presence/get.mdx b/src/pages/docs/cli/rooms/presence/get.mdx index c2270771ee..52a482fe1c 100644 --- a/src/pages/docs/cli/rooms/presence/get.mdx +++ b/src/pages/docs/cli/rooms/presence/get.mdx @@ -32,9 +32,8 @@ The maximum number of presence members to return. Defaults to `100`. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/rooms/presence/subscribe.mdx b/src/pages/docs/cli/rooms/presence/subscribe.mdx index 14c7952e59..8f16d3e034 100644 --- a/src/pages/docs/cli/rooms/presence/subscribe.mdx +++ b/src/pages/docs/cli/rooms/presence/subscribe.mdx @@ -36,9 +36,8 @@ A client ID to use for the subscription. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/rooms/reactions/send.mdx b/src/pages/docs/cli/rooms/reactions/send.mdx index 7da43d15fb..c863cc513c 100644 --- a/src/pages/docs/cli/rooms/reactions/send.mdx +++ b/src/pages/docs/cli/rooms/reactions/send.mdx @@ -40,9 +40,8 @@ A client ID to use when sending the reaction. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/rooms/reactions/subscribe.mdx b/src/pages/docs/cli/rooms/reactions/subscribe.mdx index 89ed7a15e9..d7829b027f 100644 --- a/src/pages/docs/cli/rooms/reactions/subscribe.mdx +++ b/src/pages/docs/cli/rooms/reactions/subscribe.mdx @@ -36,9 +36,8 @@ A client ID to use for the subscription. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/rooms/typing/keystroke.mdx b/src/pages/docs/cli/rooms/typing/keystroke.mdx index 317aa4f3ed..244892d89c 100644 --- a/src/pages/docs/cli/rooms/typing/keystroke.mdx +++ b/src/pages/docs/cli/rooms/typing/keystroke.mdx @@ -40,9 +40,8 @@ A client ID to use when sending the typing indicator. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/rooms/typing/subscribe.mdx b/src/pages/docs/cli/rooms/typing/subscribe.mdx index 97d5dc37d5..9d080caeae 100644 --- a/src/pages/docs/cli/rooms/typing/subscribe.mdx +++ b/src/pages/docs/cli/rooms/typing/subscribe.mdx @@ -36,9 +36,8 @@ A client ID to use for the subscription. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/spaces/create.mdx b/src/pages/docs/cli/spaces/create.mdx index f765dc5406..250ed97c4d 100644 --- a/src/pages/docs/cli/spaces/create.mdx +++ b/src/pages/docs/cli/spaces/create.mdx @@ -32,9 +32,8 @@ A client ID to use when creating the space. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/spaces/cursors/get.mdx b/src/pages/docs/cli/spaces/cursors/get.mdx index 631976be53..f19a49df44 100644 --- a/src/pages/docs/cli/spaces/cursors/get.mdx +++ b/src/pages/docs/cli/spaces/cursors/get.mdx @@ -28,9 +28,8 @@ You can optionally pass the following flags to the `ably spaces cursors get` com The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/spaces/cursors/set.mdx b/src/pages/docs/cli/spaces/cursors/set.mdx index 66d06fcd10..de0d53196e 100644 --- a/src/pages/docs/cli/spaces/cursors/set.mdx +++ b/src/pages/docs/cli/spaces/cursors/set.mdx @@ -52,9 +52,8 @@ A client ID to use when setting the cursor. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/spaces/cursors/subscribe.mdx b/src/pages/docs/cli/spaces/cursors/subscribe.mdx index aaa6fbfed0..4df5853dc7 100644 --- a/src/pages/docs/cli/spaces/cursors/subscribe.mdx +++ b/src/pages/docs/cli/spaces/cursors/subscribe.mdx @@ -36,9 +36,8 @@ A client ID to use when subscribing. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/spaces/get.mdx b/src/pages/docs/cli/spaces/get.mdx index 35ac2f6e11..9b01f2ac2e 100644 --- a/src/pages/docs/cli/spaces/get.mdx +++ b/src/pages/docs/cli/spaces/get.mdx @@ -28,9 +28,8 @@ You can optionally pass the following flags to the `ably spaces get` command: The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/spaces/list.mdx b/src/pages/docs/cli/spaces/list.mdx index 65db39dc45..ad791b59e4 100644 --- a/src/pages/docs/cli/spaces/list.mdx +++ b/src/pages/docs/cli/spaces/list.mdx @@ -28,9 +28,8 @@ A prefix to filter spaces by name. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/spaces/locations/get.mdx b/src/pages/docs/cli/spaces/locations/get.mdx index 999ee265d6..b7ebf2282b 100644 --- a/src/pages/docs/cli/spaces/locations/get.mdx +++ b/src/pages/docs/cli/spaces/locations/get.mdx @@ -28,9 +28,8 @@ You can optionally pass the following flags to the `ably spaces locations get` c The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/spaces/locations/set.mdx b/src/pages/docs/cli/spaces/locations/set.mdx index 68f8d4d61e..75b8331c4e 100644 --- a/src/pages/docs/cli/spaces/locations/set.mdx +++ b/src/pages/docs/cli/spaces/locations/set.mdx @@ -40,9 +40,8 @@ A client ID to use when setting the location. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/spaces/locations/subscribe.mdx b/src/pages/docs/cli/spaces/locations/subscribe.mdx index f2c703ad6e..ab4e97164c 100644 --- a/src/pages/docs/cli/spaces/locations/subscribe.mdx +++ b/src/pages/docs/cli/spaces/locations/subscribe.mdx @@ -36,9 +36,8 @@ A client ID to use when subscribing. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/spaces/locks/acquire.mdx b/src/pages/docs/cli/spaces/locks/acquire.mdx index e4d153d56e..ec9ff45dc7 100644 --- a/src/pages/docs/cli/spaces/locks/acquire.mdx +++ b/src/pages/docs/cli/spaces/locks/acquire.mdx @@ -44,9 +44,8 @@ A client ID to use when acquiring the lock. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/spaces/locks/get.mdx b/src/pages/docs/cli/spaces/locks/get.mdx index f6d8d39454..11aabd63eb 100644 --- a/src/pages/docs/cli/spaces/locks/get.mdx +++ b/src/pages/docs/cli/spaces/locks/get.mdx @@ -32,9 +32,8 @@ You can optionally pass the following flags to the `ably spaces locks get` comma The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/spaces/locks/subscribe.mdx b/src/pages/docs/cli/spaces/locks/subscribe.mdx index cd5b5b2f0d..3c6fe5ef46 100644 --- a/src/pages/docs/cli/spaces/locks/subscribe.mdx +++ b/src/pages/docs/cli/spaces/locks/subscribe.mdx @@ -36,9 +36,8 @@ A client ID to use when subscribing. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/spaces/members/enter.mdx b/src/pages/docs/cli/spaces/members/enter.mdx index d3d2e0cb56..c24b6fa56d 100644 --- a/src/pages/docs/cli/spaces/members/enter.mdx +++ b/src/pages/docs/cli/spaces/members/enter.mdx @@ -40,9 +40,8 @@ A client ID to use when entering the space. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/spaces/members/get.mdx b/src/pages/docs/cli/spaces/members/get.mdx index 27de6a3e6c..27cbfb47da 100644 --- a/src/pages/docs/cli/spaces/members/get.mdx +++ b/src/pages/docs/cli/spaces/members/get.mdx @@ -28,9 +28,8 @@ You can optionally pass the following flags to the `ably spaces members get` com The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/spaces/members/subscribe.mdx b/src/pages/docs/cli/spaces/members/subscribe.mdx index 6c57097248..cca5621528 100644 --- a/src/pages/docs/cli/spaces/members/subscribe.mdx +++ b/src/pages/docs/cli/spaces/members/subscribe.mdx @@ -36,9 +36,8 @@ A client ID to use when subscribing. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/spaces/occupancy/get.mdx b/src/pages/docs/cli/spaces/occupancy/get.mdx index 83bb8cf808..565f7b2aa5 100644 --- a/src/pages/docs/cli/spaces/occupancy/get.mdx +++ b/src/pages/docs/cli/spaces/occupancy/get.mdx @@ -28,9 +28,8 @@ You can optionally pass the following flags to the `ably spaces occupancy get` c The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/spaces/occupancy/subscribe.mdx b/src/pages/docs/cli/spaces/occupancy/subscribe.mdx index 972e7ad418..afba8da2e4 100644 --- a/src/pages/docs/cli/spaces/occupancy/subscribe.mdx +++ b/src/pages/docs/cli/spaces/occupancy/subscribe.mdx @@ -36,9 +36,8 @@ A client ID to use when subscribing. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/spaces/subscribe.mdx b/src/pages/docs/cli/spaces/subscribe.mdx index 99cdac8bf9..c0e7d492d8 100644 --- a/src/pages/docs/cli/spaces/subscribe.mdx +++ b/src/pages/docs/cli/spaces/subscribe.mdx @@ -36,9 +36,8 @@ A client ID to use when subscribing. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/stats/account.mdx b/src/pages/docs/cli/stats/account.mdx index dc8934afc4..e2b623a824 100644 --- a/src/pages/docs/cli/stats/account.mdx +++ b/src/pages/docs/cli/stats/account.mdx @@ -48,9 +48,8 @@ Show debug information for live polling. Defaults to `false`. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples @@ -94,6 +93,19 @@ ably stats account --live --interval 10 ``` +## Output + +The `ably accounts stats` command displays statistics for each time period: + +| Metric | Description | +| ------ | ----------- | +| Connections | Peak, minimum, mean connections, plus opened, refused, and active counts | +| Channels | Peak, minimum, mean channels, plus opened, refused, and active counts | +| Messages | Total, published, delivered message counts and data volume | +| API Requests | Succeeded, failed, refused, and total request counts | +| Token Requests | Succeeded, failed, and refused token request counts | +| Peak Rates | Maximum rates per second for messages, connections, channels, API requests, and token requests | + ## See also * [Stats](/docs/cli/stats) — Explore all `ably stats` commands. diff --git a/src/pages/docs/cli/stats/app.mdx b/src/pages/docs/cli/stats/app.mdx index 814a57931b..b1d20304b5 100644 --- a/src/pages/docs/cli/stats/app.mdx +++ b/src/pages/docs/cli/stats/app.mdx @@ -56,9 +56,8 @@ Show debug information for live polling. Defaults to `false`. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/status.mdx b/src/pages/docs/cli/status.mdx index c35e1f7975..cb575b5803 100644 --- a/src/pages/docs/cli/status.mdx +++ b/src/pages/docs/cli/status.mdx @@ -24,9 +24,8 @@ Open the Ably status page in a browser. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/support/ask.mdx b/src/pages/docs/cli/support/ask.mdx index ae6682df98..031744e746 100644 --- a/src/pages/docs/cli/support/ask.mdx +++ b/src/pages/docs/cli/support/ask.mdx @@ -32,9 +32,8 @@ Continue a previous conversation with the AI agent. Defaults to `false`. The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples diff --git a/src/pages/docs/cli/version.mdx b/src/pages/docs/cli/version.mdx index 8e71c2e109..e8b6569495 100644 --- a/src/pages/docs/cli/version.mdx +++ b/src/pages/docs/cli/version.mdx @@ -16,9 +16,8 @@ Use the `ably version` command to display version information for the Ably CLI, The following [global flags](/docs/cli#global-flags) are also available: -* [`--json`](/docs/cli#json) -* [`--pretty-json`](/docs/cli#pretty-json) -* [`--verbose`](/docs/cli#verbose) +* [`--json`](/docs/cli#json) or [`--pretty-json`](/docs/cli#pretty-json) — mutually exclusive output format flags. +* [`--verbose`](/docs/cli#verbose) — can be combined with either output format flag. ## Examples From 98459da5a96fe3eab36ac58978b2f301d88a8dc8 Mon Sep 17 00:00:00 2001 From: sacOO7 Date: Tue, 7 Apr 2026 14:02:46 +0530 Subject: [PATCH 8/9] Added output to channels publish and subscribe commands for CLI tool snippets --- src/pages/docs/platform/tools/cli.mdx | 52 +++++++++++++++++++++++++++ 1 file changed, 52 insertions(+) diff --git a/src/pages/docs/platform/tools/cli.mdx b/src/pages/docs/platform/tools/cli.mdx index 0ee013097d..82f72ffa01 100644 --- a/src/pages/docs/platform/tools/cli.mdx +++ b/src/pages/docs/platform/tools/cli.mdx @@ -43,22 +43,74 @@ To subscribe: ```shell +# Attach to channel with name channel-1 ably channels subscribe channel-1 ``` + +```shell +# Output - from publish using `ably channels publish channel-1 Hi!` +Attaching to channel: channel-1... +Successfully attached to channel: channel-1 +✓ Subscribed to channel: channel-1. +Listening for messages. Press Ctrl+C to exit. + +[2026-04-07T08:23:20.065Z] +ID: GRg/1gFs/Frs:0 +Timestamp: 2026-04-07T08:23:20.065Z +Channel: channel-1 +Action: message.create +Client ID: ably-cli-38e5504e +Serial: 01775550200065-000@108sLXM8gC109L72259911:000 +Data: Hi! +``` + + To publish: ```shell # To publish 1 message: ably channels publish channel-1 Hi! +``` + + +```shell +# Output +✓ Message published to channel: channel-1. + Serial: 01775550200065-000@108sLXM8gC109L72259911:000 +``` + + + +```shell # To publish 5 messages: ably channels publish --count 5 channel-1 "Message number {{.Count}}" ``` + +```shell +# Output +Publishing 5 messages with 40ms delay... +✓ Message 1 published to channel: channel-1. + Serial: 01775550270016-000@108sLXM8gC109L72259911:000 +✓ Message 2 published to channel: channel-1. + Serial: 01775550270227-000@108sLXM8gC109L72259911:000 +2/5 messages published (0 errors)... +✓ Message 3 published to channel: channel-1. + Serial: 01775550270723-000@108sLXM8gC109L72259911:000 +✓ Message 4 published to channel: channel-1. + Serial: 01775550271223-000@108sLXM8gC109L72259911:000 +4/5 messages published (0 errors)... +✓ Message 5 published to channel: channel-1. + Serial: 01775550271735-000@108sLXM8gC109L72259911:000 +✓ 5/5 messages published to channel: channel-1. +``` + + For a list of all available commands, run: From ec81ef5a14c9a734e2dbb3edd9769cdc72192069 Mon Sep 17 00:00:00 2001 From: sacOO7 Date: Tue, 14 Apr 2026 00:15:29 +0530 Subject: [PATCH 9/9] Added missing synopsis to commands similar to aws CLI --- src/pages/docs/cli/apps/create.mdx | 6 ++++-- src/pages/docs/cli/apps/current.mdx | 6 ++++-- src/pages/docs/cli/apps/delete.mdx | 6 ++++-- src/pages/docs/cli/apps/list.mdx | 6 ++++-- src/pages/docs/cli/apps/rules/create.mdx | 6 ++++-- src/pages/docs/cli/apps/rules/delete.mdx | 6 ++++-- src/pages/docs/cli/apps/rules/list.mdx | 6 ++++-- src/pages/docs/cli/apps/rules/update.mdx | 6 ++++-- src/pages/docs/cli/apps/switch.mdx | 6 ++++-- src/pages/docs/cli/apps/update.mdx | 6 ++++-- src/pages/docs/cli/autocomplete.mdx | 6 ++++-- src/pages/docs/cli/bench/publisher.mdx | 6 ++++-- src/pages/docs/cli/bench/subscriber.mdx | 6 ++++-- src/pages/docs/cli/channels/annotations/delete.mdx | 6 ++++-- src/pages/docs/cli/channels/annotations/get.mdx | 6 ++++-- src/pages/docs/cli/channels/annotations/publish.mdx | 6 ++++-- src/pages/docs/cli/channels/annotations/subscribe.mdx | 6 ++++-- src/pages/docs/cli/channels/append.mdx | 6 ++++-- src/pages/docs/cli/channels/batch-publish.mdx | 6 ++++-- src/pages/docs/cli/channels/delete.mdx | 6 ++++-- src/pages/docs/cli/channels/history.mdx | 6 ++++-- src/pages/docs/cli/channels/inspect.mdx | 6 ++++-- src/pages/docs/cli/channels/list.mdx | 6 ++++-- src/pages/docs/cli/channels/occupancy/get.mdx | 6 ++++-- src/pages/docs/cli/channels/occupancy/subscribe.mdx | 6 ++++-- src/pages/docs/cli/channels/presence/enter.mdx | 6 ++++-- src/pages/docs/cli/channels/presence/get.mdx | 6 ++++-- src/pages/docs/cli/channels/presence/subscribe.mdx | 6 ++++-- src/pages/docs/cli/channels/publish.mdx | 6 ++++-- src/pages/docs/cli/channels/subscribe.mdx | 6 ++++-- src/pages/docs/cli/channels/update.mdx | 6 ++++-- src/pages/docs/cli/config/path.mdx | 6 ++++-- src/pages/docs/cli/config/show.mdx | 6 ++++-- src/pages/docs/cli/connections/test.mdx | 6 ++++-- src/pages/docs/cli/help.mdx | 6 ++++-- src/pages/docs/cli/integrations/create.mdx | 6 ++++-- src/pages/docs/cli/integrations/delete.mdx | 6 ++++-- src/pages/docs/cli/integrations/get.mdx | 6 ++++-- src/pages/docs/cli/integrations/list.mdx | 6 ++++-- src/pages/docs/cli/integrations/update.mdx | 6 ++++-- src/pages/docs/cli/interactive.mdx | 6 ++++-- src/pages/docs/cli/login.mdx | 6 ++++-- src/pages/docs/cli/logs/channel-lifecycle/subscribe.mdx | 6 ++++-- src/pages/docs/cli/logs/connection-lifecycle/history.mdx | 6 ++++-- src/pages/docs/cli/logs/connection-lifecycle/subscribe.mdx | 6 ++++-- src/pages/docs/cli/logs/history.mdx | 6 ++++-- src/pages/docs/cli/logs/push/history.mdx | 6 ++++-- src/pages/docs/cli/logs/push/subscribe.mdx | 6 ++++-- src/pages/docs/cli/logs/subscribe.mdx | 6 ++++-- src/pages/docs/cli/push/batch-publish.mdx | 6 ++++-- src/pages/docs/cli/push/channels/list-channels.mdx | 6 ++++-- src/pages/docs/cli/push/channels/list.mdx | 6 ++++-- src/pages/docs/cli/push/channels/remove-where.mdx | 6 ++++-- src/pages/docs/cli/push/channels/remove.mdx | 6 ++++-- src/pages/docs/cli/push/channels/save.mdx | 6 ++++-- src/pages/docs/cli/push/config/clear-apns.mdx | 6 ++++-- src/pages/docs/cli/push/config/clear-fcm.mdx | 6 ++++-- src/pages/docs/cli/push/config/set-apns.mdx | 6 ++++-- src/pages/docs/cli/push/config/set-fcm.mdx | 6 ++++-- src/pages/docs/cli/push/config/show.mdx | 6 ++++-- src/pages/docs/cli/push/devices/get.mdx | 6 ++++-- src/pages/docs/cli/push/devices/list.mdx | 6 ++++-- src/pages/docs/cli/push/devices/remove-where.mdx | 6 ++++-- src/pages/docs/cli/push/devices/remove.mdx | 6 ++++-- src/pages/docs/cli/push/devices/save.mdx | 6 ++++-- src/pages/docs/cli/push/publish.mdx | 6 ++++-- src/pages/docs/cli/queues/create.mdx | 6 ++++-- src/pages/docs/cli/queues/delete.mdx | 6 ++++-- src/pages/docs/cli/queues/list.mdx | 6 ++++-- src/pages/docs/cli/rooms/list.mdx | 6 ++++-- src/pages/docs/cli/rooms/messages/delete.mdx | 6 ++++-- src/pages/docs/cli/rooms/messages/history.mdx | 6 ++++-- src/pages/docs/cli/rooms/messages/reactions/remove.mdx | 6 ++++-- src/pages/docs/cli/rooms/messages/reactions/send.mdx | 6 ++++-- src/pages/docs/cli/rooms/messages/reactions/subscribe.mdx | 6 ++++-- src/pages/docs/cli/rooms/messages/send.mdx | 6 ++++-- src/pages/docs/cli/rooms/messages/subscribe.mdx | 6 ++++-- src/pages/docs/cli/rooms/messages/update.mdx | 6 ++++-- src/pages/docs/cli/rooms/occupancy/get.mdx | 6 ++++-- src/pages/docs/cli/rooms/occupancy/subscribe.mdx | 6 ++++-- src/pages/docs/cli/rooms/presence/enter.mdx | 6 ++++-- src/pages/docs/cli/rooms/presence/get.mdx | 6 ++++-- src/pages/docs/cli/rooms/presence/subscribe.mdx | 6 ++++-- src/pages/docs/cli/rooms/reactions/send.mdx | 6 ++++-- src/pages/docs/cli/rooms/reactions/subscribe.mdx | 6 ++++-- src/pages/docs/cli/rooms/typing/keystroke.mdx | 6 ++++-- src/pages/docs/cli/rooms/typing/subscribe.mdx | 6 ++++-- src/pages/docs/cli/spaces/create.mdx | 6 ++++-- src/pages/docs/cli/spaces/cursors/get.mdx | 6 ++++-- src/pages/docs/cli/spaces/cursors/set.mdx | 6 ++++-- src/pages/docs/cli/spaces/cursors/subscribe.mdx | 6 ++++-- src/pages/docs/cli/spaces/get.mdx | 6 ++++-- src/pages/docs/cli/spaces/list.mdx | 6 ++++-- src/pages/docs/cli/spaces/locations/get.mdx | 6 ++++-- src/pages/docs/cli/spaces/locations/set.mdx | 6 ++++-- src/pages/docs/cli/spaces/locations/subscribe.mdx | 6 ++++-- src/pages/docs/cli/spaces/locks/acquire.mdx | 6 ++++-- src/pages/docs/cli/spaces/locks/get.mdx | 6 ++++-- src/pages/docs/cli/spaces/locks/subscribe.mdx | 6 ++++-- src/pages/docs/cli/spaces/members/enter.mdx | 6 ++++-- src/pages/docs/cli/spaces/members/get.mdx | 6 ++++-- src/pages/docs/cli/spaces/members/subscribe.mdx | 6 ++++-- src/pages/docs/cli/spaces/occupancy/get.mdx | 6 ++++-- src/pages/docs/cli/spaces/occupancy/subscribe.mdx | 6 ++++-- src/pages/docs/cli/spaces/subscribe.mdx | 6 ++++-- src/pages/docs/cli/stats/account.mdx | 6 ++++-- src/pages/docs/cli/stats/app.mdx | 6 ++++-- src/pages/docs/cli/status.mdx | 6 ++++-- src/pages/docs/cli/support/ask.mdx | 6 ++++-- src/pages/docs/cli/support/contact.mdx | 6 ++++-- src/pages/docs/cli/version.mdx | 6 ++++-- 111 files changed, 444 insertions(+), 222 deletions(-) diff --git a/src/pages/docs/cli/apps/create.mdx b/src/pages/docs/cli/apps/create.mdx index d9cd2bbc15..2740d8e774 100644 --- a/src/pages/docs/cli/apps/create.mdx +++ b/src/pages/docs/cli/apps/create.mdx @@ -4,14 +4,16 @@ meta_description: "Create a new Ably application using the CLI." meta_keywords: "ably cli, cli, apps, create, new application, ably apps create" --- +Use the `ably apps create` command to create a new Ably application in your account. + +## Synopsis + ```shell ably apps create --name [flags] ``` -Use the `ably apps create` command to create a new Ably application in your account. - ## Flags You can pass the following flags to the `ably apps create` command: diff --git a/src/pages/docs/cli/apps/current.mdx b/src/pages/docs/cli/apps/current.mdx index 30a5566b6f..6532fe372b 100644 --- a/src/pages/docs/cli/apps/current.mdx +++ b/src/pages/docs/cli/apps/current.mdx @@ -4,14 +4,16 @@ meta_description: "Show the currently selected Ably application using the CLI." meta_keywords: "ably cli, cli, apps, current, selected app, ably apps current" --- +Use the `ably apps current` command to display information about the currently selected Ably application. + +## Synopsis + ```shell ably apps current ``` -Use the `ably apps current` command to display information about the currently selected Ably application. - ## Global flags The following [global flags](/docs/cli#global-flags) are also available: diff --git a/src/pages/docs/cli/apps/delete.mdx b/src/pages/docs/cli/apps/delete.mdx index 6d1ea4827b..62f9e16596 100644 --- a/src/pages/docs/cli/apps/delete.mdx +++ b/src/pages/docs/cli/apps/delete.mdx @@ -4,14 +4,16 @@ meta_description: "Permanently delete an Ably application using the CLI." meta_keywords: "ably cli, cli, apps, delete, remove application, ably apps delete" --- +Use the `ably apps delete` command to permanently delete an Ably application. + +## Synopsis + ```shell ably apps delete [id] [flags] ``` -Use the `ably apps delete` command to permanently delete an Ably application. - diff --git a/src/pages/docs/cli/apps/list.mdx b/src/pages/docs/cli/apps/list.mdx index 1f3a000560..60f4992e68 100644 --- a/src/pages/docs/cli/apps/list.mdx +++ b/src/pages/docs/cli/apps/list.mdx @@ -4,14 +4,16 @@ meta_description: "List all Ably applications in the current account using the C meta_keywords: "ably cli, cli, apps, list, applications, ably apps list" --- +Use the `ably apps list` command to list all applications in the current account. + +## Synopsis + ```shell ably apps list [flags] ``` -Use the `ably apps list` command to list all applications in the current account. - ## Flags You can optionally pass the following flags to the `ably apps list` command: diff --git a/src/pages/docs/cli/apps/rules/create.mdx b/src/pages/docs/cli/apps/rules/create.mdx index 683a77e363..5cb7da0a72 100644 --- a/src/pages/docs/cli/apps/rules/create.mdx +++ b/src/pages/docs/cli/apps/rules/create.mdx @@ -4,14 +4,16 @@ meta_description: "Create a channel rule for an Ably application using the CLI." meta_keywords: "ably cli, cli, apps, rules, create, channel rule, namespace, ably apps rules create" --- +Use the `ably apps rules create` command to create a new [channel rule](/docs/channels/channel-rules-namespaces) for an Ably application. Channel rules define behavior for channels matching a specific namespace. + +## Synopsis + ```shell ably apps rules create --name [flags] ``` -Use the `ably apps rules create` command to create a new [channel rule](/docs/channels/channel-rules-namespaces) for an Ably application. Channel rules define behavior for channels matching a specific namespace. - ## Flags You can pass the following flags to the `ably apps rules create` command: diff --git a/src/pages/docs/cli/apps/rules/delete.mdx b/src/pages/docs/cli/apps/rules/delete.mdx index 25e1576836..670c39d544 100644 --- a/src/pages/docs/cli/apps/rules/delete.mdx +++ b/src/pages/docs/cli/apps/rules/delete.mdx @@ -4,14 +4,16 @@ meta_description: "Delete a channel rule from an Ably application using the CLI. meta_keywords: "ably cli, cli, apps, rules, delete, remove, channel rule, ably apps rules delete" --- +Use the `ably apps rules delete` command to delete a [channel rule](/docs/channels/channel-rules-namespaces) from an Ably application. + +## Synopsis + ```shell ably apps rules delete [flags] ``` -Use the `ably apps rules delete` command to delete a [channel rule](/docs/channels/channel-rules-namespaces) from an Ably application. - ## Arguments Pass the following arguments to the `ably apps rules delete` command: diff --git a/src/pages/docs/cli/apps/rules/list.mdx b/src/pages/docs/cli/apps/rules/list.mdx index fc23643680..cc5dfd49e7 100644 --- a/src/pages/docs/cli/apps/rules/list.mdx +++ b/src/pages/docs/cli/apps/rules/list.mdx @@ -4,14 +4,16 @@ meta_description: "List channel rules for an Ably application using the CLI." meta_keywords: "ably cli, cli, apps, rules, list, channel rules, namespaces, ably apps rules list" --- +Use the `ably apps rules list` command to list all [channel rules](/docs/channels/channel-rules-namespaces) configured for an Ably application. + +## Synopsis + ```shell ably apps rules list [flags] ``` -Use the `ably apps rules list` command to list all [channel rules](/docs/channels/channel-rules-namespaces) configured for an Ably application. - ## Flags You can optionally pass the following flags to the `ably apps rules list` command: diff --git a/src/pages/docs/cli/apps/rules/update.mdx b/src/pages/docs/cli/apps/rules/update.mdx index 9bfa58fbe1..163c23d0dd 100644 --- a/src/pages/docs/cli/apps/rules/update.mdx +++ b/src/pages/docs/cli/apps/rules/update.mdx @@ -4,14 +4,16 @@ meta_description: "Update a channel rule for an Ably application using the CLI." meta_keywords: "ably cli, cli, apps, rules, update, modify, channel rule, ably apps rules update" --- +Use the `ably apps rules update` command to update an existing a [channel rule](/docs/channels/channel-rules-namespaces) for an Ably application. + +## Synopsis + ```shell ably apps rules update [flags] ``` -Use the `ably apps rules update` command to update an existing a [channel rule](/docs/channels/channel-rules-namespaces) for an Ably application. - ## Arguments Pass the following arguments to the `ably apps rules update` command: diff --git a/src/pages/docs/cli/apps/switch.mdx b/src/pages/docs/cli/apps/switch.mdx index 42784e379b..1af457a5bc 100644 --- a/src/pages/docs/cli/apps/switch.mdx +++ b/src/pages/docs/cli/apps/switch.mdx @@ -4,14 +4,16 @@ meta_description: "Switch to a different Ably application using the CLI." meta_keywords: "ably cli, cli, apps, switch, change app, ably apps switch" --- +Use the `ably apps switch` command to switch to a different Ably application. The selected app is used as the default for subsequent commands. + +## Synopsis + ```shell ably apps switch [id] ``` -Use the `ably apps switch` command to switch to a different Ably application. The selected app is used as the default for subsequent commands. - ## Arguments Pass the following arguments to the `ably apps switch` command: diff --git a/src/pages/docs/cli/apps/update.mdx b/src/pages/docs/cli/apps/update.mdx index f31f178bf7..51d9af7cb9 100644 --- a/src/pages/docs/cli/apps/update.mdx +++ b/src/pages/docs/cli/apps/update.mdx @@ -4,14 +4,16 @@ meta_description: "Update an Ably application's configuration using the CLI." meta_keywords: "ably cli, cli, apps, update, modify application, ably apps update" --- +Use the `ably apps update` command to update the configuration of an existing Ably application. + +## Synopsis + ```shell ably apps update [flags] ``` -Use the `ably apps update` command to update the configuration of an existing Ably application. - ## Arguments Pass the following arguments to the `ably apps update` command: diff --git a/src/pages/docs/cli/autocomplete.mdx b/src/pages/docs/cli/autocomplete.mdx index d7a8c92ddc..c472a97ab9 100644 --- a/src/pages/docs/cli/autocomplete.mdx +++ b/src/pages/docs/cli/autocomplete.mdx @@ -4,14 +4,16 @@ meta_description: "Display autocomplete installation instructions for the Ably C meta_keywords: "ably cli, cli, autocomplete, shell completion, bash, zsh, powershell" --- +Use the `ably autocomplete` command to display installation instructions for shell autocompletion. Once configured, autocomplete enables tab completion for commands and flags in your terminal. + +## Synopsis + ```shell ably autocomplete [SHELL] ``` -Use the `ably autocomplete` command to display installation instructions for shell autocompletion. Once configured, autocomplete enables tab completion for commands and flags in your terminal. - ## Arguments Pass the following arguments to the `ably autocomplete` command: diff --git a/src/pages/docs/cli/bench/publisher.mdx b/src/pages/docs/cli/bench/publisher.mdx index a0d11a58e4..eb208cdb5c 100644 --- a/src/pages/docs/cli/bench/publisher.mdx +++ b/src/pages/docs/cli/bench/publisher.mdx @@ -4,14 +4,16 @@ meta_description: "Run a publisher benchmark test using the Ably CLI." meta_keywords: "ably cli, cli, bench, publisher, benchmark, performance, ably bench publisher" --- +Use the `ably bench publisher` command to run a publisher benchmark test on an Ably channel. + +## Synopsis + ```shell ably bench publisher [flags] ``` -Use the `ably bench publisher` command to run a publisher benchmark test on an Ably channel. - ## Arguments Pass the following arguments to the `ably bench publisher` command: diff --git a/src/pages/docs/cli/bench/subscriber.mdx b/src/pages/docs/cli/bench/subscriber.mdx index 30cd48877c..35c7c5eb9e 100644 --- a/src/pages/docs/cli/bench/subscriber.mdx +++ b/src/pages/docs/cli/bench/subscriber.mdx @@ -4,14 +4,16 @@ meta_description: "Run a subscriber benchmark test using the Ably CLI." meta_keywords: "ably cli, cli, bench, subscriber, benchmark, performance, ably bench subscriber" --- +Use the `ably bench subscriber` command to run a subscriber benchmark test on an Ably channel. + +## Synopsis + ```shell ably bench subscriber [flags] ``` -Use the `ably bench subscriber` command to run a subscriber benchmark test on an Ably channel. - ## Arguments Pass the following arguments to the `ably bench subscriber` command: diff --git a/src/pages/docs/cli/channels/annotations/delete.mdx b/src/pages/docs/cli/channels/annotations/delete.mdx index a2cb88847a..012ca127ab 100644 --- a/src/pages/docs/cli/channels/annotations/delete.mdx +++ b/src/pages/docs/cli/channels/annotations/delete.mdx @@ -4,14 +4,16 @@ meta_description: "Delete an annotation from an Ably Pub/Sub channel message usi meta_keywords: "ably cli, cli, channels, annotations, delete, reactions, ably channels annotations delete" --- +Use the `ably channels annotations delete` command to delete an annotation from a channel message. + +## Synopsis + ```shell ably channels annotations delete [flags] ``` -Use the `ably channels annotations delete` command to delete an annotation from a channel message. - ## Arguments Pass the following arguments to the `ably channels annotations delete` command: diff --git a/src/pages/docs/cli/channels/annotations/get.mdx b/src/pages/docs/cli/channels/annotations/get.mdx index 90b05ec396..02164f7283 100644 --- a/src/pages/docs/cli/channels/annotations/get.mdx +++ b/src/pages/docs/cli/channels/annotations/get.mdx @@ -4,14 +4,16 @@ meta_description: "Get annotations for an Ably Pub/Sub channel message using the meta_keywords: "ably cli, cli, channels, annotations, get, reactions, ably channels annotations get" --- +Use the `ably channels annotations get` command to get annotations for a channel message. + +## Synopsis + ```shell ably channels annotations get [flags] ``` -Use the `ably channels annotations get` command to get annotations for a channel message. - ## Arguments Pass the following arguments to the `ably channels annotations get` command: diff --git a/src/pages/docs/cli/channels/annotations/publish.mdx b/src/pages/docs/cli/channels/annotations/publish.mdx index 159d05e435..8a8304a70d 100644 --- a/src/pages/docs/cli/channels/annotations/publish.mdx +++ b/src/pages/docs/cli/channels/annotations/publish.mdx @@ -4,14 +4,16 @@ meta_description: "Publish an annotation on an Ably Pub/Sub channel message usin meta_keywords: "ably cli, cli, channels, annotations, publish, reactions, ably channels annotations publish" --- +Use the `ably channels annotations publish` command to publish an annotation on a channel message. + +## Synopsis + ```shell ably channels annotations publish [flags] ``` -Use the `ably channels annotations publish` command to publish an annotation on a channel message. - ## Arguments Pass the following arguments to the `ably channels annotations publish` command: diff --git a/src/pages/docs/cli/channels/annotations/subscribe.mdx b/src/pages/docs/cli/channels/annotations/subscribe.mdx index 2ddc367585..9191b61e87 100644 --- a/src/pages/docs/cli/channels/annotations/subscribe.mdx +++ b/src/pages/docs/cli/channels/annotations/subscribe.mdx @@ -4,14 +4,16 @@ meta_description: "Subscribe to annotations on an Ably Pub/Sub channel using the meta_keywords: "ably cli, cli, channels, annotations, subscribe, reactions, ably channels annotations subscribe" --- +Use the `ably channels annotations subscribe` command to subscribe to annotations on an Ably Pub/Sub channel. + +## Synopsis + ```shell ably channels annotations subscribe [flags] ``` -Use the `ably channels annotations subscribe` command to subscribe to annotations on an Ably Pub/Sub channel. - ## Arguments Pass the following arguments to the `ably channels annotations subscribe` command: diff --git a/src/pages/docs/cli/channels/append.mdx b/src/pages/docs/cli/channels/append.mdx index 3210cb1798..522de0d81b 100644 --- a/src/pages/docs/cli/channels/append.mdx +++ b/src/pages/docs/cli/channels/append.mdx @@ -4,14 +4,16 @@ meta_description: "Append data to a message on an Ably Pub/Sub channel using the meta_keywords: "ably cli, cli, channels, append, message, pub/sub, ably channels append" --- +Use the `ably channels append` command to append data to a message on an Ably Pub/Sub channel. + +## Synopsis + ```shell ably channels append [flags] ``` -Use the `ably channels append` command to append data to a message on an Ably Pub/Sub channel. - ## Arguments Pass the following arguments to the `ably channels append` command: diff --git a/src/pages/docs/cli/channels/batch-publish.mdx b/src/pages/docs/cli/channels/batch-publish.mdx index fdc0e11202..442d83d0dd 100644 --- a/src/pages/docs/cli/channels/batch-publish.mdx +++ b/src/pages/docs/cli/channels/batch-publish.mdx @@ -4,14 +4,16 @@ meta_description: "Publish a message to multiple Ably Pub/Sub channels at once u meta_keywords: "ably cli, cli, channels, batch-publish, batch, publish, pub/sub, ably channels batch-publish" --- +Use the `ably channels batch-publish` command to publish a message to multiple Ably Pub/Sub channels at once. + +## Synopsis + ```shell ably channels batch-publish [message] [flags] ``` -Use the `ably channels batch-publish` command to publish a message to multiple Ably Pub/Sub channels at once. - ## Arguments Pass the following arguments to the `ably channels batch-publish` command: diff --git a/src/pages/docs/cli/channels/delete.mdx b/src/pages/docs/cli/channels/delete.mdx index 315558bf1e..e6a544d32b 100644 --- a/src/pages/docs/cli/channels/delete.mdx +++ b/src/pages/docs/cli/channels/delete.mdx @@ -4,14 +4,16 @@ meta_description: "Delete a message on an Ably Pub/Sub channel using the CLI." meta_keywords: "ably cli, cli, channels, delete, message, pub/sub, ably channels delete" --- +Use the `ably channels delete` command to delete a message on an Ably Pub/Sub channel. + +## Synopsis + ```shell ably channels delete [flags] ``` -Use the `ably channels delete` command to delete a message on an Ably Pub/Sub channel. - ## Arguments Pass the following arguments to the `ably channels delete` command: diff --git a/src/pages/docs/cli/channels/history.mdx b/src/pages/docs/cli/channels/history.mdx index f7c44aae86..bb0b2a77c7 100644 --- a/src/pages/docs/cli/channels/history.mdx +++ b/src/pages/docs/cli/channels/history.mdx @@ -4,14 +4,16 @@ meta_description: "Retrieve message history for an Ably Pub/Sub channel using th meta_keywords: "ably cli, cli, channels, history, messages, pub/sub, ably channels history" --- +Use the `ably channels history` command to retrieve message history for an Ably Pub/Sub channel. + +## Synopsis + ```shell ably channels history [flags] ``` -Use the `ably channels history` command to retrieve message history for an Ably Pub/Sub channel. - ## Arguments Pass the following arguments to the `ably channels history` command: diff --git a/src/pages/docs/cli/channels/inspect.mdx b/src/pages/docs/cli/channels/inspect.mdx index 389aa417be..13224bfc4a 100644 --- a/src/pages/docs/cli/channels/inspect.mdx +++ b/src/pages/docs/cli/channels/inspect.mdx @@ -4,14 +4,16 @@ meta_description: "Open the Ably dashboard to inspect a specific channel using t meta_keywords: "ably cli, cli, channels, inspect, dashboard, pub/sub, ably channels inspect" --- +Use the `ably channels inspect` command to open the Ably dashboard to inspect a specific channel. + +## Synopsis + ```shell ably channels inspect [flags] ``` -Use the `ably channels inspect` command to open the Ably dashboard to inspect a specific channel. - ## Arguments Pass the following arguments to the `ably channels inspect` command: diff --git a/src/pages/docs/cli/channels/list.mdx b/src/pages/docs/cli/channels/list.mdx index 75e91bca6d..0177bbabad 100644 --- a/src/pages/docs/cli/channels/list.mdx +++ b/src/pages/docs/cli/channels/list.mdx @@ -4,14 +4,16 @@ meta_description: "List active channels using the Ably CLI." meta_keywords: "ably cli, cli, channels, list, active channels, enumeration, ably channels list" --- +Use the `ably channels list` command to list active channels using the channel enumeration API. + +## Synopsis + ```shell ably channels list [flags] ``` -Use the `ably channels list` command to list active channels using the channel enumeration API. - ## Flags You can optionally pass the following flags to the `ably channels list` command: diff --git a/src/pages/docs/cli/channels/occupancy/get.mdx b/src/pages/docs/cli/channels/occupancy/get.mdx index 556598a25e..a75479916b 100644 --- a/src/pages/docs/cli/channels/occupancy/get.mdx +++ b/src/pages/docs/cli/channels/occupancy/get.mdx @@ -4,14 +4,16 @@ meta_description: "Get current occupancy for an Ably Pub/Sub channel using the C meta_keywords: "ably cli, cli, channels, occupancy, get, connections, subscribers, ably channels occupancy get" --- +Use the `ably channels occupancy get` command to get the current occupancy for an Ably Pub/Sub channel. + +## Synopsis + ```shell ably channels occupancy get [flags] ``` -Use the `ably channels occupancy get` command to get the current occupancy for an Ably Pub/Sub channel. - ## Arguments Pass the following arguments to the `ably channels occupancy get` command: diff --git a/src/pages/docs/cli/channels/occupancy/subscribe.mdx b/src/pages/docs/cli/channels/occupancy/subscribe.mdx index a514483ea4..3b09379454 100644 --- a/src/pages/docs/cli/channels/occupancy/subscribe.mdx +++ b/src/pages/docs/cli/channels/occupancy/subscribe.mdx @@ -4,14 +4,16 @@ meta_description: "Subscribe to occupancy updates on an Ably Pub/Sub channel usi meta_keywords: "ably cli, cli, channels, occupancy, subscribe, connections, subscribers, ably channels occupancy subscribe" --- +Use the `ably channels occupancy subscribe` command to subscribe to occupancy updates on an Ably Pub/Sub channel. + +## Synopsis + ```shell ably channels occupancy subscribe [flags] ``` -Use the `ably channels occupancy subscribe` command to subscribe to occupancy updates on an Ably Pub/Sub channel. - ## Arguments Pass the following arguments to the `ably channels occupancy subscribe` command: diff --git a/src/pages/docs/cli/channels/presence/enter.mdx b/src/pages/docs/cli/channels/presence/enter.mdx index a13e170cb5..119ba0e3f8 100644 --- a/src/pages/docs/cli/channels/presence/enter.mdx +++ b/src/pages/docs/cli/channels/presence/enter.mdx @@ -4,14 +4,16 @@ meta_description: "Enter presence on an Ably Pub/Sub channel using the CLI." meta_keywords: "ably cli, cli, channels, presence, enter, members, ably channels presence enter" --- +Use the `ably channels presence enter` command to enter presence on a channel and remain present until terminated. + +## Synopsis + ```shell ably channels presence enter [flags] ``` -Use the `ably channels presence enter` command to enter presence on a channel and remain present until terminated. - ## Arguments Pass the following arguments to the `ably channels presence enter` command: diff --git a/src/pages/docs/cli/channels/presence/get.mdx b/src/pages/docs/cli/channels/presence/get.mdx index 8e1c98f5de..99a73e6187 100644 --- a/src/pages/docs/cli/channels/presence/get.mdx +++ b/src/pages/docs/cli/channels/presence/get.mdx @@ -4,14 +4,16 @@ meta_description: "Get all current presence members on an Ably Pub/Sub channel u meta_keywords: "ably cli, cli, channels, presence, get, members, ably channels presence get" --- +Use the `ably channels presence get` command to get all current presence members on a channel. + +## Synopsis + ```shell ably channels presence get [flags] ``` -Use the `ably channels presence get` command to get all current presence members on a channel. - ## Arguments Pass the following arguments to the `ably channels presence get` command: diff --git a/src/pages/docs/cli/channels/presence/subscribe.mdx b/src/pages/docs/cli/channels/presence/subscribe.mdx index 9b8a41b89d..0a3776c71f 100644 --- a/src/pages/docs/cli/channels/presence/subscribe.mdx +++ b/src/pages/docs/cli/channels/presence/subscribe.mdx @@ -4,14 +4,16 @@ meta_description: "Subscribe to presence events on an Ably Pub/Sub channel using meta_keywords: "ably cli, cli, channels, presence, subscribe, events, members, ably channels presence subscribe" --- +Use the `ably channels presence subscribe` command to subscribe to presence events on a channel. + +## Synopsis + ```shell ably channels presence subscribe [flags] ``` -Use the `ably channels presence subscribe` command to subscribe to presence events on a channel. - ## Arguments Pass the following arguments to the `ably channels presence subscribe` command: diff --git a/src/pages/docs/cli/channels/publish.mdx b/src/pages/docs/cli/channels/publish.mdx index 886087babc..72088f337d 100644 --- a/src/pages/docs/cli/channels/publish.mdx +++ b/src/pages/docs/cli/channels/publish.mdx @@ -4,14 +4,16 @@ meta_description: "Publish a message to an Ably Pub/Sub channel using the CLI." meta_keywords: "ably cli, cli, channels, publish, message, pub/sub, ably channels publish" --- +Use the `ably channels publish` command to publish a message to an Ably Pub/Sub channel. + +## Synopsis + ```shell ably channels publish [flags] ``` -Use the `ably channels publish` command to publish a message to an Ably Pub/Sub channel. - ## Arguments Pass the following arguments to the `ably channels publish` command: diff --git a/src/pages/docs/cli/channels/subscribe.mdx b/src/pages/docs/cli/channels/subscribe.mdx index 51bfcc671b..4d6d38cfc0 100644 --- a/src/pages/docs/cli/channels/subscribe.mdx +++ b/src/pages/docs/cli/channels/subscribe.mdx @@ -4,14 +4,16 @@ meta_description: "Subscribe to messages on one or more Ably Pub/Sub channels us meta_keywords: "ably cli, cli, channels, subscribe, messages, pub/sub, ably channels subscribe" --- +Use the `ably channels subscribe` command to subscribe to messages on one or more Ably Pub/Sub channels. + +## Synopsis + ```shell ably channels subscribe [flags] ``` -Use the `ably channels subscribe` command to subscribe to messages on one or more Ably Pub/Sub channels. - ## Arguments Pass the following arguments to the `ably channels subscribe` command: diff --git a/src/pages/docs/cli/channels/update.mdx b/src/pages/docs/cli/channels/update.mdx index 84ead1fdcb..6aa878d8a1 100644 --- a/src/pages/docs/cli/channels/update.mdx +++ b/src/pages/docs/cli/channels/update.mdx @@ -4,14 +4,16 @@ meta_description: "Update a message on an Ably Pub/Sub channel using the CLI." meta_keywords: "ably cli, cli, channels, update, message, pub/sub, ably channels update" --- +Use the `ably channels update` command to update a message on an Ably Pub/Sub channel. + +## Synopsis + ```shell ably channels update [flags] ``` -Use the `ably channels update` command to update a message on an Ably Pub/Sub channel. - ## Arguments Pass the following arguments to the `ably channels update` command: diff --git a/src/pages/docs/cli/config/path.mdx b/src/pages/docs/cli/config/path.mdx index aa7bc2003c..f7681e2415 100644 --- a/src/pages/docs/cli/config/path.mdx +++ b/src/pages/docs/cli/config/path.mdx @@ -4,14 +4,16 @@ meta_description: "Print the path to the Ably CLI config file." meta_keywords: "ably cli, cli, config, path, configuration file, ably config path" --- +Use the `ably config path` command to print the path to the Ably CLI config file. + +## Synopsis + ```shell ably config path ``` -Use the `ably config path` command to print the path to the Ably CLI config file. - ## Global flags The following [global flags](/docs/cli#global-flags) are also available: diff --git a/src/pages/docs/cli/config/show.mdx b/src/pages/docs/cli/config/show.mdx index 8fe03d1d4c..40f467594d 100644 --- a/src/pages/docs/cli/config/show.mdx +++ b/src/pages/docs/cli/config/show.mdx @@ -4,14 +4,16 @@ meta_description: "Display the contents of the Ably CLI config file." meta_keywords: "ably cli, cli, config, show, configuration, ably config show" --- +Use the `ably config show` command to display the contents of the Ably CLI config file. + +## Synopsis + ```shell ably config show ``` -Use the `ably config show` command to display the contents of the Ably CLI config file. - ## Global flags The following [global flags](/docs/cli#global-flags) are also available: diff --git a/src/pages/docs/cli/connections/test.mdx b/src/pages/docs/cli/connections/test.mdx index 21712846e0..0c633891d6 100644 --- a/src/pages/docs/cli/connections/test.mdx +++ b/src/pages/docs/cli/connections/test.mdx @@ -4,14 +4,16 @@ meta_description: "Test connection to Ably." meta_keywords: "ably cli, cli, connections, test, connectivity, transport, ably connections test" --- +Use the `ably connections test` command to test your connection to Ably using different transport protocols. + +## Synopsis + ```shell ably connections test [flags] ``` -Use the `ably connections test` command to test your connection to Ably using different transport protocols. - ## Flags You can optionally pass the following flags to the `ably connections test` command: diff --git a/src/pages/docs/cli/help.mdx b/src/pages/docs/cli/help.mdx index 4b5441b938..0386e6810e 100644 --- a/src/pages/docs/cli/help.mdx +++ b/src/pages/docs/cli/help.mdx @@ -4,14 +4,16 @@ meta_description: "Display help information for Ably CLI commands." meta_keywords: "ably cli, cli, help, command help, ably help" --- +Use the `ably help` command to display help information for Ably CLI commands. When run without arguments, it shows the main help with all available command groups. When run with a specific command, it shows detailed help for that command. + +## Synopsis + ```shell ably help [command] ``` -Use the `ably help` command to display help information for Ably CLI commands. When run without arguments, it shows the main help with all available command groups. When run with a specific command, it shows detailed help for that command. - ## Arguments Pass the following arguments to the `ably help` command: diff --git a/src/pages/docs/cli/integrations/create.mdx b/src/pages/docs/cli/integrations/create.mdx index b7fcc92fa8..227beb813b 100644 --- a/src/pages/docs/cli/integrations/create.mdx +++ b/src/pages/docs/cli/integrations/create.mdx @@ -4,14 +4,16 @@ meta_description: "Create an integration rule using the Ably CLI." meta_keywords: "ably cli, cli, integrations, create, rule, webhook, ably integrations create" --- +Use the `ably integrations create` command to create an integration rule for your Ably application. + +## Synopsis + ```shell ably integrations create --rule-type --source-type [flags] ``` -Use the `ably integrations create` command to create an integration rule for your Ably application. - ## Flags You can pass the following flags to the `ably integrations create` command: diff --git a/src/pages/docs/cli/integrations/delete.mdx b/src/pages/docs/cli/integrations/delete.mdx index a3dd98cf3e..b634215f2c 100644 --- a/src/pages/docs/cli/integrations/delete.mdx +++ b/src/pages/docs/cli/integrations/delete.mdx @@ -4,14 +4,16 @@ meta_description: "Delete an integration rule using the Ably CLI." meta_keywords: "ably cli, cli, integrations, delete, rule, ably integrations delete" --- +Use the `ably integrations delete` command to delete an integration rule. + +## Synopsis + ```shell ably integrations delete [flags] ``` -Use the `ably integrations delete` command to delete an integration rule. - ## Arguments Pass the following arguments to the `ably integrations delete` command: diff --git a/src/pages/docs/cli/integrations/get.mdx b/src/pages/docs/cli/integrations/get.mdx index 70d90547b5..4ae9662ef6 100644 --- a/src/pages/docs/cli/integrations/get.mdx +++ b/src/pages/docs/cli/integrations/get.mdx @@ -4,14 +4,16 @@ meta_description: "Get an integration rule by ID using the Ably CLI." meta_keywords: "ably cli, cli, integrations, get, rule, ably integrations get" --- +Use the `ably integrations get` command to retrieve the details of an integration rule by its ID. + +## Synopsis + ```shell ably integrations get [flags] ``` -Use the `ably integrations get` command to retrieve the details of an integration rule by its ID. - ## Arguments Pass the following arguments to the `ably integrations get` command: diff --git a/src/pages/docs/cli/integrations/list.mdx b/src/pages/docs/cli/integrations/list.mdx index 4ad5982451..9c7e065d42 100644 --- a/src/pages/docs/cli/integrations/list.mdx +++ b/src/pages/docs/cli/integrations/list.mdx @@ -4,14 +4,16 @@ meta_description: "List all integration rules using the Ably CLI." meta_keywords: "ably cli, cli, integrations, list, rules, ably integrations list" --- +Use the `ably integrations list` command to list all integration rules for an application. + +## Synopsis + ```shell ably integrations list [flags] ``` -Use the `ably integrations list` command to list all integration rules for an application. - ## Flags You can optionally pass the following flags to the `ably integrations list` command: diff --git a/src/pages/docs/cli/integrations/update.mdx b/src/pages/docs/cli/integrations/update.mdx index 53613b63ce..5e197b5e9b 100644 --- a/src/pages/docs/cli/integrations/update.mdx +++ b/src/pages/docs/cli/integrations/update.mdx @@ -4,14 +4,16 @@ meta_description: "Update an integration rule using the Ably CLI." meta_keywords: "ably cli, cli, integrations, update, rule, ably integrations update" --- +Use the `ably integrations update` command to update an existing integration rule. + +## Synopsis + ```shell ably integrations update [flags] ``` -Use the `ably integrations update` command to update an existing integration rule. - ## Arguments Pass the following arguments to the `ably integrations update` command: diff --git a/src/pages/docs/cli/interactive.mdx b/src/pages/docs/cli/interactive.mdx index 0bf7e9d2f3..9970591d4e 100644 --- a/src/pages/docs/cli/interactive.mdx +++ b/src/pages/docs/cli/interactive.mdx @@ -4,14 +4,16 @@ meta_description: "Launch an interactive Ably CLI shell." meta_keywords: "ably cli, cli, interactive, shell, ably interactive" --- +Use the `ably interactive` command to launch an interactive shell for the Ably CLI. This provides a REPL-like experience where you can run Ably CLI commands without prefixing them with `ably`. + +## Synopsis + ```shell ably interactive ``` -Use the `ably interactive` command to launch an interactive shell for the Ably CLI. This provides a REPL-like experience where you can run Ably CLI commands without prefixing them with `ably`. - diff --git a/src/pages/docs/cli/login.mdx b/src/pages/docs/cli/login.mdx index 893e274b4b..21fcd52e30 100644 --- a/src/pages/docs/cli/login.mdx +++ b/src/pages/docs/cli/login.mdx @@ -4,14 +4,16 @@ meta_description: "Log in to your Ably account using the CLI." meta_keywords: "ably cli, cli, login, authentication, ably login" --- +Use the `ably login` command to authenticate with your Ably account. + +## Synopsis + ```shell ably login [token] [flags] ``` -Use the `ably login` command to authenticate with your Ably account. - diff --git a/src/pages/docs/cli/logs/channel-lifecycle/subscribe.mdx b/src/pages/docs/cli/logs/channel-lifecycle/subscribe.mdx index 0fb016072f..edcd3014ff 100644 --- a/src/pages/docs/cli/logs/channel-lifecycle/subscribe.mdx +++ b/src/pages/docs/cli/logs/channel-lifecycle/subscribe.mdx @@ -4,14 +4,16 @@ meta_description: "Stream logs from the channel lifecycle meta channel using the meta_keywords: "ably cli, cli, logs, channel lifecycle, subscribe, meta channel, ably logs channel-lifecycle subscribe" --- +Use the `ably logs channel-lifecycle subscribe` command to stream logs from the [meta]channel.lifecycle meta channel. + +## Synopsis + ```shell ably logs channel-lifecycle subscribe [flags] ``` -Use the `ably logs channel-lifecycle subscribe` command to stream logs from the [meta]channel.lifecycle meta channel. - ## Flags You can optionally pass the following flags to the `ably logs channel-lifecycle subscribe` command: diff --git a/src/pages/docs/cli/logs/connection-lifecycle/history.mdx b/src/pages/docs/cli/logs/connection-lifecycle/history.mdx index 8d928d0c02..172a80c213 100644 --- a/src/pages/docs/cli/logs/connection-lifecycle/history.mdx +++ b/src/pages/docs/cli/logs/connection-lifecycle/history.mdx @@ -4,14 +4,16 @@ meta_description: "Retrieve connection lifecycle log history using the Ably CLI. meta_keywords: "ably cli, cli, logs, connection lifecycle, history, ably logs connection-lifecycle history" --- +Use the `ably logs connection-lifecycle history` command to retrieve connection lifecycle log history. + +## Synopsis + ```shell ably logs connection-lifecycle history [flags] ``` -Use the `ably logs connection-lifecycle history` command to retrieve connection lifecycle log history. - ## Flags You can optionally pass the following flags to the `ably logs connection-lifecycle history` command: diff --git a/src/pages/docs/cli/logs/connection-lifecycle/subscribe.mdx b/src/pages/docs/cli/logs/connection-lifecycle/subscribe.mdx index 82e7e0b89c..eedf764066 100644 --- a/src/pages/docs/cli/logs/connection-lifecycle/subscribe.mdx +++ b/src/pages/docs/cli/logs/connection-lifecycle/subscribe.mdx @@ -4,14 +4,16 @@ meta_description: "Subscribe to live connection lifecycle logs using the Ably CL meta_keywords: "ably cli, cli, logs, connection lifecycle, subscribe, ably logs connection-lifecycle subscribe" --- +Use the `ably logs connection-lifecycle subscribe` command to subscribe to live connection lifecycle logs. + +## Synopsis + ```shell ably logs connection-lifecycle subscribe [flags] ``` -Use the `ably logs connection-lifecycle subscribe` command to subscribe to live connection lifecycle logs. - ## Flags You can optionally pass the following flags to the `ably logs connection-lifecycle subscribe` command: diff --git a/src/pages/docs/cli/logs/history.mdx b/src/pages/docs/cli/logs/history.mdx index 9c869528fc..b0811ba179 100644 --- a/src/pages/docs/cli/logs/history.mdx +++ b/src/pages/docs/cli/logs/history.mdx @@ -4,14 +4,16 @@ meta_description: "Retrieve application log history using the Ably CLI." meta_keywords: "ably cli, cli, logs, history, retrieve, ably logs history" --- +Use the `ably logs history` command to retrieve application log history. + +## Synopsis + ```shell ably logs history [flags] ``` -Use the `ably logs history` command to retrieve application log history. - ## Flags You can optionally pass the following flags to the `ably logs history` command: diff --git a/src/pages/docs/cli/logs/push/history.mdx b/src/pages/docs/cli/logs/push/history.mdx index f980325e2b..c75601fcc3 100644 --- a/src/pages/docs/cli/logs/push/history.mdx +++ b/src/pages/docs/cli/logs/push/history.mdx @@ -4,14 +4,16 @@ meta_description: "Retrieve push notification log history using the Ably CLI." meta_keywords: "ably cli, cli, logs, push, history, notifications, ably logs push history" --- +Use the `ably logs push history` command to retrieve push notification log history. + +## Synopsis + ```shell ably logs push history [flags] ``` -Use the `ably logs push history` command to retrieve push notification log history. - ## Flags You can optionally pass the following flags to the `ably logs push history` command: diff --git a/src/pages/docs/cli/logs/push/subscribe.mdx b/src/pages/docs/cli/logs/push/subscribe.mdx index f6cede6bfb..779f831edd 100644 --- a/src/pages/docs/cli/logs/push/subscribe.mdx +++ b/src/pages/docs/cli/logs/push/subscribe.mdx @@ -4,14 +4,16 @@ meta_description: "Stream logs from the push notifications meta channel using th meta_keywords: "ably cli, cli, logs, push, subscribe, notifications, meta channel, ably logs push subscribe" --- +Use the `ably logs push subscribe` command to stream logs from the push notifications meta channel. + +## Synopsis + ```shell ably logs push subscribe [flags] ``` -Use the `ably logs push subscribe` command to stream logs from the push notifications meta channel. - ## Flags You can optionally pass the following flags to the `ably logs push subscribe` command: diff --git a/src/pages/docs/cli/logs/subscribe.mdx b/src/pages/docs/cli/logs/subscribe.mdx index ad8ca10e48..56d97eb5c4 100644 --- a/src/pages/docs/cli/logs/subscribe.mdx +++ b/src/pages/docs/cli/logs/subscribe.mdx @@ -4,14 +4,16 @@ meta_description: "Subscribe to live app logs using the Ably CLI." meta_keywords: "ably cli, cli, logs, subscribe, stream, live, ably logs subscribe" --- +Use the `ably logs subscribe` command to subscribe to live app logs. + +## Synopsis + ```shell ably logs subscribe [flags] ``` -Use the `ably logs subscribe` command to subscribe to live app logs. - ## Flags You can optionally pass the following flags to the `ably logs subscribe` command: diff --git a/src/pages/docs/cli/push/batch-publish.mdx b/src/pages/docs/cli/push/batch-publish.mdx index 1313a4e0e7..a2aec6c842 100644 --- a/src/pages/docs/cli/push/batch-publish.mdx +++ b/src/pages/docs/cli/push/batch-publish.mdx @@ -4,14 +4,16 @@ meta_description: "Publish push notifications to multiple recipients in a batch meta_keywords: "ably cli, cli, push, batch-publish, notifications, batch, ably push batch-publish" --- +Use the `ably push batch-publish` command to publish push notifications to multiple recipients in a batch. + +## Synopsis + ```shell ably push batch-publish [payload] [flags] ``` -Use the `ably push batch-publish` command to publish push notifications to multiple recipients in a batch. - ## Arguments Pass the following arguments to the `ably push batch-publish` command: diff --git a/src/pages/docs/cli/push/channels/list-channels.mdx b/src/pages/docs/cli/push/channels/list-channels.mdx index 5be5dcea35..4f20fd956b 100644 --- a/src/pages/docs/cli/push/channels/list-channels.mdx +++ b/src/pages/docs/cli/push/channels/list-channels.mdx @@ -4,14 +4,16 @@ meta_description: "List channels with push subscriptions using the Ably CLI." meta_keywords: "ably cli, cli, push, channels, list-channels, subscriptions, ably push channels list-channels" --- +Use the `ably push channels list-channels` command to list channels with push subscriptions. + +## Synopsis + ```shell ably push channels list-channels [flags] ``` -Use the `ably push channels list-channels` command to list channels with push subscriptions. - ## Flags You can optionally pass the following flags to the `ably push channels list-channels` command: diff --git a/src/pages/docs/cli/push/channels/list.mdx b/src/pages/docs/cli/push/channels/list.mdx index ccd375f118..6d5c9f0c7a 100644 --- a/src/pages/docs/cli/push/channels/list.mdx +++ b/src/pages/docs/cli/push/channels/list.mdx @@ -4,14 +4,16 @@ meta_description: "List push channel subscriptions using the Ably CLI." meta_keywords: "ably cli, cli, push, channels, list, subscriptions, ably push channels list" --- +Use the `ably push channels list` command to list push channel subscriptions. + +## Synopsis + ```shell ably push channels list --channel [flags] ``` -Use the `ably push channels list` command to list push channel subscriptions. - ## Flags You can optionally pass the following flags to the `ably push channels list` command: diff --git a/src/pages/docs/cli/push/channels/remove-where.mdx b/src/pages/docs/cli/push/channels/remove-where.mdx index 7fc507101e..109873ffec 100644 --- a/src/pages/docs/cli/push/channels/remove-where.mdx +++ b/src/pages/docs/cli/push/channels/remove-where.mdx @@ -4,14 +4,16 @@ meta_description: "Remove push channel subscriptions matching filter criteria us meta_keywords: "ably cli, cli, push, channels, remove-where, filter, ably push channels remove-where" --- +Use the `ably push channels remove-where` command to remove push channel subscriptions matching filter criteria. + +## Synopsis + ```shell ably push channels remove-where --channel [flags] ``` -Use the `ably push channels remove-where` command to remove push channel subscriptions matching filter criteria. - ## Flags You can optionally pass the following flags to the `ably push channels remove-where` command: diff --git a/src/pages/docs/cli/push/channels/remove.mdx b/src/pages/docs/cli/push/channels/remove.mdx index 2b00c405e2..0a610fa109 100644 --- a/src/pages/docs/cli/push/channels/remove.mdx +++ b/src/pages/docs/cli/push/channels/remove.mdx @@ -4,14 +4,16 @@ meta_description: "Remove a push channel subscription using the Ably CLI." meta_keywords: "ably cli, cli, push, channels, remove, unsubscribe, ably push channels remove" --- +Use the `ably push channels remove` command to remove a push channel subscription. + +## Synopsis + ```shell ably push channels remove --channel [flags] ``` -Use the `ably push channels remove` command to remove a push channel subscription. - ## Flags You can optionally pass the following flags to the `ably push channels remove` command: diff --git a/src/pages/docs/cli/push/channels/save.mdx b/src/pages/docs/cli/push/channels/save.mdx index de51fc3163..0700d78495 100644 --- a/src/pages/docs/cli/push/channels/save.mdx +++ b/src/pages/docs/cli/push/channels/save.mdx @@ -4,14 +4,16 @@ meta_description: "Subscribe a device or client to push notifications on a chann meta_keywords: "ably cli, cli, push, channels, save, subscribe, device, client, ably push channels save" --- +Use the `ably push channels save` command to subscribe a device or client to push notifications on a channel. + +## Synopsis + ```shell ably push channels save --channel [flags] ``` -Use the `ably push channels save` command to subscribe a device or client to push notifications on a channel. - ## Flags You can optionally pass the following flags to the `ably push channels save` command: diff --git a/src/pages/docs/cli/push/config/clear-apns.mdx b/src/pages/docs/cli/push/config/clear-apns.mdx index e3f9c7b50e..9edbe94c7f 100644 --- a/src/pages/docs/cli/push/config/clear-apns.mdx +++ b/src/pages/docs/cli/push/config/clear-apns.mdx @@ -4,14 +4,16 @@ meta_description: "Clear APNs push notification configuration for an Ably app us meta_keywords: "ably cli, cli, push, config, clear-apns, apns, apple, ably push config clear-apns" --- +Use the `ably push config clear-apns` command to clear APNs push notification configuration for an app. + +## Synopsis + ```shell ably push config clear-apns [flags] ``` -Use the `ably push config clear-apns` command to clear APNs push notification configuration for an app. - ## Flags You can optionally pass the following flags to the `ably push config clear-apns` command: diff --git a/src/pages/docs/cli/push/config/clear-fcm.mdx b/src/pages/docs/cli/push/config/clear-fcm.mdx index 420dfe8cf3..4ffe3401e6 100644 --- a/src/pages/docs/cli/push/config/clear-fcm.mdx +++ b/src/pages/docs/cli/push/config/clear-fcm.mdx @@ -4,14 +4,16 @@ meta_description: "Clear FCM push notification configuration for an Ably app usi meta_keywords: "ably cli, cli, push, config, clear-fcm, fcm, firebase, ably push config clear-fcm" --- +Use the `ably push config clear-fcm` command to clear FCM push notification configuration for an app. + +## Synopsis + ```shell ably push config clear-fcm [flags] ``` -Use the `ably push config clear-fcm` command to clear FCM push notification configuration for an app. - ## Flags You can optionally pass the following flags to the `ably push config clear-fcm` command: diff --git a/src/pages/docs/cli/push/config/set-apns.mdx b/src/pages/docs/cli/push/config/set-apns.mdx index de78d59d1d..9e2b3de632 100644 --- a/src/pages/docs/cli/push/config/set-apns.mdx +++ b/src/pages/docs/cli/push/config/set-apns.mdx @@ -4,14 +4,16 @@ meta_description: "Configure APNs push notifications for an Ably app using the C meta_keywords: "ably cli, cli, push, config, set-apns, apns, apple, ios, ably push config set-apns" --- +Use the `ably push config set-apns` command to configure APNs push notifications for an app. + +## Synopsis + ```shell ably push config set-apns [flags] ``` -Use the `ably push config set-apns` command to configure APNs push notifications for an app. - ## Flags You can optionally pass the following flags to the `ably push config set-apns` command: diff --git a/src/pages/docs/cli/push/config/set-fcm.mdx b/src/pages/docs/cli/push/config/set-fcm.mdx index 7170a9cb1a..86752219fc 100644 --- a/src/pages/docs/cli/push/config/set-fcm.mdx +++ b/src/pages/docs/cli/push/config/set-fcm.mdx @@ -4,14 +4,16 @@ meta_description: "Configure FCM push notifications for an Ably app using the CL meta_keywords: "ably cli, cli, push, config, set-fcm, fcm, firebase, android, ably push config set-fcm" --- +Use the `ably push config set-fcm` command to configure FCM push notifications for an app. + +## Synopsis + ```shell ably push config set-fcm --service-account [flags] ``` -Use the `ably push config set-fcm` command to configure FCM push notifications for an app. - ## Flags You can optionally pass the following flags to the `ably push config set-fcm` command: diff --git a/src/pages/docs/cli/push/config/show.mdx b/src/pages/docs/cli/push/config/show.mdx index 8c072a4d63..d02e358353 100644 --- a/src/pages/docs/cli/push/config/show.mdx +++ b/src/pages/docs/cli/push/config/show.mdx @@ -4,14 +4,16 @@ meta_description: "Show push notification configuration for an Ably app using th meta_keywords: "ably cli, cli, push, config, show, configuration, ably push config show" --- +Use the `ably push config show` command to show push notification configuration for an app. + +## Synopsis + ```shell ably push config show [flags] ``` -Use the `ably push config show` command to show push notification configuration for an app. - ## Flags You can optionally pass the following flags to the `ably push config show` command: diff --git a/src/pages/docs/cli/push/devices/get.mdx b/src/pages/docs/cli/push/devices/get.mdx index 0a92e76493..1fcd5e8618 100644 --- a/src/pages/docs/cli/push/devices/get.mdx +++ b/src/pages/docs/cli/push/devices/get.mdx @@ -4,14 +4,16 @@ meta_description: "Get details of a push device registration using the Ably CLI. meta_keywords: "ably cli, cli, push, devices, get, registration, details, ably push devices get" --- +Use the `ably push devices get` command to get details of a push device registration. + +## Synopsis + ```shell ably push devices get ``` -Use the `ably push devices get` command to get details of a push device registration. - ## Arguments Pass the following arguments to the `ably push devices get` command: diff --git a/src/pages/docs/cli/push/devices/list.mdx b/src/pages/docs/cli/push/devices/list.mdx index 70ae5a4147..391a08b468 100644 --- a/src/pages/docs/cli/push/devices/list.mdx +++ b/src/pages/docs/cli/push/devices/list.mdx @@ -4,14 +4,16 @@ meta_description: "List push device registrations using the Ably CLI." meta_keywords: "ably cli, cli, push, devices, list, registrations, ably push devices list" --- +Use the `ably push devices list` command to list push device registrations. + +## Synopsis + ```shell ably push devices list [flags] ``` -Use the `ably push devices list` command to list push device registrations. - ## Flags You can optionally pass the following flags to the `ably push devices list` command: diff --git a/src/pages/docs/cli/push/devices/remove-where.mdx b/src/pages/docs/cli/push/devices/remove-where.mdx index 2a5bb634f0..1c15631a72 100644 --- a/src/pages/docs/cli/push/devices/remove-where.mdx +++ b/src/pages/docs/cli/push/devices/remove-where.mdx @@ -4,14 +4,16 @@ meta_description: "Remove push device registrations matching filter criteria usi meta_keywords: "ably cli, cli, push, devices, remove-where, filter, ably push devices remove-where" --- +Use the `ably push devices remove-where` command to remove push device registrations matching filter criteria. + +## Synopsis + ```shell ably push devices remove-where [flags] ``` -Use the `ably push devices remove-where` command to remove push device registrations matching filter criteria. - ## Flags You can optionally pass the following flags to the `ably push devices remove-where` command: diff --git a/src/pages/docs/cli/push/devices/remove.mdx b/src/pages/docs/cli/push/devices/remove.mdx index 0bbd8c40f7..11be140894 100644 --- a/src/pages/docs/cli/push/devices/remove.mdx +++ b/src/pages/docs/cli/push/devices/remove.mdx @@ -4,14 +4,16 @@ meta_description: "Remove a push device registration using the Ably CLI." meta_keywords: "ably cli, cli, push, devices, remove, unregister, ably push devices remove" --- +Use the `ably push devices remove` command to remove a push device registration. + +## Synopsis + ```shell ably push devices remove [flags] ``` -Use the `ably push devices remove` command to remove a push device registration. - ## Arguments Pass the following arguments to the `ably push devices remove` command: diff --git a/src/pages/docs/cli/push/devices/save.mdx b/src/pages/docs/cli/push/devices/save.mdx index 6c0f967da6..9a789de19a 100644 --- a/src/pages/docs/cli/push/devices/save.mdx +++ b/src/pages/docs/cli/push/devices/save.mdx @@ -4,14 +4,16 @@ meta_description: "Register or update a push device using the Ably CLI." meta_keywords: "ably cli, cli, push, devices, save, register, update, ably push devices save" --- +Use the `ably push devices save` command to register or update a push device. + +## Synopsis + ```shell ably push devices save [flags] ``` -Use the `ably push devices save` command to register or update a push device. - ## Flags You can optionally pass the following flags to the `ably push devices save` command: diff --git a/src/pages/docs/cli/push/publish.mdx b/src/pages/docs/cli/push/publish.mdx index dca3a51636..9bfc35f253 100644 --- a/src/pages/docs/cli/push/publish.mdx +++ b/src/pages/docs/cli/push/publish.mdx @@ -4,14 +4,16 @@ meta_description: "Publish a push notification to a device, client, or channel u meta_keywords: "ably cli, cli, push, publish, notification, device, client, channel, ably push publish" --- +Use the `ably push publish` command to publish a push notification to a device, client, or channel. + +## Synopsis + ```shell ably push publish [flags] ``` -Use the `ably push publish` command to publish a push notification to a device, client, or channel. - ## Flags You can optionally pass the following flags to the `ably push publish` command: diff --git a/src/pages/docs/cli/queues/create.mdx b/src/pages/docs/cli/queues/create.mdx index 9cebd82edf..70b62c918f 100644 --- a/src/pages/docs/cli/queues/create.mdx +++ b/src/pages/docs/cli/queues/create.mdx @@ -4,14 +4,16 @@ meta_description: "Create a queue using the Ably CLI." meta_keywords: "ably cli, cli, queues, create, message queue, ably queues create" --- +Use the `ably queues create` command to create a new queue for your Ably application. + +## Synopsis + ```shell ably queues create --name [flags] ``` -Use the `ably queues create` command to create a new queue for your Ably application. - ## Flags You can pass the following flags to the `ably queues create` command: diff --git a/src/pages/docs/cli/queues/delete.mdx b/src/pages/docs/cli/queues/delete.mdx index f2ab41e8e0..d61e80b847 100644 --- a/src/pages/docs/cli/queues/delete.mdx +++ b/src/pages/docs/cli/queues/delete.mdx @@ -4,14 +4,16 @@ meta_description: "Delete a queue using the Ably CLI." meta_keywords: "ably cli, cli, queues, delete, message queue, ably queues delete" --- +Use the `ably queues delete` command to delete a queue. + +## Synopsis + ```shell ably queues delete [flags] ``` -Use the `ably queues delete` command to delete a queue. - ## Arguments Pass the following arguments to the `ably queues delete` command: diff --git a/src/pages/docs/cli/queues/list.mdx b/src/pages/docs/cli/queues/list.mdx index 08e10bf5b8..f8a43bf46a 100644 --- a/src/pages/docs/cli/queues/list.mdx +++ b/src/pages/docs/cli/queues/list.mdx @@ -4,14 +4,16 @@ meta_description: "List all queues using the Ably CLI." meta_keywords: "ably cli, cli, queues, list, message queues, ably queues list" --- +Use the `ably queues list` command to list all queues for an application. + +## Synopsis + ```shell ably queues list [flags] ``` -Use the `ably queues list` command to list all queues for an application. - ## Flags You can optionally pass the following flags to the `ably queues list` command: diff --git a/src/pages/docs/cli/rooms/list.mdx b/src/pages/docs/cli/rooms/list.mdx index 9495e20e20..8336ee9791 100644 --- a/src/pages/docs/cli/rooms/list.mdx +++ b/src/pages/docs/cli/rooms/list.mdx @@ -4,14 +4,16 @@ meta_description: "List active Ably Chat rooms using the CLI." meta_keywords: "ably cli, cli, rooms, list, chat, ably rooms list" --- +Use the `ably rooms list` command to list active chat rooms. + +## Synopsis + ```shell ably rooms list [flags] ``` -Use the `ably rooms list` command to list active chat rooms. - ## Flags You can optionally pass the following flags to the `ably rooms list` command: diff --git a/src/pages/docs/cli/rooms/messages/delete.mdx b/src/pages/docs/cli/rooms/messages/delete.mdx index 5fbead78f6..426a3008ba 100644 --- a/src/pages/docs/cli/rooms/messages/delete.mdx +++ b/src/pages/docs/cli/rooms/messages/delete.mdx @@ -4,14 +4,16 @@ meta_description: "Delete a message in an Ably Chat room using the CLI." meta_keywords: "ably cli, cli, rooms, messages, delete, chat, ably rooms messages delete" --- +Use the `ably rooms messages delete` command to delete a message in an Ably Chat room. + +## Synopsis + ```shell ably rooms messages delete [flags] ``` -Use the `ably rooms messages delete` command to delete a message in an Ably Chat room. - ## Arguments Pass the following arguments to the `ably rooms messages delete` command: diff --git a/src/pages/docs/cli/rooms/messages/history.mdx b/src/pages/docs/cli/rooms/messages/history.mdx index 9b02cf1c04..200e6a2dfb 100644 --- a/src/pages/docs/cli/rooms/messages/history.mdx +++ b/src/pages/docs/cli/rooms/messages/history.mdx @@ -4,14 +4,16 @@ meta_description: "Get historical messages from an Ably Chat room using the CLI. meta_keywords: "ably cli, cli, rooms, messages, history, chat, ably rooms messages history" --- +Use the `ably rooms messages history` command to get historical messages from an Ably Chat room. + +## Synopsis + ```shell ably rooms messages history [flags] ``` -Use the `ably rooms messages history` command to get historical messages from an Ably Chat room. - ## Arguments Pass the following arguments to the `ably rooms messages history` command: diff --git a/src/pages/docs/cli/rooms/messages/reactions/remove.mdx b/src/pages/docs/cli/rooms/messages/reactions/remove.mdx index 6d77400ee6..4bc891d5e4 100644 --- a/src/pages/docs/cli/rooms/messages/reactions/remove.mdx +++ b/src/pages/docs/cli/rooms/messages/reactions/remove.mdx @@ -4,14 +4,16 @@ meta_description: "Remove a reaction from a message in an Ably Chat room using t meta_keywords: "ably cli, cli, rooms, messages, reactions, remove, chat, ably rooms messages reactions remove" --- +Use the `ably rooms messages reactions remove` command to remove a reaction from a message in a chat room. + +## Synopsis + ```shell ably rooms messages reactions remove [flags] ``` -Use the `ably rooms messages reactions remove` command to remove a reaction from a message in a chat room. - ## Arguments Pass the following arguments to the `ably rooms messages reactions remove` command: diff --git a/src/pages/docs/cli/rooms/messages/reactions/send.mdx b/src/pages/docs/cli/rooms/messages/reactions/send.mdx index 44a6f33a99..0574d9b9b4 100644 --- a/src/pages/docs/cli/rooms/messages/reactions/send.mdx +++ b/src/pages/docs/cli/rooms/messages/reactions/send.mdx @@ -4,14 +4,16 @@ meta_description: "Send a reaction to a message in an Ably Chat room using the C meta_keywords: "ably cli, cli, rooms, messages, reactions, send, chat, ably rooms messages reactions send" --- +Use the `ably rooms messages reactions send` command to send a reaction to a message in a chat room. + +## Synopsis + ```shell ably rooms messages reactions send [flags] ``` -Use the `ably rooms messages reactions send` command to send a reaction to a message in a chat room. - ## Arguments Pass the following arguments to the `ably rooms messages reactions send` command: diff --git a/src/pages/docs/cli/rooms/messages/reactions/subscribe.mdx b/src/pages/docs/cli/rooms/messages/reactions/subscribe.mdx index 21048652d4..72f8d8ca0d 100644 --- a/src/pages/docs/cli/rooms/messages/reactions/subscribe.mdx +++ b/src/pages/docs/cli/rooms/messages/reactions/subscribe.mdx @@ -4,14 +4,16 @@ meta_description: "Subscribe to message reactions in an Ably Chat room using the meta_keywords: "ably cli, cli, rooms, messages, reactions, subscribe, chat, ably rooms messages reactions subscribe" --- +Use the `ably rooms messages reactions subscribe` command to subscribe to message reactions in a chat room. + +## Synopsis + ```shell ably rooms messages reactions subscribe [flags] ``` -Use the `ably rooms messages reactions subscribe` command to subscribe to message reactions in a chat room. - ## Arguments Pass the following arguments to the `ably rooms messages reactions subscribe` command: diff --git a/src/pages/docs/cli/rooms/messages/send.mdx b/src/pages/docs/cli/rooms/messages/send.mdx index 085a25f382..7d9e0cfaaa 100644 --- a/src/pages/docs/cli/rooms/messages/send.mdx +++ b/src/pages/docs/cli/rooms/messages/send.mdx @@ -4,14 +4,16 @@ meta_description: "Send a message to an Ably Chat room using the CLI." meta_keywords: "ably cli, cli, rooms, messages, send, chat, ably rooms messages send" --- +Use the `ably rooms messages send` command to send a message to an Ably Chat room. + +## Synopsis + ```shell ably rooms messages send [flags] ``` -Use the `ably rooms messages send` command to send a message to an Ably Chat room. - diff --git a/src/pages/docs/cli/rooms/messages/subscribe.mdx b/src/pages/docs/cli/rooms/messages/subscribe.mdx index 860c1531b5..af468a3552 100644 --- a/src/pages/docs/cli/rooms/messages/subscribe.mdx +++ b/src/pages/docs/cli/rooms/messages/subscribe.mdx @@ -4,14 +4,16 @@ meta_description: "Subscribe to messages in one or more Ably Chat rooms using th meta_keywords: "ably cli, cli, rooms, messages, subscribe, chat, ably rooms messages subscribe" --- +Use the `ably rooms messages subscribe` command to subscribe to messages in one or more Ably Chat rooms. + +## Synopsis + ```shell ably rooms messages subscribe [flags] ``` -Use the `ably rooms messages subscribe` command to subscribe to messages in one or more Ably Chat rooms. - ## Arguments Pass the following arguments to the `ably rooms messages subscribe` command: diff --git a/src/pages/docs/cli/rooms/messages/update.mdx b/src/pages/docs/cli/rooms/messages/update.mdx index 657d6d6a24..d3955514a8 100644 --- a/src/pages/docs/cli/rooms/messages/update.mdx +++ b/src/pages/docs/cli/rooms/messages/update.mdx @@ -4,14 +4,16 @@ meta_description: "Update a message in an Ably Chat room using the CLI." meta_keywords: "ably cli, cli, rooms, messages, update, chat, ably rooms messages update" --- +Use the `ably rooms messages update` command to update a message in an Ably Chat room. + +## Synopsis + ```shell ably rooms messages update [flags] ``` -Use the `ably rooms messages update` command to update a message in an Ably Chat room. - ## Arguments Pass the following arguments to the `ably rooms messages update` command: diff --git a/src/pages/docs/cli/rooms/occupancy/get.mdx b/src/pages/docs/cli/rooms/occupancy/get.mdx index ea0a8931d0..4e9eb37d9c 100644 --- a/src/pages/docs/cli/rooms/occupancy/get.mdx +++ b/src/pages/docs/cli/rooms/occupancy/get.mdx @@ -4,14 +4,16 @@ meta_description: "Get current occupancy metrics for an Ably Chat room using the meta_keywords: "ably cli, cli, rooms, occupancy, get, chat, metrics, ably rooms occupancy get" --- +Use the `ably rooms occupancy get` command to get the current occupancy metrics for a chat room. + +## Synopsis + ```shell ably rooms occupancy get [flags] ``` -Use the `ably rooms occupancy get` command to get the current occupancy metrics for a chat room. - ## Arguments Pass the following arguments to the `ably rooms occupancy get` command: diff --git a/src/pages/docs/cli/rooms/occupancy/subscribe.mdx b/src/pages/docs/cli/rooms/occupancy/subscribe.mdx index ba575e89d7..5eaa05000e 100644 --- a/src/pages/docs/cli/rooms/occupancy/subscribe.mdx +++ b/src/pages/docs/cli/rooms/occupancy/subscribe.mdx @@ -4,14 +4,16 @@ meta_description: "Subscribe to real-time occupancy metrics for an Ably Chat roo meta_keywords: "ably cli, cli, rooms, occupancy, subscribe, chat, metrics, ably rooms occupancy subscribe" --- +Use the `ably rooms occupancy subscribe` command to subscribe to real-time occupancy metrics for a chat room. + +## Synopsis + ```shell ably rooms occupancy subscribe [flags] ``` -Use the `ably rooms occupancy subscribe` command to subscribe to real-time occupancy metrics for a chat room. - ## Arguments Pass the following arguments to the `ably rooms occupancy subscribe` command: diff --git a/src/pages/docs/cli/rooms/presence/enter.mdx b/src/pages/docs/cli/rooms/presence/enter.mdx index da24bd3bd7..4c17d6f64f 100644 --- a/src/pages/docs/cli/rooms/presence/enter.mdx +++ b/src/pages/docs/cli/rooms/presence/enter.mdx @@ -4,14 +4,16 @@ meta_description: "Enter presence in an Ably Chat room using the CLI." meta_keywords: "ably cli, cli, rooms, presence, enter, chat, ably rooms presence enter" --- +Use the `ably rooms presence enter` command to enter presence in a chat room and remain present until terminated. + +## Synopsis + ```shell ably rooms presence enter [flags] ``` -Use the `ably rooms presence enter` command to enter presence in a chat room and remain present until terminated. - ## Arguments Pass the following arguments to the `ably rooms presence enter` command: diff --git a/src/pages/docs/cli/rooms/presence/get.mdx b/src/pages/docs/cli/rooms/presence/get.mdx index 52a482fe1c..cb151ae841 100644 --- a/src/pages/docs/cli/rooms/presence/get.mdx +++ b/src/pages/docs/cli/rooms/presence/get.mdx @@ -4,14 +4,16 @@ meta_description: "Get current presence members in an Ably Chat room using the C meta_keywords: "ably cli, cli, rooms, presence, get, chat, members, ably rooms presence get" --- +Use the `ably rooms presence get` command to get all current presence members in a chat room. + +## Synopsis + ```shell ably rooms presence get [flags] ``` -Use the `ably rooms presence get` command to get all current presence members in a chat room. - ## Arguments Pass the following arguments to the `ably rooms presence get` command: diff --git a/src/pages/docs/cli/rooms/presence/subscribe.mdx b/src/pages/docs/cli/rooms/presence/subscribe.mdx index 8f16d3e034..d1a33c568c 100644 --- a/src/pages/docs/cli/rooms/presence/subscribe.mdx +++ b/src/pages/docs/cli/rooms/presence/subscribe.mdx @@ -4,14 +4,16 @@ meta_description: "Subscribe to presence events in an Ably Chat room using the C meta_keywords: "ably cli, cli, rooms, presence, subscribe, chat, events, ably rooms presence subscribe" --- +Use the `ably rooms presence subscribe` command to subscribe to presence events in a chat room. + +## Synopsis + ```shell ably rooms presence subscribe [flags] ``` -Use the `ably rooms presence subscribe` command to subscribe to presence events in a chat room. - ## Arguments Pass the following arguments to the `ably rooms presence subscribe` command: diff --git a/src/pages/docs/cli/rooms/reactions/send.mdx b/src/pages/docs/cli/rooms/reactions/send.mdx index c863cc513c..3632cdb2fd 100644 --- a/src/pages/docs/cli/rooms/reactions/send.mdx +++ b/src/pages/docs/cli/rooms/reactions/send.mdx @@ -4,14 +4,16 @@ meta_description: "Send a reaction in an Ably Chat room using the CLI." meta_keywords: "ably cli, cli, rooms, reactions, send, chat, emoji, ably rooms reactions send" --- +Use the `ably rooms reactions send` command to send a reaction in a chat room. + +## Synopsis + ```shell ably rooms reactions send [flags] ``` -Use the `ably rooms reactions send` command to send a reaction in a chat room. - ## Arguments Pass the following arguments to the `ably rooms reactions send` command: diff --git a/src/pages/docs/cli/rooms/reactions/subscribe.mdx b/src/pages/docs/cli/rooms/reactions/subscribe.mdx index d7829b027f..fb24a97762 100644 --- a/src/pages/docs/cli/rooms/reactions/subscribe.mdx +++ b/src/pages/docs/cli/rooms/reactions/subscribe.mdx @@ -4,14 +4,16 @@ meta_description: "Subscribe to reactions in an Ably Chat room using the CLI." meta_keywords: "ably cli, cli, rooms, reactions, subscribe, chat, emoji, ably rooms reactions subscribe" --- +Use the `ably rooms reactions subscribe` command to subscribe to reactions in a chat room. + +## Synopsis + ```shell ably rooms reactions subscribe [flags] ``` -Use the `ably rooms reactions subscribe` command to subscribe to reactions in a chat room. - ## Arguments Pass the following arguments to the `ably rooms reactions subscribe` command: diff --git a/src/pages/docs/cli/rooms/typing/keystroke.mdx b/src/pages/docs/cli/rooms/typing/keystroke.mdx index 244892d89c..faa6e53531 100644 --- a/src/pages/docs/cli/rooms/typing/keystroke.mdx +++ b/src/pages/docs/cli/rooms/typing/keystroke.mdx @@ -4,14 +4,16 @@ meta_description: "Send a typing indicator in an Ably Chat room using the CLI." meta_keywords: "ably cli, cli, rooms, typing, keystroke, chat, indicator, ably rooms typing keystroke" --- +Use the `ably rooms typing keystroke` command to send a typing indicator in an Ably Chat room. + +## Synopsis + ```shell ably rooms typing keystroke [flags] ``` -Use the `ably rooms typing keystroke` command to send a typing indicator in an Ably Chat room. - ## Arguments Pass the following arguments to the `ably rooms typing keystroke` command: diff --git a/src/pages/docs/cli/rooms/typing/subscribe.mdx b/src/pages/docs/cli/rooms/typing/subscribe.mdx index 9d080caeae..a3ba707aa0 100644 --- a/src/pages/docs/cli/rooms/typing/subscribe.mdx +++ b/src/pages/docs/cli/rooms/typing/subscribe.mdx @@ -4,14 +4,16 @@ meta_description: "Subscribe to typing indicators in an Ably Chat room using the meta_keywords: "ably cli, cli, rooms, typing, subscribe, chat, indicators, ably rooms typing subscribe" --- +Use the `ably rooms typing subscribe` command to subscribe to typing indicators in an Ably Chat room. + +## Synopsis + ```shell ably rooms typing subscribe [flags] ``` -Use the `ably rooms typing subscribe` command to subscribe to typing indicators in an Ably Chat room. - ## Arguments Pass the following arguments to the `ably rooms typing subscribe` command: diff --git a/src/pages/docs/cli/spaces/create.mdx b/src/pages/docs/cli/spaces/create.mdx index 250ed97c4d..dcd64fbb84 100644 --- a/src/pages/docs/cli/spaces/create.mdx +++ b/src/pages/docs/cli/spaces/create.mdx @@ -4,14 +4,16 @@ meta_description: "Initialize an Ably Space without entering it using the CLI." meta_keywords: "ably cli, cli, spaces, create, initialize, ably spaces create" --- +Use the `ably spaces create` command to initialize a space without entering it. + +## Synopsis + ```shell ably spaces create [flags] ``` -Use the `ably spaces create` command to initialize a space without entering it. - ## Arguments Pass the following arguments to the `ably spaces create` command: diff --git a/src/pages/docs/cli/spaces/cursors/get.mdx b/src/pages/docs/cli/spaces/cursors/get.mdx index f19a49df44..fc6472dbb0 100644 --- a/src/pages/docs/cli/spaces/cursors/get.mdx +++ b/src/pages/docs/cli/spaces/cursors/get.mdx @@ -4,14 +4,16 @@ meta_description: "Get all current cursors in an Ably Space using the CLI." meta_keywords: "ably cli, cli, spaces, cursors, get, position, ably spaces cursors get" --- +Use the `ably spaces cursors get` command to get all current cursors in a space. + +## Synopsis + ```shell ably spaces cursors get ``` -Use the `ably spaces cursors get` command to get all current cursors in a space. - ## Arguments Pass the following arguments to the `ably spaces cursors get` command: diff --git a/src/pages/docs/cli/spaces/cursors/set.mdx b/src/pages/docs/cli/spaces/cursors/set.mdx index de0d53196e..b53e5f166b 100644 --- a/src/pages/docs/cli/spaces/cursors/set.mdx +++ b/src/pages/docs/cli/spaces/cursors/set.mdx @@ -4,14 +4,16 @@ meta_description: "Set a cursor with position data in an Ably Space using the CL meta_keywords: "ably cli, cli, spaces, cursors, set, position, ably spaces cursors set" --- +Use the `ably spaces cursors set` command to set a cursor with position data in a space. + +## Synopsis + ```shell ably spaces cursors set [flags] ``` -Use the `ably spaces cursors set` command to set a cursor with position data in a space. - ## Arguments Pass the following arguments to the `ably spaces cursors set` command: diff --git a/src/pages/docs/cli/spaces/cursors/subscribe.mdx b/src/pages/docs/cli/spaces/cursors/subscribe.mdx index 4df5853dc7..e81a074770 100644 --- a/src/pages/docs/cli/spaces/cursors/subscribe.mdx +++ b/src/pages/docs/cli/spaces/cursors/subscribe.mdx @@ -4,14 +4,16 @@ meta_description: "Subscribe to cursor movements in an Ably Space using the CLI. meta_keywords: "ably cli, cli, spaces, cursors, subscribe, movements, ably spaces cursors subscribe" --- +Use the `ably spaces cursors subscribe` command to subscribe to cursor movements in a space. + +## Synopsis + ```shell ably spaces cursors subscribe [flags] ``` -Use the `ably spaces cursors subscribe` command to subscribe to cursor movements in a space. - ## Arguments Pass the following arguments to the `ably spaces cursors subscribe` command: diff --git a/src/pages/docs/cli/spaces/get.mdx b/src/pages/docs/cli/spaces/get.mdx index 9b01f2ac2e..bd55a83540 100644 --- a/src/pages/docs/cli/spaces/get.mdx +++ b/src/pages/docs/cli/spaces/get.mdx @@ -4,14 +4,16 @@ meta_description: "Get the current state of an Ably Space using the CLI." meta_keywords: "ably cli, cli, spaces, get, state, ably spaces get" --- +Use the `ably spaces get` command to get the current state of a space. + +## Synopsis + ```shell ably spaces get ``` -Use the `ably spaces get` command to get the current state of a space. - ## Arguments Pass the following arguments to the `ably spaces get` command: diff --git a/src/pages/docs/cli/spaces/list.mdx b/src/pages/docs/cli/spaces/list.mdx index ad791b59e4..67dcc4453d 100644 --- a/src/pages/docs/cli/spaces/list.mdx +++ b/src/pages/docs/cli/spaces/list.mdx @@ -4,14 +4,16 @@ meta_description: "List active Ably Spaces using the CLI." meta_keywords: "ably cli, cli, spaces, list, active, ably spaces list" --- +Use the `ably spaces list` command to list active spaces. + +## Synopsis + ```shell ably spaces list [flags] ``` -Use the `ably spaces list` command to list active spaces. - ## Flags You can optionally pass the following flags to the `ably spaces list` command: diff --git a/src/pages/docs/cli/spaces/locations/get.mdx b/src/pages/docs/cli/spaces/locations/get.mdx index b7ebf2282b..1637c5e3d1 100644 --- a/src/pages/docs/cli/spaces/locations/get.mdx +++ b/src/pages/docs/cli/spaces/locations/get.mdx @@ -4,14 +4,16 @@ meta_description: "Get all current locations in an Ably Space using the CLI." meta_keywords: "ably cli, cli, spaces, locations, get, ably spaces locations get" --- +Use the `ably spaces locations get` command to get all current locations in a space. + +## Synopsis + ```shell ably spaces locations get ``` -Use the `ably spaces locations get` command to get all current locations in a space. - ## Arguments Pass the following arguments to the `ably spaces locations get` command: diff --git a/src/pages/docs/cli/spaces/locations/set.mdx b/src/pages/docs/cli/spaces/locations/set.mdx index 75b8331c4e..5db85d58a1 100644 --- a/src/pages/docs/cli/spaces/locations/set.mdx +++ b/src/pages/docs/cli/spaces/locations/set.mdx @@ -4,14 +4,16 @@ meta_description: "Set location in an Ably Space using the CLI." meta_keywords: "ably cli, cli, spaces, locations, set, ably spaces locations set" --- +Use the `ably spaces locations set` command to set location in a space. + +## Synopsis + ```shell ably spaces locations set --location [flags] ``` -Use the `ably spaces locations set` command to set location in a space. - ## Arguments Pass the following arguments to the `ably spaces locations set` command: diff --git a/src/pages/docs/cli/spaces/locations/subscribe.mdx b/src/pages/docs/cli/spaces/locations/subscribe.mdx index ab4e97164c..79176b726f 100644 --- a/src/pages/docs/cli/spaces/locations/subscribe.mdx +++ b/src/pages/docs/cli/spaces/locations/subscribe.mdx @@ -4,14 +4,16 @@ meta_description: "Subscribe to location updates for members in an Ably Space us meta_keywords: "ably cli, cli, spaces, locations, subscribe, updates, ably spaces locations subscribe" --- +Use the `ably spaces locations subscribe` command to subscribe to location updates for members in a space. + +## Synopsis + ```shell ably spaces locations subscribe [flags] ``` -Use the `ably spaces locations subscribe` command to subscribe to location updates for members in a space. - ## Arguments Pass the following arguments to the `ably spaces locations subscribe` command: diff --git a/src/pages/docs/cli/spaces/locks/acquire.mdx b/src/pages/docs/cli/spaces/locks/acquire.mdx index ec9ff45dc7..010ba45002 100644 --- a/src/pages/docs/cli/spaces/locks/acquire.mdx +++ b/src/pages/docs/cli/spaces/locks/acquire.mdx @@ -4,14 +4,16 @@ meta_description: "Acquire a lock in an Ably Space using the CLI." meta_keywords: "ably cli, cli, spaces, locks, acquire, locking, ably spaces locks acquire" --- +Use the `ably spaces locks acquire` command to acquire a lock in a space. + +## Synopsis + ```shell ably spaces locks acquire [flags] ``` -Use the `ably spaces locks acquire` command to acquire a lock in a space. - ## Arguments Pass the following arguments to the `ably spaces locks acquire` command: diff --git a/src/pages/docs/cli/spaces/locks/get.mdx b/src/pages/docs/cli/spaces/locks/get.mdx index 11aabd63eb..2525e6f5ad 100644 --- a/src/pages/docs/cli/spaces/locks/get.mdx +++ b/src/pages/docs/cli/spaces/locks/get.mdx @@ -4,14 +4,16 @@ meta_description: "Get a lock or all locks in an Ably Space using the CLI." meta_keywords: "ably cli, cli, spaces, locks, get, ably spaces locks get" --- +Use the `ably spaces locks get` command to get a lock or all locks in a space. + +## Synopsis + ```shell ably spaces locks get [lock-id] ``` -Use the `ably spaces locks get` command to get a lock or all locks in a space. - ## Arguments Pass the following arguments to the `ably spaces locks get` command: diff --git a/src/pages/docs/cli/spaces/locks/subscribe.mdx b/src/pages/docs/cli/spaces/locks/subscribe.mdx index 3c6fe5ef46..a666a36bbc 100644 --- a/src/pages/docs/cli/spaces/locks/subscribe.mdx +++ b/src/pages/docs/cli/spaces/locks/subscribe.mdx @@ -4,14 +4,16 @@ meta_description: "Subscribe to lock events in an Ably Space using the CLI." meta_keywords: "ably cli, cli, spaces, locks, subscribe, events, ably spaces locks subscribe" --- +Use the `ably spaces locks subscribe` command to subscribe to lock events in a space. + +## Synopsis + ```shell ably spaces locks subscribe [flags] ``` -Use the `ably spaces locks subscribe` command to subscribe to lock events in a space. - ## Arguments Pass the following arguments to the `ably spaces locks subscribe` command: diff --git a/src/pages/docs/cli/spaces/members/enter.mdx b/src/pages/docs/cli/spaces/members/enter.mdx index c24b6fa56d..fe639e48dc 100644 --- a/src/pages/docs/cli/spaces/members/enter.mdx +++ b/src/pages/docs/cli/spaces/members/enter.mdx @@ -4,14 +4,16 @@ meta_description: "Enter an Ably Space and remain present until terminated using meta_keywords: "ably cli, cli, spaces, members, enter, presence, ably spaces members enter" --- +Use the `ably spaces members enter` command to enter a space and remain present until terminated. + +## Synopsis + ```shell ably spaces members enter [flags] ``` -Use the `ably spaces members enter` command to enter a space and remain present until terminated. - ## Arguments Pass the following arguments to the `ably spaces members enter` command: diff --git a/src/pages/docs/cli/spaces/members/get.mdx b/src/pages/docs/cli/spaces/members/get.mdx index 27cbfb47da..a522491345 100644 --- a/src/pages/docs/cli/spaces/members/get.mdx +++ b/src/pages/docs/cli/spaces/members/get.mdx @@ -4,14 +4,16 @@ meta_description: "Get all members in an Ably Space using the CLI." meta_keywords: "ably cli, cli, spaces, members, get, presence, ably spaces members get" --- +Use the `ably spaces members get` command to get all members in a space. + +## Synopsis + ```shell ably spaces members get ``` -Use the `ably spaces members get` command to get all members in a space. - ## Arguments Pass the following arguments to the `ably spaces members get` command: diff --git a/src/pages/docs/cli/spaces/members/subscribe.mdx b/src/pages/docs/cli/spaces/members/subscribe.mdx index cca5621528..4524c15f97 100644 --- a/src/pages/docs/cli/spaces/members/subscribe.mdx +++ b/src/pages/docs/cli/spaces/members/subscribe.mdx @@ -4,14 +4,16 @@ meta_description: "Subscribe to member presence events in an Ably Space using th meta_keywords: "ably cli, cli, spaces, members, subscribe, presence, events, ably spaces members subscribe" --- +Use the `ably spaces members subscribe` command to subscribe to member presence events in a space. + +## Synopsis + ```shell ably spaces members subscribe [flags] ``` -Use the `ably spaces members subscribe` command to subscribe to member presence events in a space. - ## Arguments Pass the following arguments to the `ably spaces members subscribe` command: diff --git a/src/pages/docs/cli/spaces/occupancy/get.mdx b/src/pages/docs/cli/spaces/occupancy/get.mdx index 565f7b2aa5..d05571035e 100644 --- a/src/pages/docs/cli/spaces/occupancy/get.mdx +++ b/src/pages/docs/cli/spaces/occupancy/get.mdx @@ -4,14 +4,16 @@ meta_description: "Get current occupancy metrics for an Ably Space using the CLI meta_keywords: "ably cli, cli, spaces, occupancy, get, metrics, ably spaces occupancy get" --- +Use the `ably spaces occupancy get` command to get current occupancy metrics for a space. + +## Synopsis + ```shell ably spaces occupancy get ``` -Use the `ably spaces occupancy get` command to get current occupancy metrics for a space. - ## Arguments Pass the following arguments to the `ably spaces occupancy get` command: diff --git a/src/pages/docs/cli/spaces/occupancy/subscribe.mdx b/src/pages/docs/cli/spaces/occupancy/subscribe.mdx index afba8da2e4..c76726a432 100644 --- a/src/pages/docs/cli/spaces/occupancy/subscribe.mdx +++ b/src/pages/docs/cli/spaces/occupancy/subscribe.mdx @@ -4,14 +4,16 @@ meta_description: "Subscribe to occupancy events on an Ably Space using the CLI. meta_keywords: "ably cli, cli, spaces, occupancy, subscribe, events, ably spaces occupancy subscribe" --- +Use the `ably spaces occupancy subscribe` command to subscribe to occupancy events on a space. + +## Synopsis + ```shell ably spaces occupancy subscribe [flags] ``` -Use the `ably spaces occupancy subscribe` command to subscribe to occupancy events on a space. - ## Arguments Pass the following arguments to the `ably spaces occupancy subscribe` command: diff --git a/src/pages/docs/cli/spaces/subscribe.mdx b/src/pages/docs/cli/spaces/subscribe.mdx index c0e7d492d8..dc8469c13a 100644 --- a/src/pages/docs/cli/spaces/subscribe.mdx +++ b/src/pages/docs/cli/spaces/subscribe.mdx @@ -4,14 +4,16 @@ meta_description: "Subscribe to member and location update events in an Ably Spa meta_keywords: "ably cli, cli, spaces, subscribe, events, members, locations, ably spaces subscribe" --- +Use the `ably spaces subscribe` command to subscribe to member and location update events in a space. + +## Synopsis + ```shell ably spaces subscribe [flags] ``` -Use the `ably spaces subscribe` command to subscribe to member and location update events in a space. - ## Arguments Pass the following arguments to the `ably spaces subscribe` command: diff --git a/src/pages/docs/cli/stats/account.mdx b/src/pages/docs/cli/stats/account.mdx index e2b623a824..b72e0c3969 100644 --- a/src/pages/docs/cli/stats/account.mdx +++ b/src/pages/docs/cli/stats/account.mdx @@ -4,14 +4,16 @@ meta_description: "Get account-level statistics with optional live updates using meta_keywords: "ably cli, cli, stats, statistics, account, live, ably stats account" --- +Use the `ably stats account` command to get account-level statistics with optional live updates. + +## Synopsis + ```shell ably stats account [flags] ``` -Use the `ably stats account` command to get account-level statistics with optional live updates. - ## Flags You can optionally pass the following flags to the `ably stats account` command: diff --git a/src/pages/docs/cli/stats/app.mdx b/src/pages/docs/cli/stats/app.mdx index b1d20304b5..cc6779abe8 100644 --- a/src/pages/docs/cli/stats/app.mdx +++ b/src/pages/docs/cli/stats/app.mdx @@ -4,14 +4,16 @@ meta_description: "Get app-level statistics with optional live updates using the meta_keywords: "ably cli, cli, stats, statistics, app, live, ably stats app" --- +Use the `ably stats app` command to get app-level statistics with optional live updates. + +## Synopsis + ```shell ably stats app [id] [flags] ``` -Use the `ably stats app` command to get app-level statistics with optional live updates. - ## Arguments Pass the following arguments to the `ably stats app` command: diff --git a/src/pages/docs/cli/status.mdx b/src/pages/docs/cli/status.mdx index cb575b5803..d827f6c985 100644 --- a/src/pages/docs/cli/status.mdx +++ b/src/pages/docs/cli/status.mdx @@ -4,14 +4,16 @@ meta_description: "Check the status of Ably services using the CLI." meta_keywords: "ably cli, cli, status, service status, ably status" --- +Use the `ably status` command to check the current status of Ably services. + +## Synopsis + ```shell ably status [flags] ``` -Use the `ably status` command to check the current status of Ably services. - ## Flags You can optionally pass the following flags to the `ably status` command: diff --git a/src/pages/docs/cli/support/ask.mdx b/src/pages/docs/cli/support/ask.mdx index 031744e746..3805a78959 100644 --- a/src/pages/docs/cli/support/ask.mdx +++ b/src/pages/docs/cli/support/ask.mdx @@ -4,14 +4,16 @@ meta_description: "Ask a question to the Ably AI agent for help using the CLI." meta_keywords: "ably cli, cli, support, ask, ai, question, ably support ask" --- +Use the `ably support ask` command to ask a question to the Ably AI agent for help. + +## Synopsis + ```shell ably support ask [flags] ``` -Use the `ably support ask` command to ask a question to the Ably AI agent for help. - ## Arguments Pass the following arguments to the `ably support ask` command: diff --git a/src/pages/docs/cli/support/contact.mdx b/src/pages/docs/cli/support/contact.mdx index 211720dee2..280d8cff21 100644 --- a/src/pages/docs/cli/support/contact.mdx +++ b/src/pages/docs/cli/support/contact.mdx @@ -4,14 +4,16 @@ meta_description: "Contact Ably for assistance using the CLI." meta_keywords: "ably cli, cli, support, contact, help, ably support contact" --- +Use the `ably support contact` command to contact Ably for assistance. This opens the Ably contact page in your default browser. + +## Synopsis + ```shell ably support contact ``` -Use the `ably support contact` command to contact Ably for assistance. This opens the Ably contact page in your default browser. - ## Examples Open the Ably contact page: diff --git a/src/pages/docs/cli/version.mdx b/src/pages/docs/cli/version.mdx index e8b6569495..d1224ad008 100644 --- a/src/pages/docs/cli/version.mdx +++ b/src/pages/docs/cli/version.mdx @@ -4,14 +4,16 @@ meta_description: "Display the version of the Ably CLI." meta_keywords: "ably cli, cli, version, ably version" --- +Use the `ably version` command to display version information for the Ably CLI, including the CLI version, platform architecture, and Node.js version. + +## Synopsis + ```shell ably version ``` -Use the `ably version` command to display version information for the Ably CLI, including the CLI version, platform architecture, and Node.js version. - ## Global flags The following [global flags](/docs/cli#global-flags) are also available: