Show container usage when missing subcommand #18

New issue

Open

opened 2025-11-19 13:20:38 +00:00 by glenux · 0 comments

glenux commented

2025-11-19 13:20:38 +00:00

Owner

title: Show container usage when missing subcommand
description: Invoking ./bin/docmachine container currently prints “No container command specified…” but omits the usage instructions and list of available subcommands, forcing the user to re-run with --help.
current_situation: DocMachine::Container::Cli#add_options (src/container/cli.cr:12-83) enqueues a command that raises DocMachine::CliError when no subcommand arguments remain (line 79), but doesn’t print the container-specific usage banner or help text beforehand. Contrast this with main CLI --help, which shows the subcommand list. The container command should display the same instructions automatically when invoked without arguments, aligning with ADR-CLI expectations.
expected_outcome:

Running ./bin/docmachine container should show the container usage banner and subcommand list before raising an error (or exit 0 with help message).
Tests cover the zero-argument scenario, ensuring usage text is emitted.
technical_details:
Reuse opts.banner / opts.help or manually print the string defined earlier in add_options when no subcommand is provided.
Consider raising DocMachine::HelpRequested with the container-specific usage text for consistency with the main CLI.

--- title: Show container usage when missing subcommand description: Invoking `./bin/docmachine container` currently prints “No container command specified…” but omits the usage instructions and list of available subcommands, forcing the user to re-run with `--help`. current_situation: `DocMachine::Container::Cli#add_options` (src/container/cli.cr:12-83) enqueues a command that raises `DocMachine::CliError` when no subcommand arguments remain (line 79), but doesn’t print the container-specific usage banner or help text beforehand. Contrast this with main CLI `--help`, which shows the subcommand list. The container command should display the same instructions automatically when invoked without arguments, aligning with ADR-CLI expectations. expected_outcome: - Running `./bin/docmachine container` should show the container usage banner and subcommand list before raising an error (or exit 0 with help message). - Tests cover the zero-argument scenario, ensuring usage text is emitted. technical_details: - Reuse `opts.banner` / `opts.help` or manually print the string defined earlier in `add_options` when no subcommand is provided. - Consider raising `DocMachine::HelpRequested` with the container-specific usage text for consistency with the main CLI. ---