Skip to content

fix: Add a --help examples section to the CLI (#6)#7

Open
aidandaly24 wants to merge 2 commits intomainfrom
loopy/issue-6
Open

fix: Add a --help examples section to the CLI (#6)#7
aidandaly24 wants to merge 2 commits intomainfrom
loopy/issue-6

Conversation

@aidandaly24
Copy link
Copy Markdown
Owner

Summary

This PR adds a usage examples section to the CLI help output, as requested in #6.

Changes

When a user runs agentcore --help, they will now see an "Examples" section at the bottom showing common usage patterns:

Examples:
 $ agentcore create
   Create a new project with guided setup
 $ agentcore dev
   Start local development server
 $ agentcore deploy --target default
   Deploy to AWS using default target

Implementation Details

  • Added HELP_EXAMPLES constant to src/cli/tui/copy.ts following the existing pattern for centralized copy text
  • Updated CommandListScreen.tsx to render the examples section with consistent styling (green commands, dimmed descriptions)

Testing

The changes follow existing patterns in the codebase and use the same React/Ink components. The examples are displayed between the commands list and the footer hints.

Closes #6

@github-actions github-actions Bot added the size/s PR size: S label Mar 13, 2026
@github-actions
Copy link
Copy Markdown

Coverage Report

Status Category Percentage Covered / Total
🔵 Lines 42.94% 3838 / 8937
🔵 Statements 42.51% 4047 / 9518
🔵 Functions 44.35% 747 / 1684
🔵 Branches 44.83% 2541 / 5667
Generated in workflow #17 for commit 1561a50 by the Vitest Coverage Report Action

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/s PR size: S

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add a --help examples section to the CLI

1 participant