Skip to content

chore(help): make --help descriptions consistent across the CLI - #2207

Merged
notgitika merged 1 commit into
aws:refactorfrom
notgitika:chore/help-description-consistency
Sep 3, 2026
Merged

chore(help): make --help descriptions consistent across the CLI#2207
notgitika merged 1 commit into
aws:refactorfrom
notgitika:chore/help-description-consistency

Conversation

@notgitika

Copy link
Copy Markdown
Contributor

Audited every --help description across the CLI surface (191 commands, 774 options, 5 arguments) for casing, verb form, and accuracy.

Rules applied:

  • lowercase, no terminal punctuation
  • imperative verb — add, not adds
  • manage only when descendants mutate; inspect when read-only (e.g. memory was manage but is get/list only; gateway was inspect but has create/update/delete)
  • every group has a verb (eval ab-test config-based had none)
  • resource nouns capitalized — Runtime, Gateway, Memory, Target, Rule; harness stays lowercase
  • ID/IDs, not id/ids
  • (default X), not (default: X) or (defaults to X)

README.md's command tree updated where it quoted a changed description.

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)
@github-actions github-actions Bot added the size/m PR size: M label Sep 3, 2026
@agentcore-devx-automation agentcore-devx-automation Bot added agentcore-harness-reviewing AgentCore Harness review in progress claude-security-reviewing Claude Code /security-review in progress labels Sep 3, 2026
@agentcore-devx-automation

Copy link
Copy Markdown
Contributor

Claude Security Review: no high-confidence findings. (run)

@agentcore-devx-automation agentcore-devx-automation Bot removed the claude-security-reviewing Claude Code /security-review in progress label Sep 3, 2026

@agentcore-devx-automation agentcore-devx-automation Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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 in src/.
  • The inspectmanage flip is consistent with subcommand capabilities: memory/ and harness/version/ are read-only (get/list) → inspect; gateway/, gateway/target/, gateway/rule/, gateway/connector/, eval/ab-test/, and harness/ 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.

@agentcore-devx-automation agentcore-devx-automation Bot removed the agentcore-harness-reviewing AgentCore Harness review in progress label Sep 3, 2026
@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.08%. Comparing base (76bae61) to head (27bf982).
⚠️ Report is 1 commits behind head on refactor.

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@notgitika
notgitika merged commit a452de9 into aws:refactor Sep 3, 2026
22 of 25 checks passed
@notgitika
notgitika deleted the chore/help-description-consistency branch September 3, 2026 23:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/m PR size: M

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants