Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -297,6 +297,10 @@ See `writing-style-guide.md` for full details. Key points:
- Avoid em-dashes, Latin abbreviations (use "for example" not "e.g."), and slang
- Avoid bold prefixes in bullet points

## CLI reference docs (`src/pages/docs/cli/`)

CLI command pages use **kebab-case** for argument and flag placeholders (for example `<channel-name>`, `[lock-id]`, `--client-id`), even when the upstream oclif autogenerated reference uses `SNAKE_CASE`/uppercase (for example `CHANNEL_NAME`). This case difference is the deliberate doc convention — do not "fix" pages to match oclif casing.

## Testing

Tests use Jest with React Testing Library. Test files are colocated with source files as `*.test.tsx` or `*.test.ts`.
Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/cli/apps/current.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Use the `ably apps current` command to display information about the currently s

<Code>
```shell
ably apps current
ably apps current [options]
```
</Code>

Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/cli/apps/delete.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ ably apps delete [app-id] [options]
```
</Code>

<Aside data-type="important">
<Aside data-type='important'>
Deleting an application is irreversible. All data associated with the application, including API keys, channels, and message history, will be permanently removed.
</Aside>

Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/cli/apps/rules/update.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ The name or ID of the channel rule to update.

## Options

<Aside data-type="note">
<Aside data-type='note'>
Boolean options support a `--no-` prefix to disable the option. For example, use `--no-persisted` to disable message persistence.
</Aside>

Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/cli/apps/update.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ The app name or ID to update.

## Options

<Aside data-type="note">
<Aside data-type='note'>
Boolean options support a `--no-` prefix to disable the option. For example, use `--no-tls-only` to allow non-TLS connections.
</Aside>

Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/cli/auth/revoke-token.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ ably auth revoke-token [options]
```
</Code>

<Aside data-type="important">
<Aside data-type='important'>
Token revocation is irreversible. All tokens matching the supplied target are revoked, and any clients using those tokens will need to obtain new ones.
</Aside>

Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/cli/autocomplete.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Use the `ably autocomplete` command to display installation instructions for she

<Code>
```shell
ably autocomplete [shell]
ably autocomplete [shell] [options]
```
</Code>

Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/cli/config/path.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Use the `ably config path` command to print the path to the Ably CLI config file

<Code>
```shell
ably config path
ably config path [options]
```
</Code>

Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/cli/config/show.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Use the `ably config show` command to display the contents of the Ably CLI confi

<Code>
```shell
ably config show
ably config show [options]
```
</Code>

Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/cli/env.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ ably env ABLY_API_KEY --json

## Usage

<Aside data-type="note">
<Aside data-type='note'>
The CLI does not automatically load `.env` files. Set environment variables in your shell, CI/CD configuration, or inline with your commands.
</Aside>
Comment thread
sacOO7 marked this conversation as resolved.

Expand Down
4 changes: 2 additions & 2 deletions src/pages/docs/cli/interactive.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ Use the `ably interactive` command to launch an interactive shell for the Ably C

<Code>
```shell
ably interactive
ably interactive [options]
```
</Code>

<Aside data-type="note">
<Aside data-type='note'>
This feature is in ALPHA and may change in future releases.
</Aside>

Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/cli/login.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ ably login [options]
```
</Code>

<Aside data-type="note">
<Aside data-type='note'>
This command is an alias for [`ably accounts login`](/docs/cli/accounts/login).
</Aside>

Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/cli/push/devices/get.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Use the `ably push devices get` command to get details of a push device registra

<Code>
```shell
ably push devices get <device-id>
ably push devices get <device-id> [options]
```
</Code>

Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/cli/spaces/cursors/get.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Use the `ably spaces cursors get` command to get all current cursors in a space.

<Code>
```shell
ably spaces cursors get <space-name>
ably spaces cursors get <space-name> [options]
```
</Code>

Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/cli/spaces/get.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Use the `ably spaces get` command to get the current state of a space.

<Code>
```shell
ably spaces get <space-name>
ably spaces get <space-name> [options]
```
</Code>

Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/cli/spaces/locations/get.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Use the `ably spaces locations get` command to get all current locations in a sp

<Code>
```shell
ably spaces locations get <space-name>
ably spaces locations get <space-name> [options]
```
</Code>

Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/cli/spaces/locks/get.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Use the `ably spaces locks get` command to get a lock or all locks in a space.

<Code>
```shell
ably spaces locks get <space-name> [lock-id]
ably spaces locks get <space-name> [lock-id] [options]
```
</Code>

Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/cli/spaces/members/get.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Use the `ably spaces members get` command to get all members in a space.

<Code>
```shell
ably spaces members get <space-name>
ably spaces members get <space-name> [options]
```
</Code>

Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/cli/spaces/occupancy/get.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Use the `ably spaces occupancy get` command to get current occupancy metrics for

<Code>
```shell
ably spaces occupancy get <space-name>
ably spaces occupancy get <space-name> [options]
```
</Code>

Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/cli/version.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Use the `ably version` command to display version information for the Ably CLI,

<Code>
```shell
ably version
ably version [options]
```
</Code>

Expand Down