Skip to content

feat(cli): redesign help across command tree#53

Merged
francoischalifour merged 2 commits into
mainfrom
fc/update-cli-help-display
Jul 13, 2026
Merged

feat(cli): redesign help across command tree#53
francoischalifour merged 2 commits into
mainfrom
fc/update-cli-help-display

Conversation

@francoischalifour

Copy link
Copy Markdown
Member

The CLI help previously relied on Citty’s flat layout, making command discovery difficult and producing inconsistent wrapping across terminals.

The renderer now:

  • Groups root commands from their metadata into Platform, Ingest, and Query.
  • Renders root and nested panels consistently.
  • Supports Usage, Arguments, Options, Commands, guidance, and Examples sections.
  • Preserves aliases, enum hints, positional arguments, required/default annotations, and hidden-command filtering.
  • Uses the existing terminal styles and colors only.
  • Highlights command invocations in examples and command guidance.
  • Wraps descriptions and long help text with hanging indentation.
  • Keeps complete panels within narrow terminal widths.
  • Preserves command-specific examples and active-context behavior.
  • Removes Citty’s help renderer dependency entirely.

Preview

Before

image

After

Screenshot - ChatGPT - ChatGPT - 2026-07-13 at 15 11 52
Screenshot - ChatGPT - ChatGPT - 2026-07-13 at 15 11 32

Replace Citty's default help panels with a shared renderer for the root command and every nested command. The previous output was flat, inconsistent between root and subcommands, and fragile across terminal widths.

Derive command listings from command metadata, including platform/ingest/query groups and hidden-command filtering. Render Usage, Arguments, Options, Commands, guidance, and Examples consistently with responsive hanging indentation, existing terminal styles, command highlighting, aliases, enum hints, required/default annotations, and narrow-terminal wrapping.

Keep command-specific examples and active-context behavior intact while removing the Citty usage renderer entirely. Add focused coverage for grouped root help, nested panels, responsive wrapping, hidden commands, and command-colored guidance.
@francoischalifour francoischalifour enabled auto-merge (squash) July 13, 2026 13:23
@francoischalifour francoischalifour merged commit e35c2fe into main Jul 13, 2026
8 checks passed
@francoischalifour francoischalifour deleted the fc/update-cli-help-display branch July 13, 2026 13:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants