-
Notifications
You must be signed in to change notification settings - Fork 0
feat: add debugging-with-ably-cli implicit skill #3
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| # debugging-with-ably-cli | ||
|
|
||
| Ably CLI debugging skill — teaches agents what's possible with the CLI and when to use each capability for diagnosing Ably issues. | ||
|
|
||
| ## Before making changes | ||
|
|
||
| Read [MAINTAINING.md](./MAINTAINING.md) for design philosophy, maintenance triggers, what NOT to add, and the validation checklist. Every change to this skill should be checked against that guide. |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| # Maintaining the debugging-with-ably-cli Skill | ||
|
|
||
| ## Design Philosophy | ||
|
|
||
| This skill teaches agents **what's possible with the Ably CLI and when to use it** — not every command, flag, and argument. The CLI is self-documenting via `--help`; agents should discover exact syntax at runtime rather than relying on this skill for command references. | ||
|
|
||
| The skill focuses on: | ||
| - **Categories of capability** (observe, simulate, manage, get help) — not individual commands | ||
| - **Diagnostic reasoning** (symptom → approach) — not step-by-step procedures | ||
| - **Domain knowledge agents lack** (state machines, persistence defaults, capability scoping, gotchas) — not documentation the CLI itself provides | ||
|
|
||
| ## Maintenance Triggers | ||
|
|
||
| When the Ably CLI (`@ably/cli`) changes, check whether the skill needs updating: | ||
|
|
||
| 1. **New top-level command group added** (e.g., a new product like `ably liveobjects`): Add to the relevant capability section (Observe, Simulate, or Manage) and to the diagnostic decision tree if it introduces new debugging scenarios. | ||
|
|
||
| 2. **New capability within existing commands** (e.g., new flags, new subscribe targets): Usually NO skill update needed — agents discover flags via `--help`. Only update if the capability changes *what's possible* at a category level. | ||
|
|
||
| 3. **Behavioral changes** (e.g., history retention changes, new connection/channel states, new error code ranges): Update the relevant reference table (connection states, channel states, key debugging facts, environment gotchas). | ||
|
|
||
| 4. **Product changes** (e.g., new Ably product, product sunset): Update the diagnostic decision tree and capability sections. | ||
|
|
||
| ## What NOT to Add | ||
|
|
||
| - Individual command syntax or flag listings — the CLI's `--help` handles this | ||
| - Step-by-step procedural workflows — research shows these degrade agent performance | ||
| - Content that duplicates the `using-ably` skill — this skill is for debugging, not building | ||
| - Full documentation of the CLI — link to `ably --help` and let agents discover | ||
|
|
||
| ## Validation Checklist | ||
|
|
||
| When updating, verify: | ||
| - [ ] Skill stays under 500 lines — token budget matters, every token is loaded into agent context on every debugging session. Bloat degrades performance. | ||
| - [ ] No command syntax is hardcoded that could go stale — capability descriptions only | ||
| - [ ] Decision tree covers all Ably products the CLI supports | ||
| - [ ] State reference tables match current SDK behavior | ||
| - [ ] No overlap with `using-ably` skill content | ||
|
|
||
| ## How to Check for CLI Changes | ||
|
|
||
| ```bash | ||
| # Check current CLI version and command groups | ||
| ably --help | ||
|
|
||
| # Compare against the capability categories in SKILL.md | ||
| # Look for new top-level commands not covered | ||
|
|
||
| # Check subcommands for each product | ||
| ably channels --help | ||
| ably rooms --help | ||
| ably spaces --help | ||
| ably logs --help | ||
| ably bench --help | ||
| ably integrations --help | ||
| ably queues --help | ||
| ably auth --help | ||
| ably apps --help | ||
| ably support --help | ||
| ``` | ||
|
|
||
| If a new command group appears that isn't covered in the capability sections, the skill needs updating. If only flags/options change within existing commands, no update is needed. | ||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.