console

Documentation

Index

• type Context
• type IArtisan
• type ICommand

Types

type Context

type Context interface {
	Argument(index int) string
	Arguments() []string

	Option(name string) any
	PathOption(name string) string
	TimeOption(name string) *time.Time
	DurationOption(name string) time.Duration
	StringOption(name string) string
	StringSliceOption(name string) []string
	IntSliceOption(name string) []int
	Int64Option(name string) int64
	Uint64Option(name string) uint64
	IntOption(name string) int
	BoolOption(name string) bool
	UintOption(name string) uint
	Float64Option(name string) float64
	Float64SliceOption(name string) []float64

	NumOptions() int
	HasOption(name string) bool
}

type IArtisan

type IArtisan interface {
	//Register commands.
	Register(commands []ICommand)

	//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 ICommand

type ICommand 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() command.Extend
	//Handle Execute the console command.
	Handle(ctx Context) error
}