cmd

package

v0.2.3 Latest Latest Go to latest Published: Aug 17, 2024 License: MIT Imports: 8 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/Depado/fox

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func AddAllFlags(c *cobra.Command)
func AddBotFlags(c *cobra.Command)
func AddConfigurationFlag(c *cobra.Command)
func AddDatabaseFlags(c *cobra.Command)
func AddLoggerFlags(c *cobra.Command)
func NewLogger(c *Conf) zerolog.Logger
type BotConf
type Conf
- func NewConf() (*Conf, error)
type DatabaseConf
type LogConf

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	Version = "unknown"
	Build   = "unknown"
	Time    = "unknown"
	Packer  = ""
)

Build number and versions injected at compile time

View Source

var VersionCmd = &cobra.Command{
	Use:   "version",
	Short: "Show build, version and build date",
	Long:  versionHelp,
	Run: func(cmd *cobra.Command, args []string) {
		packed := ""
		if Packer != "" {
			packed = fmt.Sprintf("Packer: %s\n", Packer)
		}

		fmt.Printf("Build: %s\nVersion: %s\nBuild Date: %s\n%s", Build, Version, Time, packed)
	},
}

VersionCmd is a command that will display the build number and version (if any)

Functions ¶

func AddAllFlags ¶

func AddAllFlags(c *cobra.Command)

AddAllFlags will add all the flags provided in this package to the provided command and will bind those flags with viper.

func AddBotFlags ¶

func AddBotFlags(c *cobra.Command)

func AddConfigurationFlag ¶

func AddConfigurationFlag(c *cobra.Command)

AddConfigurationFlag adds support to provide a configuration file on the command line.

func AddDatabaseFlags ¶

func AddDatabaseFlags(c *cobra.Command)

func AddLoggerFlags ¶

func AddLoggerFlags(c *cobra.Command)

AddLoggerFlags adds support to configure the level of the logger.

func NewLogger ¶

func NewLogger(c *Conf) zerolog.Logger

NewLogger will return a new logger

Types ¶

type BotConf ¶

type BotConf struct {
	Token  string `mapstructure:"token"`
	Prefix string `mapstructure:"prefix"`
}

type Conf ¶

type Conf struct {
	Port     int          `mapstructure:"port"`
	Log      LogConf      `mapstructure:"log"`
	Bot      BotConf      `mapstructure:"bot"`
	Database DatabaseConf `mapstructure:"database"`
}

func NewConf ¶

func NewConf() (*Conf, error)

NewConf will parse and return the configuration

type DatabaseConf ¶

type DatabaseConf struct {
	Path string `mapstructure:"path"`
}

type LogConf ¶

type LogConf struct {
	Level  string `mapstructure:"level"`
	Type   string `mapstructure:"type"`
	Caller bool   `mapstructure:"caller"`
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL