API 参考 / @142vip/utils / VipPackageCliCommander

定义于: packages/utils/src/pkgs/commander.ts:133

packages 目录 CLI 统一基类（fairy-cli / changelog / releasex / agent-skills） 继承 VipCommander，封装子命令与 standalone 的标准注册顺序。

• VipCommander

new VipPackageCliCommander(name, version, description?): VipPackageCliCommander

定义于: packages/utils/src/pkgs/commander.ts:94

string

string

string

VipPackageCliCommander

VipCommander.constructor

args: string[]

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:298

VipCommander.args

readonly commands: readonly Command[]

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:300

VipCommander.commands

readonly options: readonly Option[]

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:301

VipCommander.options

parent: Command | null

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:303

VipCommander.parent

processedArgs: any[]

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:299

VipCommander.processedArgs

readonly registeredArguments: readonly Argument[]

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:302

VipCommander.registeredArguments

action(fn): this

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:547

Register callback fn for the command.

(...args) => void | Promise<void>

this

this command for chaining

program
  .command('serve')
  .description('start service')
  .action(function() {
    // do work here
  });

VipCommander.action

addArgument(arg): this

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:421

Define argument syntax for command, adding a prepared argument.

Argument

this

this command for chaining

VipCommander.addArgument

addCommand(cmd, opts?): this

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:384

Add a prepared subcommand.

See .command() for creating an attached subcommand which inherits settings from its parent.

Command

CommandOptions

this

this command for chaining

VipCommander.addCommand

addHelpCommand(cmd): this

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:454

Add prepared custom help command.

Command

this

VipCommander.addHelpCommand

addHelpCommand(nameAndArgs, description?): this

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:456

string

string

this

since v12, instead use helpCommand

VipCommander.addHelpCommand

addHelpCommand(enable?): this

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:458

boolean

this

since v12, instead use helpCommand

VipCommander.addHelpCommand

addHelpOption(option): this

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:921

Supply your own option to use for the built-in help option. This is an alternative to using helpOption() to customise the flags and description etc.

Option

this

VipCommander.addHelpOption

addHelpText(position, text): this

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:938

Add additional text to be displayed with the built-in help.

Position is 'before' or 'after' to affect just this command, and 'beforeAll' or 'afterAll' to affect this command and all its subcommands.

AddHelpTextPosition

string

this

VipCommander.addHelpText

addHelpText(position, text): this

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:939

Add additional text to be displayed with the built-in help.

Position is 'before' or 'after' to affect just this command, and 'beforeAll' or 'afterAll' to affect this command and all its subcommands.

AddHelpTextPosition

(context) => string

this

VipCommander.addHelpText

addOption(option): this

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:627

Add a prepared Option.

See .option() and .requiredOption() for creating and attaching an option in a single call.

Option

this

VipCommander.addOption

alias(alias): this

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:821

Set an alias for the command.

You may call more than once to add multiple aliases. Only the first alias is shown in the auto-generated help.

string

this

this command for chaining

VipCommander.alias

alias(): string

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:825

Get alias for the command.

string

VipCommander.alias

aliases(aliases): this

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:834

Set aliases for the command.

Only the first alias is shown in the auto-generated help.

readonly string[]

this

this command for chaining

VipCommander.aliases

aliases(): string[]

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:838

Get aliases for the command.

string[]

VipCommander.aliases

allowExcessArguments(allowExcess?): this

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:696

Allow excess command-arguments on the command line. Pass false to make excess arguments an error.

boolean

this

this command for chaining

VipCommander.allowExcessArguments

allowUnknownOption(allowUnknown?): this

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:689

Allow unknown options on the command line.

boolean

this

this command for chaining

VipCommander.allowUnknownOption

appendStandaloneOptions(command): VipCommander

定义于: packages/utils/src/pkgs/commander.ts:154

standalone bin 通用 Options（与默认项一致）

VipCommander

VipCommander

appendSubcommandOptions(command, options?): VipCommander

定义于: packages/utils/src/pkgs/commander.ts:146

子命令通用 Options（dry-run / vip / trace / help）

VipCommander

VipCommanderOptions = vipCommanderSubcommandOptions

VipCommander

argument<T>(flags, description, fn, defaultValue?): this

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:408

Define argument syntax for command.

The default is that the argument is required, and you can explicitly indicate this with <> around the name. Put [] around the name for an optional argument.

T

string

string

(value, previous) => T

T

this

this command for chaining

program.argument('<input-file>');
program.argument('[output-file]');

VipCommander.argument

argument(name, description?, defaultValue?): this

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:414

Define argument syntax for command.

The default is that the argument is required, and you can explicitly indicate this with <> around the name. Put [] around the name for an optional argument.

string

string

unknown

this

this command for chaining

program.argument('<input-file>');
program.argument('[output-file]');

VipCommander.argument

arguments(names): this

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:435

Define argument syntax for command, adding multiple at once (without descriptions).

See also .argument().

string

this

this command for chaining

program.arguments('<cmd> [env]');

VipCommander.arguments

bootstrapStandalone<TArgs>(detail, options, argv): void

定义于: packages/utils/src/pkgs/commander.ts:188

独立 bin 入口：注册后 parse

TArgs extends unknown[]

Pick<VipCommanderDetailOptions, "summary" | "description">

RegisterVipCommanderCommandOptions<TArgs>

readonly string[]

void

combineFlagAndOptionalValue(combine?): this

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:682

Alter parsing of short flags with optional values.

boolean

this

this command for chaining

// for `.option('-f,--flag [value]'):
.combineFlagAndOptionalValue(true)  // `-f80` is treated like `--flag=80`, this is the default behaviour
.combineFlagAndOptionalValue(false) // `-fb` is treated like `-f -b`

VipCommander.combineFlagAndOptionalValue

command(nameAndArgs, opts?): Command

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:341

Define a command, implemented using an action handler.

string

command name and arguments, args are <required> or [optional] and last may also be variadic...

CommandOptions

configuration options

Command

new command

The command description is supplied using .description, not as a parameter to .command.

program
  .command('clone <source> [destination]')
  .description('clone a repository into a newly created directory')
  .action((source, destination) => {
    console.log('clone command called')
  })

VipCommander.command

command(nameAndArgs, description, opts?): this

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:363

Define a command, implemented in a separate executable file.

string

command name and arguments, args are <required> or [optional] and last may also be variadic...

string

description of executable command

ExecutableCommandOptions

configuration options

this

this command for chaining

The command description is supplied as the second parameter to .command.

program
  .command('start <service>', 'start named service')
  .command('stop [service]', 'stop named service, or all if no name supplied')

VipCommander.command

configureHelp(configuration): this

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:491

You can customise the help by overriding Help properties using configureHelp(), or with a subclass of Help by overriding createHelp().

HelpConfiguration

this

VipCommander.configureHelp

configureHelp(): HelpConfiguration

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:493

Get configuration

HelpConfiguration

VipCommander.configureHelp

configureOutput(configuration): this

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:511

The default output goes to stdout and stderr. You can customise this for special applications. You can also customise the display of errors by overriding outputError.

The configuration properties are all functions:

// functions to change where being written, stdout and stderr
writeOut(str)
writeErr(str)
// matching functions to specify width for wrapping help
getOutHelpWidth()
getErrHelpWidth()
// functions based on what is being written out
outputError(str, write) // used for displaying errors, and not used for displaying help

OutputConfiguration

this

VipCommander.configureOutput

configureOutput(): OutputConfiguration

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:513

Get configuration

OutputConfiguration

VipCommander.configureOutput

copyInheritedSettings(sourceCommand): this

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:520

Copy settings that are useful to have in common across root command and subcommands.

(Used internally when adding a command using .command() so subcommands inherit parent settings.)

Command

this

VipCommander.copyInheritedSettings

createArgument(name, description?): Argument

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:392

Factory routine to create a new unattached argument.

See .argument() for creating an attached argument, which uses this routine to create the argument. You can override createArgument to return a custom argument.

string

string

Argument

VipCommander.createArgument

createCommand(name?): Command

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:375

Factory routine to create a new unattached command.

See .command() for creating an attached subcommand, which uses this routine to create the command. You can override createCommand to customise subcommands.

string

Command

VipCommander.createCommand

createHelp(): Help

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:485

You can customise the help with a subclass of Help by overriding createHelp, or by overriding Help properties using configureHelp().

Help

VipCommander.createHelp

createOption(flags, description?): Option

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:620

Factory routine to create a new unattached option.

See .option() for creating an attached option, which uses this routine to create the option. You can override createOption to return a custom option.

string

string

Option

VipCommander.createOption

description(str): this

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:794

Set the description.

string

this

this command for chaining

VipCommander.description

description(str, argsDescription): this

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:796

string

Record<string, string>

this

since v8, instead use .argument to add command argument with description

VipCommander.description

description(): string

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:800

Get the description.

string

VipCommander.description

enablePositionalOptions(positional?): this

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:706

Enable positional options. Positional means global options are specified before subcommands which lets subcommands reuse the same option names, and also enables subcommands to turn on passThroughOptions.

The default behaviour is non-positional and global options may appear anywhere on the command line.

boolean

this

this command for chaining

VipCommander.enablePositionalOptions

error(message, errorOptions?): never

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:479

Display error message and exit (or call exitOverride).

string

ErrorOptions

never

VipCommander.error

executableDir(path): this

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:889

Set the directory for searching for executable subcommands of this command.

string

this

this command for chaining

program.executableDir(__dirname)
// or
program.executableDir('subcommands')

VipCommander.executableDir

executableDir(): string | null

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:893

Get the executable search directory.

string | null

VipCommander.executableDir

exitOverride(callback?): this

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:474

Register callback to use as replacement for calling process.exit.

(err) => void

this

VipCommander.exitOverride

getOptionValue(key): any

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:644

Retrieve option value.

string

any

VipCommander.getOptionValue

getOptionValueSource(key): OptionValueSource

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:663

Get source of option value.

string

OptionValueSource

VipCommander.getOptionValueSource

getOptionValueSourceWithGlobals(key): OptionValueSource

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:668

Get source of option value. See also .optsWithGlobals().

string

OptionValueSource

VipCommander.getOptionValueSourceWithGlobals

help(context?): never

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:928

Output help information and exit.

Outputs built-in help, and custom text added using .addHelpText().

HelpContext

never

VipCommander.help

help(cb?): never

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:930

(str) => string

never

since v7

VipCommander.help

helpCommand(nameAndArgs, description?): this

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:448

Customise or override default help command. By default a help command is automatically added if your command has subcommands.

string

string

this

program.helpCommand('help [cmd]')
program.helpCommand('help [cmd]', 'show help')
program.helpCommand(false) // suppress default help command
program.helpCommand(true) // add help command even if no subcommands

VipCommander.helpCommand

helpCommand(enable): this

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:449

Customise or override default help command. By default a help command is automatically added if your command has subcommands.

boolean

this

program.helpCommand('help [cmd]')
program.helpCommand('help [cmd]', 'show help')
program.helpCommand(false) // suppress default help command
program.helpCommand(true) // add help command even if no subcommands

VipCommander.helpCommand

helpInformation(context?): string

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:908

Return command help documentation.

HelpContext

string

VipCommander.helpInformation

helpOption(flags?, description?): this

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:915

You can pass in flags and a description to override the help flags and help description for your command. Pass in false to disable the built-in help option.

string | boolean

string

this

VipCommander.helpOption

hook(event, listener): this

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:463

Add hook for life cycle event.

HookEvent

(thisCommand, actionCommand) => void | Promise<void>

this

VipCommander.hook

init(options): VipCommander

定义于: packages/utils/src/pkgs/commander.ts:109

Pick<VipCommanderDetailOptions, "summary" | "description">

VipCommander

VipCommander.init

initCommand(options): VipCommander

定义于: packages/utils/src/pkgs/commander.ts:116

VipCommanderDetailOptions

VipCommander

VipCommander.initCommand

name(str): this

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:856

Set the name of the command.

string

this

this command for chaining

VipCommander.name

name(): string

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:860

Get the name of the command.

string

VipCommander.name

nameFromFilename(filename): this

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:875

Set the name of the command from script filename, such as process.argv[1], or require.main.filename, or __filename.

(Used internally and public although not documented in README.)

string

this

this command for chaining

program.nameFromFilename(require.main.filename)

VipCommander.nameFromFilename

on(event, listener): this

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:947

Add a listener (callback) for when events occur. (Implemented using EventEmitter.)

string | symbol

(...args) => void

this

VipCommander.on

option(flags, description?, defaultValue?): this

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:569

Define option with flags, description, and optional argument parsing function or defaultValue or both.

The flags string contains the short and/or long flags, separated by comma, a pipe or space. A required option-argument is indicated by <> and an optional option-argument by [].

See the README for more details, and see also addOption() and requiredOption().

string

string

string | boolean | string[]

this

this command for chaining

program
  .option('-p, --pepper', 'add pepper')
  .option('-p, --pizza-type <TYPE>', 'type of pizza') // required option-argument
  .option('-c, --cheese [CHEESE]', 'add extra cheese', 'mozzarella') // optional option-argument with default
  .option('-t, --tip <VALUE>', 'add tip to purchase cost', Number.parseFloat) // custom parse function

VipCommander.option

option<T>(flags, description, parseArg, defaultValue?): this

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:574

Define option with flags, description, and optional argument parsing function or defaultValue or both.

The flags string contains the short and/or long flags, separated by comma, a pipe or space. A required option-argument is indicated by <> and an optional option-argument by [].

See the README for more details, and see also addOption() and requiredOption().

T

string

string

(value, previous) => T

T

this

this command for chaining

program
  .option('-p, --pepper', 'add pepper')
  .option('-p, --pizza-type <TYPE>', 'type of pizza') // required option-argument
  .option('-c, --cheese [CHEESE]', 'add extra cheese', 'mozzarella') // optional option-argument with default
  .option('-t, --tip <VALUE>', 'add tip to purchase cost', Number.parseFloat) // custom parse function

VipCommander.option

option(flags, description, regexp, defaultValue?): this

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:581

string

string

RegExp

string | boolean | string[]

this

since v7, instead use choices or a custom function

VipCommander.option

opts<T>(): T

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:781

Return an object containing local option values as key-value pairs

T extends OptionValues

T

VipCommander.opts

optsWithGlobals<T>(): T

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:786

Return an object containing merged local and global option values as key-value pairs.

T extends OptionValues

T

VipCommander.optsWithGlobals

outputHelp(context?): void

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:901

Output help information for this command.

Outputs built-in help, and custom text added using .addHelpText().

HelpContext

void

VipCommander.outputHelp

outputHelp(cb?): void

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:903

(str) => string

void

since v7

VipCommander.outputHelp

parse(argv?, parseOptions?): this

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:740

Parse argv, setting options and invoking commands when defined.

Use parseAsync instead of parse if any of your action handlers are async.

Call with no parameters to parse process.argv. Detects Electron and special node options like node --eval. Easy mode!

Or call with an array of strings to parse, and optionally where the user arguments start by specifying where the arguments are from:

• 'node': default, argv[0] is the application and argv[1] is the script being run, with user arguments after that
• 'electron': argv[0] is the application and argv[1] varies depending on whether the electron application is packaged
• 'user': just user arguments

readonly string[]

ParseOptions

this

this command for chaining

program.parse(); // parse process.argv and auto-detect electron and special node flags
program.parse(process.argv); // assume argv[0] is app and argv[1] is script
program.parse(my-args, { from: 'user' }); // just user supplied arguments, nothing special about argv[0]

VipCommander.parse

parseAsync(argv?): Promise<VipPackageCliCommander>

定义于: packages/utils/src/pkgs/commander.ts:123

Parse argv, setting options and invoking commands when defined.

Call with no parameters to parse process.argv. Detects Electron and special node options like node --eval. Easy mode!

Or call with an array of strings to parse, and optionally where the user arguments start by specifying where the arguments are from:

• 'node': default, argv[0] is the application and argv[1] is the script being run, with user arguments after that
• 'electron': argv[0] is the application and argv[1] varies depending on whether the electron application is packaged
• 'user': just user arguments

readonly string[]

Promise<VipPackageCliCommander>

Promise

await program.parseAsync(); // parse process.argv and auto-detect electron and special node flags
await program.parseAsync(process.argv); // assume argv[0] is app and argv[1] is script
await program.parseAsync(my-args, { from: 'user' }); // just user supplied arguments, nothing special about argv[0]

VipCommander.parseAsync

parseOptions(argv): ParseOptionsResult

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:776

Parse options from argv removing known options, and return argv split into operands and unknown arguments.

argv =\> operands, unknown
--known kkk op =\> [op], []
op --known kkk =\> [op], []
sub --unknown uuu op =\> [sub], [--unknown uuu op]
sub -- --unknown uuu op =\> [sub --unknown uuu op], []

string[]

ParseOptionsResult

VipCommander.parseOptions

passThroughOptions(passThrough?): this

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:717

Pass through options that come after command-arguments rather than treat them as command-options, so actual command-options come before command-arguments. Turning this on for a subcommand requires positional options to have been enabled on the program (parent commands).

The default behaviour is non-positional and options may appear before or after command-arguments.

boolean

this

this command for chaining

VipCommander.passThroughOptions

registerRootOptions(): this

定义于: packages/utils/src/pkgs/commander.ts:140

根程序 fa -h：trace + help + version

this

registerStandalone<TArgs>(detail, options): VipCommander

定义于: packages/utils/src/pkgs/commander.ts:176

独立 bin：init → 业务参数 → dry-run / vip / trace → action

TArgs extends unknown[]

Pick<VipCommanderDetailOptions, "summary" | "description">

RegisterVipCommanderCommandOptions<TArgs>

VipCommander

registerSubcommand<TArgs>(detail, options, commanderOptions?): VipCommander

定义于: packages/utils/src/pkgs/commander.ts:161

fairy-cli 子命令：initCommand → 业务参数 → dry-run / vip / trace → action

TArgs extends unknown[]

VipCommanderDetailOptions

RegisterVipCommanderCommandOptions<TArgs>

VipCommanderOptions = vipCommanderSubcommandOptions

VipCommander

requiredOption(flags, description?, defaultValue?): this

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:594

Define a required option, which must have a value after parsing. This usually means the option must be specified on the command line. (Otherwise the same as .option().)

The flags string contains the short and/or long flags, separated by comma, a pipe or space.

string

string

string | boolean | string[]

this

VipCommander.requiredOption

requiredOption<T>(flags, description, parseArg, defaultValue?): this

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:599

Define a required option, which must have a value after parsing. This usually means the option must be specified on the command line. (Otherwise the same as .option().)

The flags string contains the short and/or long flags, separated by comma, a pipe or space.

T

string

string

(value, previous) => T

T

this

VipCommander.requiredOption

requiredOption(flags, description, regexp, defaultValue?): this

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:606

string

string

RegExp

string | boolean | string[]

this

since v7, instead use choices or a custom function

VipCommander.requiredOption

setOptionValue(key, value): this

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:649

Store option value.

string

unknown

this

VipCommander.setOptionValue

setOptionValueWithSource(key, value, source): this

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:654

Store option value and where the value came from.

string

unknown

OptionValueSource

this

VipCommander.setOptionValueWithSource

showHelpAfterError(displayHelp?): this

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:525

Display the help or a custom message after an error occurs.

string | boolean

this

VipCommander.showHelpAfterError

showSuggestionAfterError(displaySuggestion?): this

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:530

Display suggestion of similar commands for unknown commands, or options for unknown options.

boolean

this

VipCommander.showSuggestionAfterError

storeOptionsAsProperties<T>(): VipPackageCliCommander & T

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:635

Whether to store option values as properties on command object, or store separately (specify false). In both cases the option values can be accessed using .opts().

T extends OptionValues

VipPackageCliCommander & T

this command for chaining

VipCommander.storeOptionsAsProperties

storeOptionsAsProperties<T>(storeAsProperties): VipPackageCliCommander & T

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:636

Whether to store option values as properties on command object, or store separately (specify false). In both cases the option values can be accessed using .opts().

T extends OptionValues

true

VipPackageCliCommander & T

this command for chaining

VipCommander.storeOptionsAsProperties

storeOptionsAsProperties(storeAsProperties?): this

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:639

Whether to store option values as properties on command object, or store separately (specify false). In both cases the option values can be accessed using .opts().

boolean

this

this command for chaining

VipCommander.storeOptionsAsProperties

summary(str): this

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:808

Set the summary. Used when listed as subcommand of parent.

string

this

this command for chaining

VipCommander.summary

summary(): string

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:812

Get the summary.

string

VipCommander.summary

usage(str): this

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:845

Set the command usage.

string

this

this command for chaining

VipCommander.usage

usage(): string

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:849

Get the command usage.

string

VipCommander.usage

version(str, flags?, description?): this

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:315

Set the program version to str.

This method auto-registers the "-V, --version" flag which will print the version number when passed.

You can optionally supply the flags and description to override the defaults.

string

string

string

this

VipCommander.version

version(): string | undefined

定义于: node_modules/.pnpm/[email protected]/node_modules/commander/typings/index.d.ts:319

Get the program version.

string | undefined

VipCommander.version