Class Command`Abstract`

One cell <name> command. Options are parsed with node:util parseArgs.

Hierarchy (View Summary)

Command

Index

Constructors

Properties

arguments description name options usage

Methods

Constructors

constructor

new Command(): Command

Returns Command

Properties

`Readonly`arguments

arguments: string = ''

Positional arguments for --help, e.g. get <key>; commands without them reject positionals.

`Abstract` `Readonly`description

description: string

`Abstract` `Readonly`name

name: string

`Readonly`options

options: ParseArgsOptionsConfig = {}

Options of this command in addition to the common ones (--root, --json, --help).

`Readonly`usage

usage: string[] = []

One line per option for --help.

Methods

`Abstract`run

run(context: CommandContext): Promise<number>
Returns the process exit code.
Parameters
- context: CommandContext
Returns Promise<number>
- Defined in dev-packages/cli/src/cli/command.ts:28