[DX-1136] Fix inconsistency in accepting both Name or ID in commands by sacOO7 · Pull Request #369 · ably/ably-cli

sacOO7 · 2026-04-23T07:36:47Z

Fixes https://ably.atlassian.net/browse/DX-1136
Commands that previously accepted only an app ID, queue ID, or rule ID as their positional argument now accept
either a name or ID, resolving via resolveAppIdFromNameOrId (for apps) or list-then-match (for queues/rules)
Adds helpful error hints in error message when a resource is not found (e.g., Run "ably queues list" to see available queues.)

Changed commands

Command	Previous Argument	New Argument
`accounts logout`	`ACCOUNT_ALIAS` (alias only)	`ACCOUNT_ALIAS_OR_ID` (alias or account ID) — account ID is shown by `accounts list` but wasn't accepted as input
`accounts switch`	`ACCOUNT_ALIAS` (alias only)	`ACCOUNT_ALIAS_OR_ID` (alias or account ID) — account ID is shown by `accounts list` but wasn't accepted as input
`apps update`	`APP_ID` (app ID)	`APP_NAME_OR_ID` (app name or ID) — consistent with `apps switch`; resolved via `listApps()`
`apps switch`	`APP_ID` (app ID)	`APP_NAME_OR_ID` (app name or ID) — consistent with `apps update`; resolved via `listApps()`
`queues delete`	`QUEUE_ID` (queue ID)	`QUEUE_NAME_OR_ID` (queue name or ID) — resolved via `listQueues()` match by name then ID
`stats app`	`APP_ID` (app ID)	`APP_NAME_OR_ID` (app name or ID) — consistent with `apps update/switch`; resolved via `listApps()`
`apps rules delete`	`NAME_OR_ID` (rule ID only)	`RULE_NAME_OR_ID` (rule name or ID) — for rules, ID and name are the same; renamed for clarity
`apps rules update`	`NAME_OR_ID` (rule ID only)	`RULE_NAME_OR_ID` (rule name or ID) — for rules, ID and name are the same; renamed for clarity
`auth keys get/revoke`	`KEY_NAME`, `KEY_LABEL`, `KEY_ID` or `KEY_VALUE`	`KEY_NAME_OR_VALUE` (Key name "appId.keyId" or value "appId.keyId:keySecret") — Check comment #369 (comment)
`auth keys switch/update`	`KEY_NAME` or `KEY_ID`	`KEY_NAME_OR_VALUE` (Key name "appId.keyId" or value "appId.keyId:keySecret") — Check comment #369 (comment)

Unchanged commands

Command	Argument	Reason
`apps delete`	`APP_ID`	Uses a two-step destructive confirmation flow that prompts the user to type the app name explicitly — accepting name-or-ID at the argument level would conflict with this verification step
`integrations delete/get/update`	`INTEGRATION_ID`	Integrations have no user-facing name — only system-generated IDs
`push devices get/remove`	`DEVICE_ID`	Device IDs are client-generated, no "name" concept exists
`spaces locks acquire/get`	`LOCK_ID`	Lock IDs are application-defined, no alternative name exists

TODO

- Remove hint specific code, can be merged into the error message itself.
- Checks keys specific updated nameOrId commands.
- Resolve all copilot comments.
- Check if command description/examples are well updated.
- Test updated commands

vercel · 2026-04-23T07:36:52Z

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

Project	Deployment	Actions	Updated (UTC)
cli-web-cli	Ready	Preview, Comment	Apr 28, 2026 5:00pm

auth keys revoke/update: Accept key name (APP_ID.KEY_ID), key ID, key label, or full key value — matching keys get/switch. Fixes a bug where the raw identifier was passed to the Control API instead of the resolved key ID, causing failures when using labels. accounts logout/switch: Accept account alias or account ID, resolving via a new resolveAccountAlias() helper on ControlBaseCommand.

Copilot

Pull request overview

This PR broadens several CLI commands that previously required resource IDs so they can accept either a name or an ID (or other identifiers for keys/accounts), and improves “not found” UX with actionable hints. It also updates unit tests to cover the new resolution flows and adds support for surfacing custom hint strings in this.fail() output.

Changes:

Accept name-or-ID positional args for apps/queues/stats/rules, plus richer key identifiers (ID/label/full value) and account alias-or-ID.
Add “try listing resources” hints when a target queue/rule/account can’t be found.
Update command error handling to allow custom hint passthrough and refresh unit tests accordingly.

Reviewed changes

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

Show a summary per file

File	Description
test/unit/commands/stats/app.test.ts	Mocks app name→ID resolution before stats calls.
test/unit/commands/queues/delete.test.ts	Adds deletion-by-name test and asserts new hint/error text.
test/unit/commands/auth/keys/update.test.ts	Adds update-by-label test and adjusts arg wording.
test/unit/commands/auth/keys/revoke.test.ts	Adds revoke-by-label and revoke-by-full-key-value tests.
test/unit/commands/apps/update.test.ts	Adds app resolution mocking to update scenarios (including custom token).
test/unit/commands/apps/switch.test.ts	Adjusts mocks for additional listApps calls and updated /me data.
test/unit/commands/accounts/switch.test.ts	Adds switching by account ID coverage.
test/unit/commands/accounts/logout.test.ts	Adds logout-by-account-ID coverage (single + multiple accounts).
src/control-base-command.ts	Introduces `resolveAccountAlias()` helper (alias or accountId → alias).
src/commands/stats/app.ts	Renames arg to `appNameOrId` and resolves name→ID when provided.
src/commands/queues/delete.ts	Renames arg to `queueNameOrId`, matches queue by name then id, adds hint when not found.
src/commands/auth/keys/update.ts	Renames arg to `keyNameOrValue`, resolves appId more flexibly, updates by resolved key id.
src/commands/auth/keys/revoke.ts	Renames arg to `keyNameOrValue`, resolves appId more flexibly, revokes resolved key id.
src/commands/apps/update.ts	Renames arg to `appNameOrId` and resolves to appId before update calls.
src/commands/apps/switch.ts	Accepts app name-or-ID and resolves before switching.
src/commands/apps/rules/update.ts	Renames arg to `ruleNameOrId` and adds “list rules” hint on not found.
src/commands/apps/rules/delete.ts	Renames arg to `ruleNameOrId` and adds “list rules” hint on not found.
src/commands/accounts/switch.ts	Accepts account alias-or-ID and resolves via `resolveAccountAlias()`.
src/commands/accounts/logout.ts	Accepts account alias-or-ID and resolves via `resolveAccountAlias()`.
src/base-command.ts	Adds custom hint passthrough support in `fail()` (Ably-code hint still takes priority).

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

Copilot

Pull request overview

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

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

…comments for different argument cases

Copilot

Pull request overview

Copilot reviewed 22 out of 22 changed files in this pull request and generated 1 comment.

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

… comments - Added resolveAccountAlias check for accounts logout command that checks for stale config

…d up comments from other commands

sacOO7 · 2026-04-27T06:26:52Z

 keyNameOrValue: Args.string({
 description:
-"Key name (APP_ID.KEY_ID), key ID, key label (e.g. Root), or full key value to get details for",
+'Key name "<appId>.<keyId>" or value "<appId>.<keyId>:<keySecret>"',


The key label is not a reliable unique identifier. Multiple keys can share the same label, and it also allows both . and : characters. Because of this ambiguity, it shouldn't be used to uniquely identify or retrieve a specific key.
The key ID currently requires the app flag to determine which app it belongs to. Instead of extracting keyId and appId separately from a string like <appId>.<keyId> and passing them as different parameters, it’s more intuitive to use the combined identifier directly.
Instead of:
ably auth keys get key_id --app appID
Prefer
ably auth keys get KEY_ID.APP_ID
This approach aligns with the existing key format and simplifies usage by allowing the identifier to be copied and used as-is.

…r-id-arguments

…r-id-arguments # Conflicts: # src/commands/accounts/switch.ts

…ption and examples Refactored auth keys update command to with enhanced description and examples

Support app/queue/rule lookup by name or ID in commands
5ab5f61

sacOO7 mentioned this pull request Apr 23, 2026
Support app/queue/rule lookup by name or ID in commands #363
Closed

vercelBotdeployed to Preview April 23, 2026 10:32 View deployment

sacOO7 requested a review from Copilot April 23, 2026 10:42

Copilotstarted reviewing on behalf of sacOO7 April 23, 2026 10:43 View session

sacOO7 changed the title ~~Accept name or ID in commands that previously required only IDs~~[DX-1136] Accept name or ID in commands that previously required only IDsApr 23, 2026

sacOO7 changed the title ~~[DX-1136] Accept name or ID in commands that previously required only IDs~~[DX-1136] Fix inconsistency in accepting both Name or ID in commandsApr 23, 2026

CopilotAI reviewed Apr 23, 2026
View reviewed changes

Comment threadsrc/commands/apps/switch.ts Outdated
Comment threadsrc/commands/queues/delete.ts Outdated
Comment threadsrc/commands/apps/update.ts Outdated

Fixed copilot review comments
a82deba

vercelBotdeployed to Preview April 23, 2026 10:55 View deployment

sacOO7 requested a review from Copilot April 23, 2026 10:57

Copilotstarted reviewing on behalf of sacOO7 April 23, 2026 10:57 View session

CopilotAI reviewed Apr 23, 2026
View reviewed changes

Comment threadsrc/commands/auth/keys/revoke.ts Outdated
Comment threadsrc/commands/apps/switch.ts Outdated
Comment threadsrc/commands/auth/keys/update.ts Outdated

sacOO7 mentioned this pull request Apr 23, 2026
Support account alias argument for stats account#370
Draft
3 tasks

Fixed keys name or id arguments based implementation, added relevant …
75df812
…comments for different argument cases

vercelBotdeployed to Preview April 24, 2026 04:47 View deployment

sacOO7 requested a review from Copilot April 24, 2026 04:51

Copilotstarted reviewing on behalf of sacOO7 April 24, 2026 04:51 View session

CopilotAI reviewed Apr 24, 2026
View reviewed changes

Comment threadsrc/commands/accounts/logout.ts Outdated

vercelBotdeployed to Preview April 24, 2026 05:03 View deployment

sacOO7 force-pushed the fix/consistent-name-or-id-arguments branch from b027f49 to 15bbcc8Compare April 24, 2026 05:03

vercelBotdeployed to Preview April 24, 2026 05:04 View deployment

- Refactored auth keys commands and apps switch as per copilot review…
d7d03e8
… comments - Added resolveAccountAlias check for accounts logout command that checks for stale config

sacOO7 force-pushed the fix/consistent-name-or-id-arguments branch from 15bbcc8 to d7d03e8Compare April 24, 2026 07:12

vercelBotdeployed to Preview April 24, 2026 07:13 View deployment

Refactored controlApi.getKey to return fullKeyObject, fixed e2e tests
49ded59

sacOO7 marked this pull request as ready for review April 24, 2026 08:50

vercelBotdeployed to Preview April 24, 2026 08:50 View deployment

Refactored accounts/switch commands, removed unnecessary code, cleane…
10eb785
…d up comments from other commands

vercelBotdeployed to Preview April 26, 2026 14:47 View deployment

Refactored keys command group to only accept key name or value
238316a

vercelBotdeployed to Preview April 27, 2026 06:20 View deployment

sacOO7 commented Apr 27, 2026
View reviewed changes

sacOO7 requested review from AndyTWF and umair-ably April 27, 2026 07:02

Merge remote-tracking branch 'origin/main' into fix/consistent-name-o…
47de4f8
…r-id-arguments

vercelBotdeployed to Preview April 27, 2026 07:10 View deployment

AndyTWF approved these changes Apr 27, 2026
View reviewed changes

Fixed failing e2e tests
0833b06

vercelBotdeployed to Preview April 27, 2026 07:33 View deployment

vercelBotdeployed to Preview April 27, 2026 08:06 View deployment

sacOO7 force-pushed the fix/consistent-name-or-id-arguments branch from aec5835 to 2f1a7f5Compare April 27, 2026 08:33

vercelBotdeployed to Preview April 27, 2026 08:34 View deployment

Added missing e2e tests for keys switch, keys revoke and keys current
4219eff

sacOO7 force-pushed the fix/consistent-name-or-id-arguments branch from 2f1a7f5 to 4219effCompare April 27, 2026 09:55

vercelBotdeployed to Preview April 27, 2026 09:56 View deployment

Updated keys description and examples for auth/keys
95c4690

vercelBotdeployed to Preview April 27, 2026 12:39 View deployment

Merge remote-tracking branch 'origin/main' into fix/consistent-name-o…
5718edb
…r-id-arguments

vercelBotdeployed to Preview April 27, 2026 13:04 View deployment

Merge remote-tracking branch 'origin/main' into fix/consistent-name-o…
2eb9d7d
…r-id-arguments # Conflicts: # src/commands/accounts/switch.ts

vercelBotdeployed to Preview April 28, 2026 06:23 View deployment

vercelBotdeployed to Preview April 28, 2026 13:07 View deployment

Refactored apps update command to support no tls flag, updated descri…
12391fa
…ption and examples Refactored auth keys update command to with enhanced description and examples

sacOO7 force-pushed the fix/consistent-name-or-id-arguments branch from 5639deb to 12391faCompare April 28, 2026 16:59

vercelBotdeployed to Preview April 28, 2026 17:00 View deployment

sacOO7 merged commit 79ef79b into mainApr 28, 2026
11 checks passed

sacOO7 deleted the fix/consistent-name-or-id-arguments branch April 28, 2026 17:18

Navigation Menu

Uh oh!

[DX-1136] Fix inconsistency in accepting both Name or ID in commands - #369

[DX-1136] Fix inconsistency in accepting both Name or ID in commands#369
sacOO7 merged 17 commits into
mainfrom
fix/consistent-name-or-id-arguments

sacOO7 commented Apr 23, 2026•
edited
Loading

Uh oh!

vercelBot commented Apr 23, 2026•
edited
Loading

Uh oh!

CopilotAI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

CopilotAI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

CopilotAI left a comment

Uh oh!

Uh oh!

sacOO7Apr 27, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

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

Uh oh!

Changed commands

Unchanged commands

Uh oh!

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

Uh oh!

Uh oh!

CopilotAI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

CopilotAI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

CopilotAI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

sacOO7Apr 27, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

3 participants

sacOO7 commented Apr 23, 2026•
edited
Loading

vercelBot commented Apr 23, 2026•
edited
Loading