import Command from 'atscm-cli/src/lib/cli/Command.js'

public class | source

Command

A command that can be run through the CLI.

Constructor Summary

Public Constructor
public	constructor(name: string, description: string, options: Object) Creates a new Command with the given name and options.

Public Members
public get	demandCommand: number[] The minimum and maximum number of (non-option) arguments the command handles.
public	description: String The command descriptions.
public	name: String The command's name.
public get	options: Map<string, Option> The options available for the command.
public get	strict: boolean If an error should be thrown for unknown arguments.
public get	usage: string Returns the usage string for the command.

Private Members
private	_options: Object The command's raw options.

Public Methods
public	requiresEnvironment(cli: AtSCMCli): boolean Returns `true` if the command requires a Liftoff.Environment before it can be run.
public	run(cli: AtSCMCli) Runs the command with the current Cli instance.

Creates a new Command with the given name and options.

Name	Type	Attribute	Description
name	string		The command's name.
description	string		The command's description.
options	Object		The options to apply.
options.options	Map<string, Option>		The options available for this command.
options.arguments	string	optional	The command's argument string. See yargs' documentation for details.
options.minArguments	number	optional	The minimum number or (non-option) arguments the command requires.
options.maxArguments	number	optional	The maximum number or (non-option) arguments the command requires.
options.strict	boolean	optional default: true	Throw error for unknown arguments.