Cherry.CLI.Help (cherry v0.5.0)

Copy Markdown View Source

Renders help text for the base CLI and for individual verbs.

Everything here derives from Cherry.CLI.Registry and each command's doc/0 — the same source that feeds the mix task docs and the agent skill — so help can never disagree with them.

Summary

Functions

base()

The base help screen: usage, every verb with its summary, global flags.

verb(command)

Help for one verb: the command's doc text with usage shown in binary form (cherry build, not mix cherry.build — the two frontends are verb-for-verb identical, ADR 0006).

Functions

base()

@spec base() :: String.t()

The base help screen: usage, every verb with its summary, global flags.

verb(command)

@spec verb(module()) :: String.t()

Help for one verb: the command's doc text with usage shown in binary form (cherry build, not mix cherry.build — the two frontends are verb-for-verb identical, ADR 0006).