Help

tcmts.cli.commands.Help · #egtmtwh2 · type

A command's help, as tcm help, --help, usage errors and shell completion show it: its description, its parameters' (by name) and its subcommands'. Parsing doesn't read it (a route, routeFind, has none), so a change to one command's help reaches only what shows help, not every run of tcm.

export interface Help {
  description: string;
  params?: Record<string, string>;
  routes?: Record<string, Help>;
}

used by