Skip to content

fix: update cursor set command examples to show correct usage.#133

Open
splindsay-92 wants to merge 9 commits intomainfrom
fix/correct-spaces-set-examples
Open

fix: update cursor set command examples to show correct usage.#133
splindsay-92 wants to merge 9 commits intomainfrom
fix/correct-spaces-set-examples

Conversation

@splindsay-92
Copy link
Contributor

@splindsay-92 splindsay-92 commented Feb 9, 2026

The spaces command examples were showing the usage of a --position flag which doesn't actually exist. Updated to show correct usage or --x and --y flags.


Note

Medium Risk
Touches CI auth/bypass gating and changes the default terminal endpoint used by tests, which can affect E2E reliability and environment safety if secrets/endpoints are misconfigured.

Overview
Updates Web CLI E2E/CI to use TERMINAL_SERVER_SIGNING_SECRET as the bypass signal/secret (replacing CI_BYPASS_SECRET), wires it into GitHub Actions env + .env.test, and disables initial rate-limit delays/limits when the secret is present.

Switches the default WebSocket endpoint from wss://web-cli.ably.com to wss://web-cli-terminal.ably-dev.com across the web example app and extensive unit/E2E tests (including domain-scoped storage keys and connectivity checks), and sets NO_COLOR=1 in CI workflows.

Fixes ably spaces cursors docs/examples (README + command help) to show the correct --x/--y usage instead of a non-existent --position flag.

Written by Cursor Bugbot for commit d2971c2. This will update automatically on new commits. Configure here.

Summary by CodeRabbit

  • Documentation
    • Updated Spaces Cursors set command examples throughout the documentation, replacing the combined position payload format with separate --x and --y coordinate flags to provide clearer guidance.

@vercel
Copy link

vercel bot commented Feb 9, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
cli-web-cli Ready Ready Preview, Comment Feb 12, 2026 6:27pm

Request Review

@coderabbitai
Copy link

coderabbitai bot commented Feb 9, 2026

Walkthrough

Updated documentation and example usage across three files to reflect a change in the Ably Spaces cursors set command interface—replacing a single --position payload with separate --x and --y flags for specifying cursor coordinates.

Changes

Cohort / File(s) Summary
Documentation & Examples Update
README.md, src/commands/spaces/cursors.ts, src/commands/spaces/cursors/index.ts
Updated cursor position example usage from --position payload to separate --x and --y coordinate flags across all documentation and static example strings.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 Coordinates now dance with clarity,
No bundled position, just x and y,
Each flag stands tall, precise and merry,
Documentation blooms where examples fly! ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: updating cursor set command examples to reflect correct flag usage (--x and --y instead of --position).
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fix/correct-spaces-set-examples

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.

@splindsay-92 splindsay-92 requested a review from AndyTWF February 9, 2026 12:47
env:
E2E_ABLY_API_KEY: ${{ secrets.E2E_ABLY_API_KEY }}
E2E_ABLY_ACCESS_TOKEN: ${{ secrets.E2E_ABLY_ACCESS_TOKEN }}
TERMINAL_SERVER_SIGNING_SECRET: ${{ secrets.TERMINAL_SERVER_SIGNING_SECRET }}
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rate-limit test bypass silently enabled by signing secret

Medium Severity

The rate-limit test group now has TERMINAL_SERVER_SIGNING_SECRET set, and the bypass checks were changed from CI_BYPASS_SECRET to TERMINAL_SERVER_SIGNING_SECRET. Previously, CI_BYPASS_SECRET was intentionally excluded from the rate-limit test group (as noted in the workflow comments) so rate limiting would remain active. Now, since the signing secret doubles as the bypass flag, the test rate limiter is effectively disabled (1000 connections, 0 pause) and the global setup initial delay is skipped, undermining the rate-limit test's purpose.

Additional Locations (2)

Fix in Cursor Fix in Web

Copy link

@cursor cursor bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Bugbot Autofix is OFF. To automatically fix reported issues with Cloud Agents, enable Autofix in the Cursor dashboard.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants