/ 
Developer-Dashboard-5.51
/ Developer::Dashboard::CLI::Help

NAME

Developer::Dashboard::CLI::Help - canonical command help and action metadata

PURPOSE

Provides the shared command catalog used to render explicit help and to keep shell-completion subcommands aligned with private CLI dispatch.

WHY IT EXISTS

Help and completion had been maintained in unrelated places, leaving commands without actionable help and valid actions out of TAB suggestions. This module holds one tested inventory for built-in helpers, the switchboard's direct version command, compatibility aliases, nested actions, and concise synopsis text.

WHEN TO USE

Use this module when adding a managed internal command, an actionable subcommand, a compatibility alias, or changing the public CLI syntax.

HOW TO USE

my $help = Developer::Dashboard::CLI::Help::help_text('docker', 'compose');
my @actions = Developer::Dashboard::CLI::Help::actions_for('path');
my @options = Developer::Dashboard::CLI::Help::options_for('api', 'add');
my @request = Developer::Dashboard::CLI::Help::help_request(
    command => 'api', args => ['--help'],
);
my $overview = Developer::Dashboard::CLI::Help::overview_text();

The help request result is empty when the arguments do not explicitly ask for help or when a delegated command owns the request, even if Dashboard wrapper options precede the delegated command; otherwise it contains the canonical command and an optional action name. In particular, dashboard of grep --help and dashboard docker compose config --help leave their trailing help options with grep or Docker Compose. That ownership is preserved when of --print or Docker Compose selectors occur before the delegated command. Dotted skill invocations enter the private skills _exec dispatch; help detection stops there so a skill CLI receives its own -h or --help unchanged. The built-in Compose synopsis remains available as dashboard docker compose --help or dashboard help docker compose.

WHAT USES IT

The public switchboard and private helper dispatcher call this module before running built-in operations. Developer::Dashboard::CLI::Complete uses the action and option catalogs to generate TAB candidates for commands, nested actions, flags, and targets following global help.

EXAMPLES

dashboard api --help
dashboard path cdr --help
dashboard of --print grep --help
dashboard docker compose config --help
dashboard docker compose --service dev exec dev docker --help
dashboard of grep --help
dashboard help docker development
dashboard complete 3 dashboard api add -
prove -lv t/265-cli-help-completion-contract.t