command

package

v0.0.0-...-210b95a Latest Latest Go to latest Published: Apr 9, 2025 License: MIT Imports: 6 Imported by: 0

Details

This section is empty.

This section is empty.

func Commands() map[string]Command

func Register(name string, cmd Command)

type Args struct {
	errors.Context
	// contains filtered or unexported fields
}

func (req *Args) AssertNoMoreArgs()

func (req *Args) LastArg() (arg string, ok bool)

func (req *Args) PeekArgs() []string

func (req *Args) PopArg(name string) string

func (req *Args) PopArgs() []string

func (req *Args) RemainingArgCount() int

type Command interface {
	interfaces.CommandComponent
	Run(Request)
}

TODO add description

type CommandLine struct {
	FlagsOrArgs []string
	InProgress  string
}

func (commandLine CommandLine) LastArg() (arg string, ok bool)

func (commandLine CommandLine) LastCompleteArg() (arg string, ok bool)

type Completer interface {
	Complete(Request, env_local.Env, CommandLine)
}

type Completion struct {
	Value, Description string
}

type Description struct {
	Short, Long string
}

type FlagSet = flag.FlagSet

type FlagValueCompleter struct {
	flag.Value
	FuncCompleter
}

func (completer FlagValueCompleter) Complete(
	req Request,
	envLocal env_local.Env,
	commandLine CommandLine,
)

func (completer FlagValueCompleter) String() string

type FuncCompleter func(Request, env_local.Env, CommandLine)

type HasDescription interface {
	GetDescription() Description
}

type Request struct {
	errors.Context
	config_mutable_cli.Config
	*flag.FlagSet
	*Args
}

func MakeRequest(
	ctx errors.Context,
	config config_mutable_cli.Config,
	flagSet *flag.FlagSet,
) Request

type SupportsCompletion interface {
	SupportsCompletion()
}