Skip to content

fix: improve CLI UX — memory docs, standardize flags, fix deploy alias#703

Merged
jesseturner21 merged 1 commit intomainfrom
cli-ux-improvements
Mar 27, 2026
Merged

fix: improve CLI UX — memory docs, standardize flags, fix deploy alias#703
jesseturner21 merged 1 commit intomainfrom
cli-ux-improvements

Conversation

@jesseturner21
Copy link
Copy Markdown
Contributor

Summary

  • Document --memory shorthand mapping: Added a mapping table to docs/memory.md showing what none, shortTerm, and longAndShortTerm actually create (strategies, namespaces). Added cross-references from --memory flag descriptions in docs/commands.md.
  • Standardize max-results flags: logs and logs evals now use -n, --limit (matching traces list and evals history) instead of -n, --lines.
  • Fix deploy alias: Changed from p (confusable with package/publish) to dp.

Test plan

  • npm run build — compiles with no TypeScript errors
  • npm test — all 217 test files pass (3076 tests, 0 failures)
  • No snapshot updates needed
  • Prettier and ESLint pass via pre-commit hooks
  • E2E validation (per clitest.md instructions):
    • Built and packed both @aws/agentcore and @aws/agentcore-cdk with e2e timestamp versions
    • Installed CLI tarball locally (not globally) — npx agentcore --version returns correct version
    • agentcore create --name testE2Eproject --no-agent --skip-git --skip-python-setup --defaults succeeds
    • Installed L3 CDK constructs tarball in created project's agentcore/cdk/npm ls @aws/agentcore-cdk confirms correct version

- Document --memory shorthand mapping (none/shortTerm/longAndShortTerm)
  in memory.md with actual strategy configs and default namespaces
- Add cross-references from commands.md --memory flag descriptions
- Standardize max-results flags: logs now uses -n/--limit (matching
  traces list and evals history) instead of -n/--lines
- Change deploy alias from 'p' to 'dp' to avoid confusion with
  'package'/'publish'
@jesseturner21 jesseturner21 requested a review from a team March 27, 2026 16:09
@github-actions github-actions bot added the size/m PR size: M label Mar 27, 2026
@github-actions
Copy link
Copy Markdown
Contributor

Coverage Report

Status Category Percentage Covered / Total
🔵 Lines 45.8% 6484 / 14156
🔵 Statements 45.37% 6887 / 15179
🔵 Functions 44.37% 1159 / 2612
🔵 Branches 45.91% 4273 / 9306
Generated in workflow #1419 for commit 0dff595 by the Vitest Coverage Report Action

Copy link
Copy Markdown
Contributor

@aidandaly24 aidandaly24 left a comment

Choose a reason for hiding this comment

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

this lgtm approved

@jesseturner21 jesseturner21 merged commit 9c7f143 into main Mar 27, 2026
20 checks passed
@jesseturner21 jesseturner21 deleted the cli-ux-improvements branch March 27, 2026 16:30
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.

2 participants