cliutil

Documentation

Index

• Variables
• func Action(actionFunc cli.ActionFunc) cli.ActionFunc
• func ConfigureLoggingFlags(shouldHide bool) []cli.Flag
• func ConfiguredAction(actionFunc cli.ActionFunc) cli.ActionFunc
• func ConfiguredActionWithWarnings(actionFunc func(*cli.Context, string) error) cli.ActionFunc
• func FileChecksum(filePath string) (string, error)
• func RemovedCommand(name string) *cli.Command
• func UsageError(format string, args ...interface{}) error
• func WithErrorHandler(actionFunc cli.ActionFunc) cli.ActionFunc
• type BuildInfo
  • func GetBuildInfo(buildType, version string) *BuildInfo
  • func (bi *BuildInfo) GetBuildTypeMsg() string
  • func (bi *BuildInfo) Log(log *zerolog.Logger)
  • func (bi *BuildInfo) OSArch() string
  • func (bi *BuildInfo) UserAgent() string
  • func (bi *BuildInfo) Version() string

Variables

var (
	FlagLogOutput = &cli.StringFlag{
		Name:    flags.LogFormatOutput,
		Usage:   "Output format for the logs (default, json)",
		Value:   flags.LogFormatOutputValueDefault,
		EnvVars: []string{"TUNNEL_MANAGEMENT_OUTPUT", "TUNNEL_LOG_OUTPUT"},
	}
)

Functions

func Action

func Action(actionFunc cli.ActionFunc) cli.ActionFunc

func ConfigureLoggingFlags

func ConfigureLoggingFlags(shouldHide bool) []cli.Flag

func ConfiguredAction

func ConfiguredAction(actionFunc cli.ActionFunc) cli.ActionFunc

func ConfiguredActionWithWarnings

func ConfiguredActionWithWarnings(actionFunc func(*cli.Context, string) error) cli.ActionFunc

Just like ConfiguredAction, but accepts a second parameter with configuration warnings.

func FileChecksum

func FileChecksum(filePath string) (string, error)

FileChecksum opens a file and returns the SHA256 checksum.

func RemovedCommand

func RemovedCommand(name string) *cli.Command

func UsageError

func UsageError(format string, args ...interface{}) error

func WithErrorHandler

func WithErrorHandler(actionFunc cli.ActionFunc) cli.ActionFunc

Ensures exit with error code if actionFunc returns an error

Types

type BuildInfo

type BuildInfo struct {
	GoOS               string `json:"go_os"`
	GoVersion          string `json:"go_version"`
	GoArch             string `json:"go_arch"`
	BuildType          string `json:"build_type"`
	CloudflaredVersion string `json:"cloudflared_version"`
	Checksum           string `json:"checksum"`
}

func GetBuildInfo

func GetBuildInfo(buildType, version string) *BuildInfo

func (*BuildInfo) GetBuildTypeMsg

func (bi *BuildInfo) GetBuildTypeMsg() string

func (*BuildInfo) Log

func (bi *BuildInfo) Log(log *zerolog.Logger)

func (*BuildInfo) OSArch

func (bi *BuildInfo) OSArch() string

func (*BuildInfo) UserAgent

func (bi *BuildInfo) UserAgent() string

func (*BuildInfo) Version

func (bi *BuildInfo) Version() string