fix(cli): correct inaccurate --help text across all commands#695
Merged
fix(cli): correct inaccurate --help text across all commands#695
Conversation
Audit and fix help text for all CLI commands and primitives: - Fix agent name constraints: "max 64 chars" → "max 48 chars", add "underscores" to allowed characters - Fix project name constraint: "max 36 chars" → "max 23 chars" - Remove CrewAI from framework lists (not user-accessible) - Fix "Remove a agent" → "Remove an agent" grammar - Add missing resource types (evaluator, online-eval) to status --type - Remove phantom 'edit' command from COMMAND_DESCRIPTIONS - Remove false --agent-arn claim from evals description - Add [non-interactive] markers to all options missing them in EvaluatorPrimitive, GatewayPrimitive, GatewayTargetPrimitive, and PolicyEnginePrimitive - Improve gateway and gateway-target help descriptions for clarity - Update AGENTS.md to match current CLI reality Constraint: Help text and Zod schemas are defined in separate files with no shared constant Confidence: high Scope-risk: narrow Not-tested: Interactive TUI mode (only CLI --help verified)
Fix help text for options added in upstream PRs aws#652, aws#653, aws#657, aws#620: - dev: add [non-interactive] to --tool, --input, -H/--header - invoke: add [non-interactive] to -H/--header - fetch access: add [non-interactive] to --name, --type, --target, --json - copy.ts: add missing 'import' command description Confidence: high Scope-risk: narrow
aidandaly24
force-pushed
the
fix/help-text-audit
branch
from
ee402d7 to
58b0886
Compare
aidandaly24
had a problem deploying
to
e2e-testing
GitHub Actions
Failure
aidandaly24
had a problem deploying
to
e2e-testing
GitHub Actions
Failure
notgitika
previously approved these changes
Mar 27, 2026
Contributor
notgitika
left a comment
notgitika
left a comment
There was a problem hiding this comment.
Left a comment. This PR looks good, thanks for cleaning it up.
If you can address this comment in this PR itself, it would be awesome adn we could close the issue out. Or could be a fast-follow
- Add Global Options section documenting -h/--help and --version - Add missing 'import' command to CLI Commands list - Update 'fetch access' description to include agent support Confidence: high Scope-risk: narrow
aidandaly24
had a problem deploying
to
e2e-testing
GitHub Actions
Failure
aidandaly24
had a problem deploying
to
e2e-testing
GitHub Actions
Failure
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description
Comprehensive audit and fix of
--helptext across all CLI commands and primitives. Every--helpoutput was compared against source code (Zod schemas, Commander registrations, TUI option arrays) and corrected where inaccurate.Fixes include:
^[a-zA-Z][a-zA-Z0-9_]{0,47}$).max(23))articleoverrideevaluator,online-eval) tostatus --typefiltereditcommand fromCOMMAND_DESCRIPTIONS--agent-arnclaim fromevalsdescription[non-interactive]markers to ~53 options missing them across EvaluatorPrimitive, GatewayPrimitive, GatewayTargetPrimitive, and PolicyEnginePrimitive[non-interactive]markers to new upstream options:dev --tool/--input/-H,invoke -H,fetch access --name/--type/--target/--jsonimportcommand toCOMMAND_DESCRIPTIONSincopy.tsRelated Issue
N/A — discovered via systematic help text audit
Documentation PR
N/A
Type of Change
Testing
How have you tested the change?
npm run test:unitandnpm run test:integnpm run typechecknpm run lintsrc/assets/, I rannpm run test:update-snapshotsand committed the updated snapshotsAll 3073 unit tests pass (rebased on latest upstream/main). The only failures are 2 pre-existing PTY environment issues in
tui-harness/proof-of-concept.test.ts(unrelatedposix_spawnperror) and 1 flakyAddGatewayJwtConfigtest (passes in isolation, unrelated to our changes).Checklist
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the
terms of your choice.