chore(help): make --help descriptions consistent across the CLI - #2207
Conversation
Audit every command, option, and argument description for casing, verb form, and accuracy against what the command actually does. Rules applied: - lowercase, no terminal punctuation - imperative verb (add, not adds) - manage only when descendants mutate; inspect when read-only - resource nouns capitalized (Runtime, Gateway, Memory, Target, Rule); harness lowercase - ID/IDs, not id/ids - (default X), not (default: X) or (defaults to X)
|
Claude Security Review: no high-confidence findings. (run) |
There was a problem hiding this comment.
AgentCore Harness Review
Verdict: Looks good
This is a purely cosmetic sweep of --help descriptions: proper-noun casing (Gateway/Runtime/Memory/Target/Rule/ID), inspect vs manage aligned to whether the router has mutating subcommands, (default: X) → (default X), and "adds a …" → "add a …" for imperative consistency. All corresponding test assertions were updated in the same commit.
I verified:
- Every updated test string (
waitForText/toContain) matches exactly one non-test source occurrence — no dangling assertions. - No leftover old strings (
"inspect AgentCore Gateways","manage agentcore harnesses","manage harness versions","by id"in help text,description: "adds, etc.) remain insrc/. - The
inspect↔manageflip is consistent with subcommand capabilities:memory/andharness/version/are read-only (get/list) →inspect;gateway/,gateway/target/,gateway/rule/,gateway/connector/,eval/ab-test/, andharness/all expose create/delete/update →manage.
Minor (non-blocking) inconsistency I noticed but wouldn't hold the PR for: src/handlers/project/invoke/index.tsx:23 still throws "a Runtime or Harness invoke subcommand is required with --json" while the router description was lowercased to "invoke a Runtime or harness …". Feel free to fix in this PR or leave for a follow-up.
No functional changes, no new features, so no telemetry or mocking concerns apply. Safe to merge.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## refactor #2207 +/- ##
============================================
- Coverage 97.08% 97.08% -0.01%
============================================
Files 544 544
Lines 37855 37847 -8
============================================
- Hits 36751 36743 -8
Misses 1104 1104 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Audited every
--helpdescription across the CLI surface (191 commands, 774 options, 5 arguments) for casing, verb form, and accuracy.Rules applied:
add, notaddsmanageonly when descendants mutate;inspectwhen read-only (e.g.memorywasmanagebut is get/list only;gatewaywasinspectbut has create/update/delete)eval ab-test config-basedhad none)harnessstays lowercaseID/IDs, notid/ids(default X), not(default: X)or(defaults to X)README.md's command tree updated where it quoted a changed description.