fix: update channel push CLI commands to use push publish --channel flag by maratal · Pull Request #3310 · ably/docs

maratal · 2026-04-05T23:28:41Z

Summary

Replace legacy ably channels publish with inline JSON extras in APNs, FCM, and web push getting-started guides
Use the new ably push publish --channel <name> flag with --title, --body, and --data options
Update surrounding text to match the new command style

https://ably.atlassian.net/browse/DX-927

Replace legacy `ably channels publish` with extras JSON with the new `ably push publish --channel` flag in APNs, FCM, and web push guides. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

coderabbitai · 2026-04-05T23:28:49Z

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: c8873d1c-a3f6-4b3d-abb0-99751e396d8b

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

🔍 Trigger review

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch DX-927-new-CLI-push-commands-

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.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

sacOO7 · 2026-04-14T16:05:39Z

You might like to link push related commands to #3307

… add push CLI link to next steps Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

maratal · 2026-04-24T08:07:12Z

You might like to link push related commands to #3307

Added link to Next Steps fyi @sacOO7

sacOO7

We don't use --channel flag anymore, this was replaced by CHANNEL_NAME as per ably/ably-cli#361. You should check latest ably push docs at https://ably.com/docs/cli/push/publish

Copilot

Pull request overview

Updates the Push Notifications getting-started guides to use the newer Ably CLI push publish workflow for sending channel-based pushes, replacing the legacy channels publish example that embedded push extras JSON.

Changes:

Replace the channel push example command with ably push publish --channel ... plus --title/--body and a JSON payload argument.
Update surrounding instructional text to reflect the new CLI command style.
Add a “next steps” link intended to point readers to push-related CLI options.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 6 comments.

File	Description
src/pages/docs/push/getting-started/web.mdx	Updates the channel push CLI example and adds a link to supposed push CLI command reference.
src/pages/docs/push/getting-started/fcm.mdx	Updates the channel push CLI example and adds a link to supposed push CLI command reference.
src/pages/docs/push/getting-started/apns.mdx	Updates the channel push CLI example and adds a link to supposed push CLI command reference.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

+ably push publish --channel exampleChannel1 \
+  --title "Hello" \
+  --body "World!" \
+  --message '{"name":"greeting","data":"Hello World!"}'


 * Learn about [rules](/docs/channels#rules) for channel-based push notifications.
 * Read more about the [Push Admin API](/docs/api/realtime-sdk/push-admin).
 * Check out the [Web Push Notifications](/docs/push/configure/web) documentation for advanced use cases.
+* Explore [Ably CLI push commands](/docs/cli/push) for the full list of push CLI options.


+ably push publish --channel exampleChannel1 \
+  --title "Hello" \
+  --body "World!" \
+  --message '{"name":"greeting","data":"Hello World!"}'


 * Explore [push notification administration](/docs/push#push-admin) for managing devices and subscriptions.
 * Learn about [rules](/docs/channels#rules) for channel-based push notifications.
 * Read more about the [Push Admin API](/docs/api/realtime-sdk/push-admin).
+* Explore [Ably CLI push commands](/docs/cli/push) for the full list of push CLI options.


+ably push publish --channel exampleChannel1 \
+  --title "Hello" \
+  --body "World!" \
+  --message '{"name":"greeting","data":"Hello World!"}'


 * Learn about [rules](/docs/push/channel-rules) for channel-based push notifications.
 * Read more about the [Push Admin API](/docs/api/realtime-sdk?lang=swift#push-admin).
 * Check out the [Push Notifications](/docs/push) documentation for advanced use cases.
+* Explore [Ably CLI push commands](/docs/cli/push) for the full list of push CLI options.


maratal · 2026-05-05T14:29:50Z

We don't use --channel flag anymore, this was replaced by CHANNEL_NAME as per ably/ably-cli#361. You should check latest ably push docs at https://ably.com/docs/cli/push/publish

I think in the case of push publish this flag was introduced as a way to distinguish from --device-id and --client-id flags, since we decided to collapse a long channel publish command with extras.push field into this short version of push publish with --channel and --message flags.

sacOO7 · 2026-05-05T17:57:55Z

We don't use --channel flag anymore, this was replaced by CHANNEL_NAME as per ably/ably-cli#361. You should check latest ably push docs at https://ably.com/docs/cli/push/publish

I think in the case of push publish this flag was introduced as a way to distinguish from --device-id and --client-id flags, since we decided to collapse a long channel publish command with extras.push field into this short version of push publish with --channel and --message flags.

You are right, seems it's the same way in doc as well as source code. The change was only made to ably push channels and not ably push publish so we are good.

fix: update channel push CLI commands to use push publish --channel flag

0394ba2

Replace legacy `ably channels publish` with extras JSON with the new `ably push publish --channel` flag in APNs, FCM, and web push guides. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

maratal requested a review from sacOO7 April 5, 2026 23:28

fix(push-guides): update channel CLI examples with --message flag and…

164e355

… add push CLI link to next steps Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

sacOO7 requested changes May 5, 2026

View reviewed changes

sacOO7 requested a review from Copilot May 5, 2026 11:21

Copilot started reviewing on behalf of sacOO7 May 5, 2026 11:22 View session

Copilot AI reviewed May 5, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: update channel push CLI commands to use push publish --channel flag#3310

fix: update channel push CLI commands to use push publish --channel flag#3310
maratal wants to merge 2 commits intomainfrom
DX-927-new-CLI-push-commands-

maratal commented Apr 5, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot commented Apr 5, 2026 •

edited

Loading

Review skipped

Uh oh!

sacOO7 commented Apr 14, 2026

Uh oh!

maratal commented Apr 24, 2026

Uh oh!

sacOO7 left a comment

Uh oh!

Copilot AI left a comment

Uh oh!

maratal commented May 5, 2026

Uh oh!

sacOO7 commented May 5, 2026

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

3 participants

Conversation

maratal commented Apr 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Uh oh!

coderabbitai Bot commented Apr 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Uh oh!

sacOO7 commented Apr 14, 2026

Uh oh!

maratal commented Apr 24, 2026

Uh oh!

sacOO7 left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

maratal commented May 5, 2026

Uh oh!

sacOO7 commented May 5, 2026

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

3 participants

maratal commented Apr 5, 2026 •

edited

Loading

coderabbitai Bot commented Apr 5, 2026 •

edited

Loading