cmd

README

Command line tools available for building

Docker Images

All docker images have reasonable defaults and are set up to run the main application for each service.

Check docker-compose.yml in each app for more information.

# Run:
docker-compose -f ./cmd/<app>/docker-compose.yml run --rm <app> --help
# to see available options and additional commands.

Documentation

Index

• Variables
• func NewFilesFlagSet(cfp *FilesFlags) *pflag.FlagSet
• func NewLoggerFlagSet(logger *LoggerFlags) *pflag.FlagSet
• func NewRootCommand(name, version string, sets ...*pflag.FlagSet) *cobra.Command
• func NewRunCmd(c supervisor.Config, f *FilesFlags, l *LoggerFlags) *cobra.Command
• type FilesFlags
  • func (cf FilesFlags) Load(c any) error
• type LoggerFlags
  • func (f *LoggerFlags) Formatter() logrus.Formatter
  • func (logger *LoggerFlags) Logger() log.Logger
  • func (f *LoggerFlags) Verbosity() logrus.Level

Variables

var Version = "unknown"

Version that can be used by commands. It is supposed to by set by the linker during build.

Functions

func NewFilesFlagSet

func NewFilesFlagSet(cfp *FilesFlags) *pflag.FlagSet

NewFilesFlagSet binds CLI args [--config or -c] for config files as a pflag.FlagSet.

func NewLoggerFlagSet

func NewLoggerFlagSet(logger *LoggerFlags) *pflag.FlagSet

func NewRootCommand

func NewRootCommand(name, version string, sets ...*pflag.FlagSet) *cobra.Command

NewRootCommand returns a Cobra command with the given name and version. It also adds all the provided pflag.FlagSet items to the command's persistent flags.

func NewRunCmd

func NewRunCmd(c supervisor.Config, f *FilesFlags, l *LoggerFlags) *cobra.Command

Types

type FilesFlags

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

FilesFlags is used to load multiple config files.

func (FilesFlags) Load

func (cf FilesFlags) Load(c any) error

Load loads the config files into the given config struct.

type LoggerFlags

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

LoggerFlags is a set of flags for configuring a logger. It glues together the pflag.Value interface with the log.Logger interface.

func (*LoggerFlags) Formatter

func (f *LoggerFlags) Formatter() logrus.Formatter

Formatter returns the logrus.Formatter for selected type.

func (*LoggerFlags) Logger

func (logger *LoggerFlags) Logger() log.Logger

func (*LoggerFlags) Verbosity

func (f *LoggerFlags) Verbosity() logrus.Level