mirror of
https://github.com/woodpecker-ci/woodpecker.git
synced 2024-12-18 08:26:45 +02:00
24 lines
861 B
Go
24 lines
861 B
Go
|
package cli
|
||
|
|
|
||
|
|
// A command is a runnable sub-command of a CLI.
|
||
|
|
type Command interface {
|
||
|
|
// Help should return 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
|
||
|
|
|
||
|
|
// 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.
|
||
|
|
Run(args []string) int
|
||
|
|
|
||
|
|
// Synopsis should return a one-line, short synopsis of the command.
|
||
|
|
// This should be less than 50 characters ideally.
|
||
|
|
Synopsis() string
|
||
|
|
}
|
||
|
|
|
||
|
|
// CommandFactory is a type of function that is a factory for commands.
|
||
|
|
// We need a factory because we may need to setup some state on the
|
||
|
|
// struct that implements the command itself.
|
||
|
|
type CommandFactory func() (Command, error)
|