ahoy icon indicating copy to clipboard operation
ahoy copied to clipboard

Add support for long descriptions

Open AlexSkrypnyk opened this issue 5 months ago • 2 comments

We currently have usage which is shown when ahoy --help is called as a list of available commands and their usage information.

It would be great to be able to provide a description field with more expanded description of the commands. Such a description could then be available by ahoy [command] --help.

This would be in-line with how CLI commands provide short and long command help information.

$> ahoy build --help

Build project <-- Text from `usage`

Builds the container stack, front-end assets  <-- Text from `description` field.
and provisions a website.
A wrapper for several commands.

AlexSkrypnyk avatar Jul 25 '25 04:07 AlexSkrypnyk

Good idea @AlexSkrypnyk - this was actually already part of the CLI library we're using, and just needed a small addition and some tests.

ocean avatar Jul 26 '25 06:07 ocean

Implemented with #157 - not released yet though.

ocean avatar Aug 07 '25 22:08 ocean