Skip to content

fix(cli): clean up help and next-step guidance - #2626

Merged
jariy17 merged 1 commit into
refactorfrom
fix/help-copy-and-guidance
Oct 20, 2026
Merged

jariy17 merged 1 commit into
refactorfrom
fix/help-copy-and-guidance

Conversation

@notgitika

@notgitika notgitika commented Oct 20, 2026 •

Copy link
Copy Markdown
Contributor

Description

Apply the DX-001 copy and information-hierarchy fixes without introducing a style guide:

  • keep short runtime setup guidance consistently lowercase and remove noisy alignment/punctuation
  • remove the redundant agentcore build step from agentcore export harness because agentcore deploy already builds
  • render multiline wizard examples as an indented block and remove duplicate textarea keyboard help
  • clarify the LLM-as-a-judge scoring prompt and split its example across readable lines
  • group top-level help under Project, Resources, and Settings and order project commands by workflow
  • regenerate the checked-in command reference

The root TUI keeps its resource divider behavior while using the same project workflow order.

Visual review

Organized root help

agentcore root help grouped into Project, Resources, and Settings

Runtime next steps

cleaned lowercase runtime next steps

LLM-as-a-judge instructions

LLM judge prompt with a multiline example and one set of keyboard hints

The exported-harness change only removes the redundant agentcore build line, so it is covered by the output assertion rather than a separate screenshot.

Related Issue

Closes #2625

Documentation PR

Documentation is included in the regenerated command.md; no external docs PR is needed.

Type of Change

  • Bug fix
  • New feature
  • Breaking change
  • Documentation update
  • Other (please describe):

Testing

How have you tested the change?

  • I ran bun test (311 files, 4,695 tests)
  • I ran the relevant end-to-end tests with bun run test:e2e, or explained why they are not applicable — not applicable; these are deterministic local help, wizard, and guidance surfaces covered by unit/screen tests
  • I ran bun run typecheck
  • I ran bun run lint:check
  • I ran bun run format:check
  • I ran bun run build
  • If I modified src/assets/, I updated affected snapshots with bun test <test-file> --update-snapshots and committed them — src/assets/ was not modified
  • I ran bun run secrets:check

Checklist

  • I have read the CONTRIBUTING document
  • I have added any necessary tests that prove my fix is effective or my feature works
  • I have updated the documentation accordingly
  • I have added an appropriate example to the documentation to outline the feature, or no new docs are needed
  • My changes generate no new warnings
  • Any dependent changes have been merged and published

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the
terms of your choice.

@github-actions github-actions Bot added the size/l PR size: L label Oct 20, 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 Oct 20, 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 Oct 20, 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 focused UX/copy pass: reorders project commands so add sits next to create, splits commandSection into separate menuSection / helpSection primitives so --help can group commands (Project/Resources/Settings) without affecting the TUI menu, cleans up next-step copy, and renders the TextAreaField example on its own indented line (which now supports multi-line examples, used by the llm-as-a-judge instructions step).

I verified:

  • The TextAreaField test expectations (for example:\n ${EXAMPLE} — three leading spaces on the continuation line) are consistent with the two-space indent in fields.tsx plus the paddingX={1} on Step, including the multi-line case in llm-as-a-judge.screen.test.tsx.
  • root.test.tsx, RouterScreen.test.tsx, CommandFallbackScreen.test.tsx, and router.test.ts were all updated to match the new ordering/grouping.
  • command.md regeneration matches the new DEFAULT_GROUPS order and the parser now understands the three new help section titles.
  • Dropping agentcore build from the export harness next-step list is consistent with the project-level comment that deploy already runs build.

No functional issues, no telemetry gap (this isn't a new feature), and no test smells.

Nits (non-blocking, feel free to ignore):

  • src/handlers/index.tsx:100-101 uses menuSection("resources") followed immediately by helpSection("resources"); commandSection("resources") would express the same thing.
  • CommandFallbackScreen.test.tsx still names the test "the root menu retains the dev handoff" even though the top-of-menu assertion is now ❯ add. The intent (that dev is still a reachable screen) is preserved, so the test is fine, just slightly misleadingly named.

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

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 96.61%. Comparing base (57a3b3b) to head (ba2fb54).

Additional details and impacted files
@@            Coverage Diff            @@
##           refactor    #2626   +/-   ##
=========================================
  Coverage     96.61%   96.61%           
=========================================
  Files           704      704           
  Lines         58404    58412    +8     
=========================================
+ Hits          56429    56437    +8     
  Misses         1975     1975           

☔ 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.

@github-actions github-actions Bot added size/l PR size: L and removed size/l PR size: L labels Oct 20, 2026

@jariy17 jariy17 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.

Looks good. Thanks for implementing this fit and finish PR.

@jariy17
jariy17 merged commit d7b4d4a into refactor Oct 20, 2026
25 of 26 checks passed
@jariy17
jariy17 deleted the fix/help-copy-and-guidance branch October 20, 2026 19:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/l PR size: L

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants