common

Documentation

Index

• Variables
• func GetCommands() []*cli.Command
• func GetSubcommands(group string) []*cli.Command
• func RegisterCommand(command *cli.Command)
• func RegisterSubcommand(group string, command *cli.Command)
• type AppVersionInfo
• type Commander
• type ContextKey

Variables

var BRANCH = "main"

var COMMIT = "dirty"

var NAME = "dockit"

var SUMMARY = "0.4.0-main"

var VERSION = "0.4.0"

Functions

func GetCommands

func GetCommands() []*cli.Command

GetCommands --

func GetSubcommands

func GetSubcommands(group string) []*cli.Command

func RegisterCommand

func RegisterCommand(command *cli.Command)

RegisterCommand --

func RegisterSubcommand

func RegisterSubcommand(group string, command *cli.Command)

Types

type AppVersionInfo

type AppVersionInfo struct {
	Name    string
	Version string
	Branch  string
	Summary string
	Commit  string
}

AppVersionInfo --

var AppVersion AppVersionInfo

AppVersion --

type Commander

type Commander interface {
	Execute(c *cli.Context)
}

Commander --

type ContextKey

type ContextKey string

const ContextKeyDb ContextKey = "db"

ContextKeyDb is used to set context value for db

const ContextKeyNode ContextKey = "node"

ContextKeyNode is used to set context value for node/snowflake

const ContextKeyWebsocket ContextKey = "websocket"

ContextKeyWebsocket is used to set context value for passing websocket

const ContextReqIDKey ContextKey = "reqid"

Common Constants, mostly for annotations