app

Documentation

Index

• type Application
  • func NewApplication(name string, basename string, opts ...Option) *Application
  • func (a *Application) Command() *cobra.Command
  • func (a *Application) Run()
• type CliOptions
• type CompletableOptions
• type Option
  • func WithDefaultValidArgs() Option
  • func WithDescription(desc string) Option
  • func WithNoConfig() Option
  • func WithNoVersion() Option
  • func WithOptions(opt CliOptions) Option
  • func WithRunFunc(run RunFunc) Option
  • func WithSilence() Option
  • func WithValidArgs(args cobra.PositionalArgs) Option
• type PrintableOptions
• type RunFunc

Types

type Application

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

Application cli 应用程序的主要结构。 建议使用 app.NewApplication() 函数创建应用程序。

func NewApplication

func NewApplication(name string, basename string, opts ...Option) *Application

NewApplication 基于给定的应用程序名称、二进制名称和其他选项创建一个新的应用程序实例。

func (*Application) Command

func (a *Application) Command() *cobra.Command

Command 返回应用程序内的 cobra 实例。

func (*Application) Run

func (a *Application) Run()

Run 用于启动应用程序。

type CliOptions

type CliOptions interface {
	Flags() (fss flag.NamedFlagSets)
	Validate() []error
}

CliOptions abstracts 从命令行读取参数的配置选项。

type CompletableOptions

type CompletableOptions interface {
	Complete() error
}

CompletableOptions abstracts 完成的选项。

type Option

type Option func(*Application)

Option 定义用于初始化应用程序结构的可选参数。

func WithDefaultValidArgs

func WithDefaultValidArgs() Option

WithDefaultValidArgs set default validation function to valid non-flag arguments.

func WithDescription

func WithDescription(desc string) Option

WithDescription 用于设置应用程序的描述。

func WithNoConfig

func WithNoConfig() Option

WithNoConfig set the application does not provide config flag.

func WithNoVersion

func WithNoVersion() Option

WithNoVersion set the application does not provide version flag.

func WithOptions

func WithOptions(opt CliOptions) Option

WithOptions 打开应用程序的函数从命令行读取或从配置文件读取参数。

func WithRunFunc

func WithRunFunc(run RunFunc) Option

WithRunFunc 用于设置应用程序启动回调函数选项。

func WithSilence

func WithSilence() Option

WithSilence 将应用程序设置为静音模式， 在该模式下，程序启动信息、配置信息和版本信息不会打印在控制台中。

func WithValidArgs

func WithValidArgs(args cobra.PositionalArgs) Option

WithValidArgs set the validation function to valid non-flag arguments.

type PrintableOptions

type PrintableOptions interface {
	String() string
}

PrintableOptions abstracts 打印的选项。

type RunFunc

type RunFunc func(basename string) error

RunFunc 定义了应用程序的启动回调函数。