From 34e691d2256eee3a28dc8807092a79a1b29c5e52 Mon Sep 17 00:00:00 2001 From: umair Date: Tue, 30 Jun 2026 17:14:59 +0100 Subject: [PATCH] docs: simplify Ably CLI onboarding to `npx @ably/cli init` The CLI previously shipped two bins (`ably` and `ably-interactive`), so npx could not auto-select an executable and the docs had to use the verbose `npx -p @ably/cli ably init`. As of @ably/cli v1.2.1 the package is single-bin, so `npx @ably/cli init` resolves directly. Update all onboarding snippets to the simpler one-command form. See ably/ably-cli#419. Co-Authored-By: Claude Opus 4.8 (1M context) --- src/pages/docs/chat/getting-started/android.mdx | 2 +- src/pages/docs/chat/getting-started/javascript.mdx | 2 +- src/pages/docs/chat/getting-started/jvm.mdx | 2 +- src/pages/docs/chat/getting-started/react-native.mdx | 2 +- src/pages/docs/chat/getting-started/react-ui-kit.mdx | 2 +- src/pages/docs/chat/getting-started/react.mdx | 2 +- src/pages/docs/chat/getting-started/swift-async-sequence.mdx | 2 +- src/pages/docs/chat/getting-started/swift.mdx | 2 +- src/pages/docs/cli/init.mdx | 4 ++-- src/pages/docs/getting-started/dotnet.mdx | 2 +- src/pages/docs/getting-started/flutter.mdx | 2 +- src/pages/docs/getting-started/go.mdx | 2 +- src/pages/docs/getting-started/java.mdx | 2 +- src/pages/docs/getting-started/javascript.mdx | 2 +- src/pages/docs/getting-started/kotlin.mdx | 2 +- src/pages/docs/getting-started/laravel.mdx | 2 +- src/pages/docs/getting-started/nextjs.mdx | 2 +- src/pages/docs/getting-started/node.mdx | 2 +- src/pages/docs/getting-started/objective-c.mdx | 2 +- src/pages/docs/getting-started/php.mdx | 2 +- src/pages/docs/getting-started/python.mdx | 2 +- src/pages/docs/getting-started/react-native.mdx | 2 +- src/pages/docs/getting-started/react.mdx | 2 +- src/pages/docs/getting-started/ruby.mdx | 2 +- src/pages/docs/getting-started/swift.mdx | 2 +- src/pages/docs/platform/tools/cli.mdx | 2 +- src/pages/docs/push/getting-started/apns.mdx | 2 +- src/pages/docs/push/getting-started/fcm.mdx | 2 +- src/pages/docs/push/getting-started/flutter.mdx | 2 +- src/pages/docs/push/getting-started/react-native.mdx | 2 +- src/pages/docs/push/getting-started/web.mdx | 2 +- 31 files changed, 32 insertions(+), 32 deletions(-) diff --git a/src/pages/docs/chat/getting-started/android.mdx b/src/pages/docs/chat/getting-started/android.mdx index 955e2873bb..0336d1d3c6 100644 --- a/src/pages/docs/chat/getting-started/android.mdx +++ b/src/pages/docs/chat/getting-started/android.mdx @@ -48,7 +48,7 @@ Use the [Ably CLI](/docs/platform/tools/cli) as an additional client to quickly ```shell -npx -p @ably/cli ably init +npx @ably/cli init ``` diff --git a/src/pages/docs/chat/getting-started/javascript.mdx b/src/pages/docs/chat/getting-started/javascript.mdx index 9fb298ee8e..189682de4b 100644 --- a/src/pages/docs/chat/getting-started/javascript.mdx +++ b/src/pages/docs/chat/getting-started/javascript.mdx @@ -66,7 +66,7 @@ Use the [Ably CLI](/docs/platform/tools/cli) as an additional client to quickly ```shell -npx -p @ably/cli ably init +npx @ably/cli init ``` diff --git a/src/pages/docs/chat/getting-started/jvm.mdx b/src/pages/docs/chat/getting-started/jvm.mdx index c968521f02..d4c26af74d 100644 --- a/src/pages/docs/chat/getting-started/jvm.mdx +++ b/src/pages/docs/chat/getting-started/jvm.mdx @@ -63,7 +63,7 @@ Use the [Ably CLI](/docs/platform/tools/cli) as an additional client to quickly ```shell -npx -p @ably/cli ably init +npx @ably/cli init ``` diff --git a/src/pages/docs/chat/getting-started/react-native.mdx b/src/pages/docs/chat/getting-started/react-native.mdx index 5b7f7932f0..492e94dbcc 100644 --- a/src/pages/docs/chat/getting-started/react-native.mdx +++ b/src/pages/docs/chat/getting-started/react-native.mdx @@ -57,7 +57,7 @@ Use the [Ably CLI](/docs/platform/tools/cli) as an additional client to quickly ```shell -npx -p @ably/cli ably init +npx @ably/cli init ``` diff --git a/src/pages/docs/chat/getting-started/react-ui-kit.mdx b/src/pages/docs/chat/getting-started/react-ui-kit.mdx index 1c0c7f735a..a924d1ac86 100644 --- a/src/pages/docs/chat/getting-started/react-ui-kit.mdx +++ b/src/pages/docs/chat/getting-started/react-ui-kit.mdx @@ -71,7 +71,7 @@ Use the [Ably CLI](/docs/platform/tools/cli) as an additional client to quickly ```shell -npx -p @ably/cli ably init +npx @ably/cli init ``` diff --git a/src/pages/docs/chat/getting-started/react.mdx b/src/pages/docs/chat/getting-started/react.mdx index 4715a235d1..a02d5ce63e 100644 --- a/src/pages/docs/chat/getting-started/react.mdx +++ b/src/pages/docs/chat/getting-started/react.mdx @@ -64,7 +64,7 @@ Use the [Ably CLI](/docs/platform/tools/cli) as an additional client to quickly ```shell -npx -p @ably/cli ably init +npx @ably/cli init ``` diff --git a/src/pages/docs/chat/getting-started/swift-async-sequence.mdx b/src/pages/docs/chat/getting-started/swift-async-sequence.mdx index 73552e0d28..d91c989efe 100644 --- a/src/pages/docs/chat/getting-started/swift-async-sequence.mdx +++ b/src/pages/docs/chat/getting-started/swift-async-sequence.mdx @@ -29,7 +29,7 @@ Use the [Ably CLI](/docs/platform/tools/cli) as an additional client to quickly ```shell -npx -p @ably/cli ably init +npx @ably/cli init ``` diff --git a/src/pages/docs/chat/getting-started/swift.mdx b/src/pages/docs/chat/getting-started/swift.mdx index b66811ce61..e96af07799 100644 --- a/src/pages/docs/chat/getting-started/swift.mdx +++ b/src/pages/docs/chat/getting-started/swift.mdx @@ -29,7 +29,7 @@ Use the [Ably CLI](/docs/platform/tools/cli) as an additional client to quickly ```shell -npx -p @ably/cli ably init +npx @ably/cli init ``` diff --git a/src/pages/docs/cli/init.mdx b/src/pages/docs/cli/init.mdx index c44169d305..d2f449a6b7 100644 --- a/src/pages/docs/cli/init.mdx +++ b/src/pages/docs/cli/init.mdx @@ -27,7 +27,7 @@ You can also run `init` without installing the CLI first: ```shell -npx -p @ably/cli ably init +npx @ably/cli init ``` @@ -89,7 +89,7 @@ Set up the CLI without installing it first: ```shell -npx -p @ably/cli ably init +npx @ably/cli init ``` diff --git a/src/pages/docs/getting-started/dotnet.mdx b/src/pages/docs/getting-started/dotnet.mdx index a07f904f00..56a5a3cb78 100644 --- a/src/pages/docs/getting-started/dotnet.mdx +++ b/src/pages/docs/getting-started/dotnet.mdx @@ -45,7 +45,7 @@ Use the [Ably CLI](/docs/platform/tools/cli) as an additional client to quickly ```shell -npx -p @ably/cli ably init +npx @ably/cli init ``` diff --git a/src/pages/docs/getting-started/flutter.mdx b/src/pages/docs/getting-started/flutter.mdx index 76cd7b6469..9d9ec20e13 100644 --- a/src/pages/docs/getting-started/flutter.mdx +++ b/src/pages/docs/getting-started/flutter.mdx @@ -171,7 +171,7 @@ Use the [Ably CLI](/docs/platform/tools/cli) as an additional client to quickly ```shell -npx -p @ably/cli ably init +npx @ably/cli init ``` diff --git a/src/pages/docs/getting-started/go.mdx b/src/pages/docs/getting-started/go.mdx index 7cc82e520e..99b1c8b28e 100644 --- a/src/pages/docs/getting-started/go.mdx +++ b/src/pages/docs/getting-started/go.mdx @@ -38,7 +38,7 @@ Use the [Ably CLI](/docs/platform/tools/cli) as an additional client to quickly ```shell -npx -p @ably/cli ably init +npx @ably/cli init ``` diff --git a/src/pages/docs/getting-started/java.mdx b/src/pages/docs/getting-started/java.mdx index 9347cf7351..b5b1a555f3 100644 --- a/src/pages/docs/getting-started/java.mdx +++ b/src/pages/docs/getting-started/java.mdx @@ -56,7 +56,7 @@ Use the [Ably CLI](/docs/platform/tools/cli) as an additional client to quickly ```shell -npx -p @ably/cli ably init +npx @ably/cli init ``` diff --git a/src/pages/docs/getting-started/javascript.mdx b/src/pages/docs/getting-started/javascript.mdx index 0848729f76..b8ef1de6b1 100644 --- a/src/pages/docs/getting-started/javascript.mdx +++ b/src/pages/docs/getting-started/javascript.mdx @@ -30,7 +30,7 @@ Use the [Ably CLI](/docs/platform/tools/cli) as an additional client to quickly ```shell -npx -p @ably/cli ably init +npx @ably/cli init ``` diff --git a/src/pages/docs/getting-started/kotlin.mdx b/src/pages/docs/getting-started/kotlin.mdx index bdf969c865..32b0515a14 100644 --- a/src/pages/docs/getting-started/kotlin.mdx +++ b/src/pages/docs/getting-started/kotlin.mdx @@ -35,7 +35,7 @@ Use the [Ably CLI](/docs/platform/tools/cli) as an additional client to quickly ```shell -npx -p @ably/cli ably init +npx @ably/cli init ``` diff --git a/src/pages/docs/getting-started/laravel.mdx b/src/pages/docs/getting-started/laravel.mdx index ec759f0661..f7e56ddc27 100644 --- a/src/pages/docs/getting-started/laravel.mdx +++ b/src/pages/docs/getting-started/laravel.mdx @@ -54,7 +54,7 @@ Use the [Ably CLI](/docs/platform/tools/cli) as an additional client to quickly ```shell -npx -p @ably/cli ably init +npx @ably/cli init ``` diff --git a/src/pages/docs/getting-started/nextjs.mdx b/src/pages/docs/getting-started/nextjs.mdx index 851aa2b2cc..f8d2623a3d 100644 --- a/src/pages/docs/getting-started/nextjs.mdx +++ b/src/pages/docs/getting-started/nextjs.mdx @@ -90,7 +90,7 @@ Use the [Ably CLI](/docs/platform/tools/cli) as an additional client to quickly ```shell -npx -p @ably/cli ably init +npx @ably/cli init ``` diff --git a/src/pages/docs/getting-started/node.mdx b/src/pages/docs/getting-started/node.mdx index 0271265f71..5280642e3c 100644 --- a/src/pages/docs/getting-started/node.mdx +++ b/src/pages/docs/getting-started/node.mdx @@ -48,7 +48,7 @@ Use the [Ably CLI](/docs/platform/tools/cli) as an additional client to quickly ```shell -npx -p @ably/cli ably init +npx @ably/cli init ``` diff --git a/src/pages/docs/getting-started/objective-c.mdx b/src/pages/docs/getting-started/objective-c.mdx index fd9f87adf0..74e01c7650 100644 --- a/src/pages/docs/getting-started/objective-c.mdx +++ b/src/pages/docs/getting-started/objective-c.mdx @@ -50,7 +50,7 @@ Use the [Ably CLI](/docs/platform/tools/cli) as an additional client to quickly ```shell -npx -p @ably/cli ably init +npx @ably/cli init ``` diff --git a/src/pages/docs/getting-started/php.mdx b/src/pages/docs/getting-started/php.mdx index 8e0f6536cf..576a4a6bbc 100644 --- a/src/pages/docs/getting-started/php.mdx +++ b/src/pages/docs/getting-started/php.mdx @@ -48,7 +48,7 @@ Use the [Ably CLI](/docs/platform/tools/cli) as an additional client to quickly ```shell -npx -p @ably/cli ably init +npx @ably/cli init ``` diff --git a/src/pages/docs/getting-started/python.mdx b/src/pages/docs/getting-started/python.mdx index 8786ca389d..724c4f426d 100644 --- a/src/pages/docs/getting-started/python.mdx +++ b/src/pages/docs/getting-started/python.mdx @@ -45,7 +45,7 @@ Use the [Ably CLI](/docs/platform/tools/cli) as an additional client to quickly ```shell -npx -p @ably/cli ably init +npx @ably/cli init ``` diff --git a/src/pages/docs/getting-started/react-native.mdx b/src/pages/docs/getting-started/react-native.mdx index b16403e283..6f16785f9e 100644 --- a/src/pages/docs/getting-started/react-native.mdx +++ b/src/pages/docs/getting-started/react-native.mdx @@ -149,7 +149,7 @@ Use the [Ably CLI](/docs/platform/tools/cli) as an additional client to quickly ```shell -npx -p @ably/cli ably init +npx @ably/cli init ``` diff --git a/src/pages/docs/getting-started/react.mdx b/src/pages/docs/getting-started/react.mdx index 67980f5582..bf5e9e7b48 100644 --- a/src/pages/docs/getting-started/react.mdx +++ b/src/pages/docs/getting-started/react.mdx @@ -157,7 +157,7 @@ Use the [Ably CLI](/docs/platform/tools/cli) as an additional client to quickly ```shell -npx -p @ably/cli ably init +npx @ably/cli init ``` diff --git a/src/pages/docs/getting-started/ruby.mdx b/src/pages/docs/getting-started/ruby.mdx index 6825fab279..7ffd2dd6ef 100644 --- a/src/pages/docs/getting-started/ruby.mdx +++ b/src/pages/docs/getting-started/ruby.mdx @@ -43,7 +43,7 @@ Use the [Ably CLI](/docs/platform/tools/cli) as an additional client to quickly ```shell -npx -p @ably/cli ably init +npx @ably/cli init ``` diff --git a/src/pages/docs/getting-started/swift.mdx b/src/pages/docs/getting-started/swift.mdx index da997b887e..140c91d679 100644 --- a/src/pages/docs/getting-started/swift.mdx +++ b/src/pages/docs/getting-started/swift.mdx @@ -41,7 +41,7 @@ Use the [Ably CLI](/docs/platform/tools/cli) as an additional client to quickly ```shell -npx -p @ably/cli ably init +npx @ably/cli init ``` diff --git a/src/pages/docs/platform/tools/cli.mdx b/src/pages/docs/platform/tools/cli.mdx index af98ef723d..c3b951952f 100644 --- a/src/pages/docs/platform/tools/cli.mdx +++ b/src/pages/docs/platform/tools/cli.mdx @@ -21,7 +21,7 @@ Get started in a single command: ```shell -npx -p @ably/cli ably init +npx @ably/cli init ``` diff --git a/src/pages/docs/push/getting-started/apns.mdx b/src/pages/docs/push/getting-started/apns.mdx index 9e56d15871..0c3dacb2c6 100644 --- a/src/pages/docs/push/getting-started/apns.mdx +++ b/src/pages/docs/push/getting-started/apns.mdx @@ -31,7 +31,7 @@ Use the [Ably CLI](/docs/platform/tools/cli) as an additional client to quickly ```shell -npx -p @ably/cli ably init +npx @ably/cli init ``` diff --git a/src/pages/docs/push/getting-started/fcm.mdx b/src/pages/docs/push/getting-started/fcm.mdx index 53edaa68f5..6f611ed585 100644 --- a/src/pages/docs/push/getting-started/fcm.mdx +++ b/src/pages/docs/push/getting-started/fcm.mdx @@ -30,7 +30,7 @@ Use the [Ably CLI](/docs/platform/tools/cli) as an additional client to quickly ```shell -npx -p @ably/cli ably init +npx @ably/cli init ``` diff --git a/src/pages/docs/push/getting-started/flutter.mdx b/src/pages/docs/push/getting-started/flutter.mdx index ac08c952fd..72c4aa00a0 100644 --- a/src/pages/docs/push/getting-started/flutter.mdx +++ b/src/pages/docs/push/getting-started/flutter.mdx @@ -26,7 +26,7 @@ Use the [Ably CLI](/docs/platform/tools/cli) as an additional client to quickly ```shell -npx -p @ably/cli ably init +npx @ably/cli init ``` diff --git a/src/pages/docs/push/getting-started/react-native.mdx b/src/pages/docs/push/getting-started/react-native.mdx index 61026d18b5..0642e84ebd 100644 --- a/src/pages/docs/push/getting-started/react-native.mdx +++ b/src/pages/docs/push/getting-started/react-native.mdx @@ -28,7 +28,7 @@ Use the [Ably CLI](/docs/platform/tools/cli) as an additional client to quickly ```shell -npx -p @ably/cli ably init +npx @ably/cli init ``` diff --git a/src/pages/docs/push/getting-started/web.mdx b/src/pages/docs/push/getting-started/web.mdx index ee88090da2..3224e97be7 100644 --- a/src/pages/docs/push/getting-started/web.mdx +++ b/src/pages/docs/push/getting-started/web.mdx @@ -30,7 +30,7 @@ Use the [Ably CLI](/docs/platform/tools/cli) as an additional client to quickly ```shell -npx -p @ably/cli ably init +npx @ably/cli init ```