Skip to content

Interface Manual

Source: command.ts

Documentation metadata used by the help or man commands.

Properties

purpose?

optional purpose?: string

A brief one-line summary of what the command does.


usage?

optional usage?: string

A string representing the syntax (e.g., "ls [OPTION]... [FILE]...").


description?

optional description?: string

A detailed explanation of the command's behavior.


options?

optional options?: object

A mapping of option names to their descriptions for the help output.

Built by Prozilla