Reference · command

metais help

Print the overview, a command's help, or a topic.

The tool

Usage

metais help [<command> | <topic> [<command>]] [--json]

Examples

metais help
Prints the overview.
metais help templates
Prints the template language, every filter with an example, and escaping.
metais help manifest
Prints every field of metais.yaml with an example.
metais help schemas
Prints the schema dialect, its formats, and uniqueKeys and coverage with an example.
metais help refusals render
Lists every code metais render may refuse with, by its next step.
metais help --json
Prints every command's declaration and every topic as one document.

Detail

With no operand, prints the overview: the commands by group, the global flags, the topics and the exit codes. With a command's name, prints that command's help, as metais <command> --help does. With a topic, prints the topic; the topic refusals takes a command's name after it, and lists every code that command may refuse with.

With --json, prints the help as one metais.help/1 document: every command's full declaration and every topic for the overview, or the one command or topic asked for.

Operands

<command> | <topic>
A command's name, or one of the topics inputs, templates, manifest, schemas, globs, json, exit-codes and refusals.
<command>
After the topic refusals, the command whose codes are listed; no other topic takes one.

Flags

--json
Print the result as one JSON document on standard output.
--color <when>
Colour human output: auto colours a stream that is a terminal when NO_COLOR is unset or empty; always and never override NO_COLOR. Values: auto, always, never. Default: auto.
-h, --help
Print help to standard output and exit 0; nothing else runs.

Prints

The help asked for, wrapped at 80 columns, never coloured.

--json: metais.help/1

Refusals

usage.bad_value
A flag's value is missing, or is not one the flag accepts, or a flag that takes no value is given one. Next: metais help --help: Prints the operands and flags metais help takes.
usage.repeated_flag
A flag that may be given once is given again. Next: metais help --help: Prints the operands and flags metais help takes.
usage.unexpected_operand
An operand the command does not take. Next: metais help --help: Prints the operands and flags metais help takes.
usage.unknown_flag
An argument that is not a flag the command accepts, an abbreviated flag, or one-letter aliases written together. Next: metais help --help: Prints the operands and flags metais help takes.
usage.unknown_topic
The operand names no command and no topic, or the operand after refusals names no command. Next: metais help: Lists every command, the global flags and the help topics.