Type Alias: CLIText

CLIText = object

A text of the help or of the prompts of commanderCLIEntrypoint, given to its translate function.

Properties

key

key: string

The key identifying the text: description (the program), commands.<command>.description, commands.<command>.options.<property>, commands.<command>.arguments.<name> (a nested command's words are joined with dots: package.exe), the help titles and labels (help.usage, help.options, help.commands, help.default, help.choices…), the prompt messages (prompt.json).

---

params?

optional params?: Record<string, string>

The values of the text's {name} placeholders, by name.

---

text

text: string

The English text, with its {name} placeholders.