Word

command

A command of the app's own command line that is written in code. It is a helper word, written in a file that imports tentjs/cli.

Example

TypeScript
export const pay = command('pay', {
  run: async ({ args, terminal }) => {
    terminal.write(String(args.limit))
    return 0
  },
})

Options

OptionMeans
option.command.aboutOne sentence on what the command is for, which the help prints.
option.command.runThe function of the command, which runs at the person's side.
option.command.accessWho the command is for.
option.command.argsThe flags of the command.
option.command.wasThe old name of the command, where it was renamed.

Returns

A record that carries its options. Nothing calls it.

See also

topic.words