Home Manual Reference Source Test
import ConfigCommand from 'atscm-cli/src/cli/commands/Config.js'
public class | source

ConfigCommand

Extends:

Command → ConfigCommand

The command invoked when running "config".

Test:

Constructor Summary

Public Constructor
public

constructor(name: string, description: string)

Creates a new ConfigCommand with the specified name and description.

Method Summary

Public Methods
public

run(cli: AtSCMCli)

Prints the project's configuration.

Inherited Summary

From class Command
public get

The minimum and maximum number of (non-option) arguments the command handles.

public get

The options available for the command.

public get

If an error should be thrown for unknown arguments.

public get

Returns the usage string for the command.

public

The command descriptions.

public

The command's name.

private

The command's raw options.

public

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.

Public Constructors

public constructor(name: string, description: string) source

Creates a new ConfigCommand with the specified name and description.

Override:

Command#constructor

Params:

NameTypeAttributeDescription
name string

The command's name.

description string

The command's description.

Public Methods

public run(cli: AtSCMCli) source

Prints the project's configuration.

Override:

Command#run

Params:

NameTypeAttributeDescription
cli AtSCMCli

The current Cli instance.

Test: