console

Documentation

Index

• type Artisan
• type Command
• type CommandExtend

Types

type Artisan

type Artisan interface {
	//Register commands.
	Register(commands []Command)

	//Call Run an Artisan console command by name.
	Call(command string)

	//CallAndExit Run an Artisan console command by name and exit.
	CallAndExit(command string)

	//Run a command. args include: ["./main", "artisan", "command"]
	Run(args []string, exitIfArtisan bool)
}

type Command

type Command interface {
	//Signature The name and signature of the console command.
	Signature() string
	//Description The console command description.
	Description() string
	//Extend The console command extend.
	Extend() CommandExtend
	//Handle Execute the console command.
	Handle(c *cli.Context) error
}

type CommandExtend

type CommandExtend struct {
	//Category Set command category
	Category string
	//Flags Set flags, document: https://github.com/urfave/cli/blob/master/docs/v2/manual.md#flags
	Flags []cli.Flag
	//Subcommands Set Subcommands, document: https://github.com/urfave/cli/blob/master/docs/v2/manual.md#subcommands
	Subcommands []*cli.Command
}