[DX-329] Implemented reference documentation for ably-cli tool

.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

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
+
+<Code>
+```shell
+ably accounts current [flags]
+```
+</Code>
+
+## 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:
+
+<Code>
+```shell
+ably accounts current
+```
+</Code>
+
+Display the current account in JSON format:
+
+<Code>
+```shell
+ably accounts current --json
+```
+</Code>

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. |

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
+
+<Code>
+```shell
+ably accounts list [flags]
+```
+</Code>
+
+## 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:
+
+<Code>
+```shell
+ably accounts list
+```
+</Code>
+
+List all configured accounts in JSON format:
+
+<Code>
+```shell
+ably accounts list --json
+```
+</Code>

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
+
+<Code>
+```shell
+ably accounts login [token] [flags]
+```
+</Code>
+
+## Arguments
+
+### `token` <a id="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` <a id="alias"/>
+
+Set an alias name for this account. This enables you to easily switch between multiple accounts.
+
+### `--no-browser` <a id="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:
+
+<Code>
+```shell
+ably accounts login
+```
+</Code>
+
+Log in and set an alias for the account:
+
+<Code>
+```shell
+ably accounts login --alias work
+```
+</Code>
+
+Log in without opening a browser:
+
+<Code>
+```shell
+ably accounts login --no-browser
+```
+</Code>

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
+
+<Code>
+```shell
+ably accounts logout [alias] [flags]
+```
+</Code>
+
+## Arguments
+
+### `alias` <a id="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` <a id="force"/>
+
+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:
+
+<Code>
+```shell
+ably accounts logout
+```
+</Code>
+
+Log out from a specific account by alias:
+
+<Code>
+```shell
+ably accounts logout work
+```
+</Code>
+
+Log out without confirmation:
+
+<Code>
+```shell
+ably accounts logout --force
+```
+</Code>

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
+
+<Code>
+```shell
+ably accounts switch [alias]
+```
+</Code>
+
+## Arguments
+
+### `alias` <a id="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:
+
+<Code>
+```shell
+ably accounts switch
+```
+</Code>
+
+Switch to a specific account by alias:
+
+<Code>
+```shell
+ably accounts switch work
+```
+</Code>

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"
+---
+
+<Code>
+```shell
+ably apps create --name <name> [flags]
+```
+</Code>
+
+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` <a id="name"/>
+
+The name of the application to create. This flag is required.
+
+### `--tls-only` <a id="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:
+
+<Code>
+```shell
+ably apps create --name "my-app"
+```
+</Code>
+
+Create an application restricted to TLS connections only:
+
+<Code>
+```shell
+ably apps create --name "secure-app" --tls-only
+```
+</Code>

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"
+---
+
+<Code>
+```shell
+ably apps current
+```
+</Code>
+
+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:
+
+<Code>
+```shell
+ably apps current
+```
+</Code>
+
+Show the currently selected app in JSON format:
+
+<Code>
+```shell
+ably apps current --json
+```
+</Code>