[DX-1479] docs: simplify Ably CLI onboarding to npx @ably/cli init#3453
Merged
Conversation
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) <noreply@anthropic.com>
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
umair-ably
changed the title
npx @ably/cli initnpx @ably/cli init
AndyTWF
approved these changes
Jun 30, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Replaces the verbose Ably CLI onboarding command
npx -p @ably/cli ably initwith the simpler one-command formnpx @ably/cli initacross all docs.31 files, 32 occurrences — the CLI docs page, the
cli/initreference, and every getting-started guide (Pub/Sub, Chat, and Push, across all languages).Why
@ably/clipreviously shipped two binaries (ablyandably-interactive). npm's resolver only auto-selects an executable when a package has a single bin, sonpx @ably/cli initfailed with "could not determine executable to run" and users had to fall back to the redundantnpx -p @ably/cli ably init.ably/ably-cli#419 made the package single-bin, so
npx @ably/cli initnow resolves cleanly — matching what people expect from npx (npx neonctl init, etc.).Ready to merge
The single-bin fix shipped in
@ably/cliv1.2.1, now published to npm (latest=1.2.1, with a singleablybin).npx @ably/cli initresolves against the published version, so this is safe to merge.Scope note
Pure find-and-replace of a single unambiguous string; no surrounding prose changed (none of the pages explained the
-pflag). Verified withgit grepthat zero verbose forms remain.🤖 Generated with Claude Code