cli

Documentation

Index

• Constants
• Variables
• func ParseTrustDomain(trustDomain string, logger logrus.FieldLogger) (spiffeid.TrustDomain, error)
• func SetUmask(log logrus.FieldLogger)
• func WarnOnLongTrustDomainName(td spiffeid.TrustDomain, logger logrus.FieldLogger)
• type BoolFlag
  • func (b *BoolFlag) Set(val string) error
  • func (b *BoolFlag) String() string
• type CommaStringsFlag
  • func (f *CommaStringsFlag) Set(v string) error
  • func (f CommaStringsFlag) String() string
• type DurationFlag
  • func (f *DurationFlag) Set(v string) error
  • func (f DurationFlag) String() string
• type Env
  • func (e *Env) ErrPrintf(format string, args ...any) error
  • func (e *Env) ErrPrintln(args ...any) error
  • func (e *Env) JoinPath(parts ...string) string
  • func (e *Env) Printf(format string, args ...any) error
  • func (e *Env) Println(args ...any) error
• type StringsFlag
  • func (s *StringsFlag) Set(val string) error
  • func (s *StringsFlag) String() string

Constants

const BoolFlagAll = 0

const BoolFlagFalse = 1

const BoolFlagTrue = 2

Variables

var (
	// DefaultEnv is the default environment used by commands
	DefaultEnv = &Env{
		Stdin:  os.Stdin,
		Stdout: os.Stdout,
		Stderr: os.Stderr,
	}
)

Functions

func ParseTrustDomain

func ParseTrustDomain(trustDomain string, logger logrus.FieldLogger) (spiffeid.TrustDomain, error)

ParseTrustDomain parses a configured trustDomain in a consistent way for either the SPIRE agent or server.

func SetUmask

func SetUmask(log logrus.FieldLogger)

SetUmask sets the minimumUmask.

func WarnOnLongTrustDomainName

func WarnOnLongTrustDomainName(td spiffeid.TrustDomain, logger logrus.FieldLogger)

Types

type BoolFlag

type BoolFlag int

BoolFlag is used to define 3 possible states: true, false, or all. Take care that false=1, and true=2

func (*BoolFlag) Set

func (b *BoolFlag) Set(val string) error

func (*BoolFlag) String

func (b *BoolFlag) String() string

type CommaStringsFlag

type CommaStringsFlag []string

CommaStringsFlag facilitates parsing flags representing a comma separated list of strings

func (*CommaStringsFlag) Set

func (f *CommaStringsFlag) Set(v string) error

func (CommaStringsFlag) String

func (f CommaStringsFlag) String() string

type DurationFlag

type DurationFlag time.Duration

DurationFlag facilitates parsing flags representing a time.Duration

func (*DurationFlag) Set

func (f *DurationFlag) Set(v string) error

func (DurationFlag) String

func (f DurationFlag) String() string

type Env

type Env struct {
	Stdin   io.Reader
	Stdout  io.Writer
	Stderr  io.Writer
	BaseDir string
}

Env provides a pluggable environment for CLI commands that facilitates easy testing.

func (*Env) ErrPrintf

func (e *Env) ErrPrintf(format string, args ...any) error

func (*Env) ErrPrintln

func (e *Env) ErrPrintln(args ...any) error

func (*Env) JoinPath

func (e *Env) JoinPath(parts ...string) string

func (*Env) Printf

func (e *Env) Printf(format string, args ...any) error

func (*Env) Println

func (e *Env) Println(args ...any) error

type StringsFlag

type StringsFlag []string

StringsFlag facilitates setting multiple flags

func (*StringsFlag) Set

func (s *StringsFlag) Set(val string) error

func (*StringsFlag) String

func (s *StringsFlag) String() string