Yeesh.Builtin.Help (Yeesh v0.8.1)

View Source

Built-in help command.

When invoked without arguments, lists all registered commands grouped by name prefix:

  • Built-in commands (from Yeesh.Registry.builtin_commands/0) are grouped under "Built-in".
  • Commands that implement the optional Yeesh.Command.group/0 callback are grouped under the returned string (takes precedence over automatic grouping).
  • Consumer commands whose name contains no separator (., -, _) are grouped under "Generic".
  • Consumer commands with a separator are grouped by the text before the first separator, capitalized (e.g. db.migrate -> "Db").

Groups are sorted: Built-in first, Generic second, then custom groups alphabetically.

When invoked with a command name (help <command>), shows its description and usage.