shared

Documentation

Index

• Variables
• func Config() *config.Config
• func Controller() hostctl.Controller
• func ConvertErr(err error) error
• func Example(s string) string
• func VersionString() string
• type BindNotAllowedError
  • func (BindNotAllowedError) Code() string
  • func (BindNotAllowedError) Error() string
• type DaemonNotRunningError
  • func (DaemonNotRunningError) Code() string
  • func (DaemonNotRunningError) Error() string
• type DaemonRunningError
  • func (DaemonRunningError) Code() string
  • func (x DaemonRunningError) Error() string
• type LocaliasError

Variables

var (
	Version = "unknown" //nolint:gochecknoglobals
	Commit  = "unknown" //nolint:gochecknoglobals
)

These will be set at build time with ldflags, see Justfile for how they're defined and passed.

var Flags struct {
	Configfile *string
}

Functions

func Config

func Config() *config.Config

func Controller

func Controller() hostctl.Controller

func ConvertErr

func ConvertErr(err error) error

func Example

func Example(s string) string

Example is a helper for generating CLI example docs for cobra commands. It removes any surrounding space from a string, then removes any leading whitespace from each line in the string. Any comments in the string will be colored as faint.

func VersionString

func VersionString() string

Types

type BindNotAllowedError

type BindNotAllowedError struct{}

bind: permission denied

func (BindNotAllowedError) Code

func (BindNotAllowedError) Code() string

func (BindNotAllowedError) Error

func (BindNotAllowedError) Error() string

type DaemonNotRunningError

type DaemonNotRunningError struct{}

func (DaemonNotRunningError) Code

func (DaemonNotRunningError) Code() string

func (DaemonNotRunningError) Error

func (DaemonNotRunningError) Error() string

type DaemonRunningError

type DaemonRunningError struct {
	Pid int
}

func (DaemonRunningError) Code

func (DaemonRunningError) Code() string

func (DaemonRunningError) Error

func (x DaemonRunningError) Error() string

type LocaliasError

type LocaliasError interface {
	Error() string
	Code() string
}