cli

Documentation

Index

• type App
  • func New(name string) *App
  • func (app *App) RunMain()
• type CommonOptions
• type DBOptions
• type LogOptions
• type VersionCommand
  • func (v *VersionCommand) Execute(args []string) error

Types

type App

type App struct {
	*flags.Parser

	Name string
}

App defines the CLI application that will be run.

func New

func New(name string) *App

New creates a new App, including default values.

func (*App) RunMain

func (app *App) RunMain()

RunMain parses arguments and runs commands

type CommonOptions

type CommonOptions struct {
	LogOptions
	GrpcMaxMsgSize int `` /* 146-byte string literal not displayed */
}

CommonOptions contains common flags for all commands

type DBOptions

type DBOptions struct {
	DB string `` /* 157-byte string literal not displayed */
}

DBOptions contains common flags for commands using the DB

type LogOptions

type LogOptions struct {
	LogLevel       string `long:"log-level" env:"LOG_LEVEL" default:"info" description:"Logging level (info, debug, warning or error)"`
	LogFormat      string `long:"log-format" env:"LOG_FORMAT" description:"log format (text or json), defaults to text on a terminal and json otherwise"`
	LogFields      string `long:"log-fields" env:"LOG_FIELDS" description:"default fields for the logger, specified in json"`
	LogForceFormat bool   `long:"log-force-format" env:"LOG_FORCE_FORMAT" description:"ignore if it is running on a terminal or not"`
	Verbose        bool   `long:"verbose" short:"v" description:"enable verbose logging"`
}

LogOptions defines logging flags. It is meant to be embedded in a command struct.

type VersionCommand

type VersionCommand struct {
	// Name of the binary
	Name string
	// Version of the binary
	Version string
	// Build of the binary
	Build string
}

VersionCommand represents the `version` command of the CLI.

func (*VersionCommand) Execute

func (v *VersionCommand) Execute(args []string) error

Execute prints the build information provided at the compilation time.