interface CommandInterface (View source)

Defines command metadata and the executable entry point used by the CLI runtime.

Methods

string
name()

Returns the primary name used to invoke the command.

string
string

Returns the human-readable summary displayed in command listings.

string
int
run(array $args)

Executes the command and returns the exit code propagated by the CLI kernel.

int

Details

name

string name()

Returns the primary name used to invoke the command.

Return Value

string

description

string description()

Returns the human-readable summary displayed in command listings.

Return Value

string

run

int run(array $args)

Executes the command and returns the exit code propagated by the CLI kernel.

Parameters

array $args

Arguments after the executable and command name.

Return Value

int