CLI Help Panels

Categorised `praisonai –help` — every command grouped into 7 stable, discoverable panels

praisonai --help groups every command into 7 stable panels so you find run, chat, init in seconds instead of scanning ~90 commands.

Quick Start

1. See the panels

   Run --help to see every command sorted into 7 titled panels.

   praisonai --help

   The everyday path (init → setup → run) sits right at the top:

   ╭─ Get started ─────────────────────────────────╮
   │  init    setup    onboard    doctor    ...    │
   ╰───────────────────────────────────────────────╯
   ╭─ Run & chat ──────────────────────────────────╮
   │  run     chat     code       ui        ...    │
   ╰───────────────────────────────────────────────╯
   ╭─ Sessions & state ────────────────────────────╮
   │  session  checkpoint  memory  todo     ...    │
   ╰───────────────────────────────────────────────╯
   … 4 more panels …

2. Jump straight into a panel

   Group-level help inherits the same rich rendering.

   praisonai memory --help
   praisonai skills --help

User Interaction Flow

A beginner used to lose the everyday commands in a ~90-item wall. Now the everyday path is signposted at the top.

Before — one flat panel:

Commands:
  agent      agents     app        attach     audit     ...
  (≈90 items in one alphabetical block)

After — 7 panels:

╭─ Get started ─────────────────────────────────╮
│  init      setup     onboard   doctor   ...   │
╰───────────────────────────────────────────────╯
╭─ Run & chat ──────────────────────────────────╮
│  run       chat      code      ui       ...   │
╰───────────────────────────────────────────────╯
… 5 more panels …

Where Does Each Command Live?

Every command maps to exactly one panel. Ctrl-F a command name to land in its panel.

How Grouping Is Applied

Each command is resolved lazily, then tagged with its panel on first use.

LazyCommandGroup.get_command() resolves each command lazily. If the command’s rich_help_panel is unset, it assigns category_for(name). Because grouping is lazy, no command is imported just to categorise it — the registry stays the source of truth.

Configuration

Panels are code-driven — the single source of truth is help_categories.py.

The 7 panel titles are stable constants:

Best Practices

Related