clui

type AutoCompleter interface {
	// Complete a command from completion line in environment variable,
	// and print out the complete options.
	// Returns success if the completion ran or if the cli matched
	// any of the given flags, false otherwise
	Complete(string) ([]string, bool)

	// Install a command into the host using the Installer.
	// Returns an error if there is an error whilst installing.
	Install(string) error

	// Uninstall the command from the host using the Installer.
	// Returns an error if there is an error whilst it's uninstalling.
	Uninstall(string) error
}

type CLI struct {
	// contains filtered or unexported fields
}

type CLIOption func(CLIOptions)

type CLIOptions interface {
	SetHelpFunc(help.Func)
	SetAutoCompleter(AutoCompleter)
	SetUI(UI)
	SetFileSystem(fsys.FileSystem)
}

type Command interface {

	// Flags returns the FlagSet associated with the command. All the flags are
	// parsed before running the command.
	FlagSet() *flagset.FlagSet

	// Usages returns various usages that can be used for the command.
	Usages() []string

	// Help should return a long-form help text that includes the command-line
	// usage. A brief few sentences explaining the function of the command, and
	// the complete list of flags the command accepts.
	Help() string

	// Synopsis should return a one-line, short synopsis of the command.
	// This should be short (50 characters of less ideally).
	Synopsis() string

	// Init is called with all the args required to run a command.
	// This is separated from Run, to allow the preperation of a command, before
	// it's run.
	Init([]string, commands.CommandContext) error

	// Run should run the actual command with the given CLI instance and
	// command-line arguments. It should return the exit status when it is
	// finished.
	//
	// There are a handful of special exit codes that can return documented
	// behavioral changes.
	Run(*task.Group)
}

type CommandFn func(UI) Command

type Errno int

type GlobalArgs struct {
	// contains filtered or unexported fields
}

type UI interface {
	// Ask asks the user for input using the given query. The response is
	// returned as the given string, or an error.
	Ask(string) (string, error)

	// AskSecret asks the user for input using the given query, but does not echo
	// the keystrokes to the terminal.
	AskSecret(string) (string, error)

	// Output is called for normal standard output.
	Output(*ui.Template, interface{}) error

	// Info is called for information related to the previous output.
	// In general this may be the exact same as Output, but this gives
	// UI implementors some flexibility with output formats.
	Info(string)

	// Error is used for any error messages that might appear on standard
	// error.
	Error(string)
}