Skip to content

Commit ea6ffd1

Browse files
umair-ablyclaude
andcommitted
docs: rephrase CLI installation and usage for clarity
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 31b8350 commit ea6ffd1

1 file changed

Lines changed: 7 additions & 9 deletions

File tree

  • src/pages/docs/platform/tools

src/pages/docs/platform/tools/cli.mdx

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ npx -p @ably/cli ably init
2727

2828
[`ably init`](/docs/cli/init) installs the Ably CLI globally, authenticates you, and installs the Ably [Agent Skills](https://github.com/ably/agent-skills) into any AI coding tools it detects on your machine, such as Claude Code, Cursor, VS Code, and Windsurf.
2929

30-
If you'd rather install the CLI yourself before running `init`, the Ably CLI is published to NPM:
30+
To install the CLI manually first, use npm and then run `ably init`:
3131

3232
<Code>
3333
```shell
@@ -37,20 +37,18 @@ ably init
3737
</Code>
3838

3939
<Aside data-type='note'>
40-
Alternatively, you can skip interactive `ably init` or `ably login` commands by using [environment variables](/docs/cli/env) to authenticate directly in scripts and CI/CD pipelines.
40+
Alternatively, you can skip the interactive `ably init` and `ably login` commands by using [environment variables](/docs/cli/env) to authenticate directly in scripts and CI/CD pipelines.
4141
</Aside>
4242

4343
## Usage
4444

45-
`ably init` authenticates using an [OAuth Device Authorization](https://datatracker.ietf.org/doc/html/rfc8628) flow: the CLI displays an authorization code and opens your browser to approve it. Once approved, the CLI receives an [access token](/docs/platform/account/access-tokens) that is stored locally and refreshed automatically, so there is no manual token management.
45+
During `ably init`, the CLI authenticates using an [OAuth Device Authorization](https://datatracker.ietf.org/doc/html/rfc8628) flow: it displays an authorization code and opens your browser to approve it. Once approved, the CLI receives an [access token](/docs/platform/account/access-tokens) that is stored locally and refreshed automatically, so there is no manual token management.
4646

4747
If you only need to authenticate, without installing Agent Skills, run [`ably login`](/docs/cli/login) instead.
4848

49-
After you have successfully authenticated and chosen your app and API key, you're ready to interact with Ably resources directly from your terminal.
49+
After authenticating and selecting your app and API key, you can interact with Ably resources directly from your terminal.
5050

51-
For example, open two terminal instances and subscribe to one, and publish messages in the other:
52-
53-
To subscribe:
51+
For example, open two terminal windows. In the first, subscribe to a channel:
5452

5553
<Code>
5654
```shell
@@ -59,7 +57,7 @@ ably channels subscribe channel-1
5957
```
6058
</Code>
6159

62-
To publish:
60+
In the second, publish messages to the same channel:
6361

6462
<Code>
6563
```shell
@@ -75,7 +73,7 @@ ably channels publish --count 5 channel-1 "Message number {{.Count}}"
7573
```
7674
</Code>
7775

78-
For a list of all available commands, run:
76+
To list all available commands, run:
7977

8078
<Code>
8179
```shell

0 commit comments

Comments
 (0)