Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
aidandaly24 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eb9baa1
fix: Add a --help examples section to the CLI (#6)
aidandaly24 Mar 13, 2026
1561a50
fix: Add examples section to CommandListScreen (#6)
aidandaly24 Mar 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions src/cli/tui/copy.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,3 +43,12 @@ export const COMMAND_DESCRIPTIONS = {
update: 'Check for and install CLI updates',
validate: 'Validate agentcore/ config files.',
} as const;

/**
* Example commands shown in --help output.
*/
export const HELP_EXAMPLES = [
{ command: 'agentcore create', description: 'Create a new project with guided setup' },
{ command: 'agentcore dev', description: 'Start local development server' },
{ command: 'agentcore deploy --target default', description: 'Deploy to AWS using default target' },
] as const;
17 changes: 17 additions & 0 deletions src/cli/tui/screens/home/CommandListScreen.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { buildLogo, useLayout } from '../../context';
import { HELP_EXAMPLES } from '../../copy';
import type { CommandMeta } from '../../utils/commands';
import { Box, Text, useApp } from 'ink';
import React, { useEffect } from 'react';
Expand Down Expand Up @@ -56,6 +57,22 @@ export function CommandListScreen({ commands }: CommandListScreenProps) {
);
})}
<Text> </Text>
<Text bold color="yellow">
Examples:
</Text>
{HELP_EXAMPLES.map(example => (
<Box key={example.command} flexDirection="column">
<Box>
<Text> $ </Text>
<Text color="green">{example.command}</Text>
</Box>
<Box>
<Text> </Text>
<Text dimColor>{example.description}</Text>
</Box>
</Box>
))}
<Text> </Text>
<Text dimColor>Run agentcore [command] --help for command-specific help</Text>
<Text dimColor>Run agentcore (no args) for interactive mode</Text>
</Box>
Expand Down
Loading