cli

Documentation

Index

• func Main(opts ...Option)
• type Command
• type Config
• type ConfigBuilder
• type Option
• type ShortDesc

Functions

func Main

func Main(opts ...Option)

Main is the entry point for programs provided by this package.

Types

type Command

type Command struct {
	Name      string
	ShortDesc string
	Build     func(ConfigBuilder) flags.Commander
}

Command is an option that adds a subcommand to the program.

type Config

type Config interface {
	Git() gateway.Git
	Repo() *repo.Repo
	GitHub() gateway.GitHub
	CurrentGitHubUser() string
}

Config is the common configuration for all programs in this package.

type ConfigBuilder

type ConfigBuilder func() (Config, error)

ConfigBuilder builds a configuration lazily.

type Option

type Option interface {
	// contains filtered or unexported methods
}

Option configures the behavior of Main.

type ShortDesc

type ShortDesc string

ShortDesc is an Option that specifies a short description of the program.