Documentation
¶
Overview ¶
Package cli contains helper functions related to flag parsing and logging.
Index ¶
- Constants
- Variables
- func ActiveCommand(command *flags.Command) string
- func ContainsString(needle string, haystack []string) bool
- func Fprintf(w io.Writer, msg string, args ...interface{})
- func InitFileLogging(logFile string, logFileLevel Verbosity)
- func InitLogging(verbosity Verbosity)
- func NewProgressReader(reader io.ReadCloser, total string) io.ReadCloser
- func ParseFlags(appname string, data interface{}, args []string, opts flags.Options, ...) (*flags.Parser, []string, error)
- func ParseFlagsFromArgsOrDie(appname string, data interface{}, args []string) string
- func ParseFlagsOrDie(appname string, data interface{}) string
- func PrintCompletions(items []flags.Completion)
- func Printf(msg string, args ...interface{})
- func ReadAllStdin() []string
- func ReadStdin() <-chan string
- func WindowSize() (int, int, error)
- type Arch
- type ByteSize
- type Duration
- type Filepath
- type LogBackend
- type StdinStrings
- type URL
- type Verbosity
- type Version
Constants ¶
const GiByte = humanize.GiByte
GiByte is a re-export for convenience of other things using it.
const MaxVerbosity = cli.MaxVerbosity
MaxVerbosity is the maximum verbosity we support.
const MinVerbosity = cli.MinVerbosity
MinVerbosity is the minimum verbosity we support.
Variables ¶
var StdErrIsATerminal = terminal.IsTerminal(int(os.Stderr.Fd()))
StdErrIsATerminal is true if the process' stderr is an interactive TTY.
var StdOutIsATerminal = terminal.IsTerminal(int(os.Stdout.Fd()))
StdOutIsATerminal is true if the process' stdout is an interactive TTY.
var StripAnsi = regexp.MustCompile("\x1b[^m]+m")
StripAnsi is a regex to find & replace ANSI console escape sequences.
Functions ¶
func ActiveCommand ¶
func ActiveCommand(command *flags.Command) string
ActiveCommand returns the name of the currently active command.
func ContainsString ¶
ContainsString returns true if the given slice contains an individual string.
func Fprintf ¶
Fprintf implements essentially fmt.Fprintf with replacements of some ANSI sequences, e.g. ${BOLD_RED} -> \x1bwhatever.
func InitFileLogging ¶
InitFileLogging initialises an optional logging backend to a file.
func NewProgressReader ¶
func NewProgressReader(reader io.ReadCloser, total string) io.ReadCloser
NewProgressReader returns a new progress bar reader.
func ParseFlags ¶
func ParseFlags(appname string, data interface{}, args []string, opts flags.Options, completionHandler cli.CompletionHandler) (*flags.Parser, []string, error)
ParseFlags parses the app's flags and returns the parser, any extra arguments, and any error encountered. It may exit if certain options are encountered (eg. --help).
func ParseFlagsFromArgsOrDie ¶
ParseFlagsFromArgsOrDie is similar to ParseFlagsOrDie but allows control over the flags passed. It returns the active command if there is one.
func ParseFlagsOrDie ¶
ParseFlagsOrDie parses the app's flags and dies if unsuccessful. Also dies if any unexpected arguments are passed. It returns the active command if there is one.
func PrintCompletions ¶
func PrintCompletions(items []flags.Completion)
PrintCompletions prints a set of completions to stdout.
func Printf ¶
func Printf(msg string, args ...interface{})
Printf is a convenience wrapper to Fprintf that always writes to stderr.
func ReadAllStdin ¶
func ReadAllStdin() []string
ReadAllStdin reads standard input in its entirety to a slice. Since this reads it completely before returning it won't handle a slow input very nicely. ReadStdin is therefore preferable when possible.
func ReadStdin ¶
func ReadStdin() <-chan string
ReadStdin reads a sequence of space-delimited words from standard input. Words are pushed onto the returned channel asynchronously.
func WindowSize ¶
WindowSize finds and returns the size of the console window as (rows, columns)
Types ¶
type Arch ¶
type Arch struct {
OS, Arch string
}
Arch represents a combined Go-style operating system and architecture pair, as in "linux_amd64".
func (*Arch) UnmarshalFlag ¶
UnmarshalFlag implements the flags.Unmarshaler interface.
func (*Arch) UnmarshalText ¶
UnmarshalText implements the encoding.TextUnmarshaler interface
type ByteSize ¶
type ByteSize uint64
A ByteSize is used for flags that represent some quantity of bytes that can be passed as human-readable quantities (eg. "10G").
func (*ByteSize) UnmarshalFlag ¶
UnmarshalFlag implements the flags.Unmarshaler interface.
func (*ByteSize) UnmarshalText ¶
UnmarshalText implements the encoding.TextUnmarshaler interface
type Duration ¶
A Duration is used for flags that represent a time duration; it's just a wrapper around time.Duration that implements the flags.Unmarshaler and encoding.TextUnmarshaler interfaces.
func (*Duration) UnmarshalFlag ¶
UnmarshalFlag implements the flags.Unmarshaler interface.
func (*Duration) UnmarshalText ¶
UnmarshalText implements the encoding.TextUnmarshaler interface
type Filepath ¶
type Filepath string
A Filepath implements completion for file paths. This is distinct from upstream's in that it knows about completing into directories.
type LogBackend ¶
type LogBackend struct {
sync.Mutex // Protects access to LogMessages
Rows, Cols, MaxRecords, InteractiveRows, MaxInteractiveRows int
Output []string
LogMessages *list.List
Formatter logging.Formatter // TODO(pebers): seems a bit weird that we have to have this here, but it doesn't
// contains filtered or unexported fields
} // seem to be possible to retrieve the formatter from outside the package?
LogBackend is the backend we use for logging during the interactive console display.
func NewLogBackend ¶
func NewLogBackend(interactiveRows int) *LogBackend
NewLogBackend constructs a new logging backend.
func (*LogBackend) Deactivate ¶
func (backend *LogBackend) Deactivate()
Deactivate removes this backend as the currently active log backend.
func (*LogBackend) RecalcLines ¶
func (backend *LogBackend) RecalcLines()
RecalcLines recalculates how many lines we have available, typically in response to the window size changing
func (*LogBackend) SetActive ¶
func (backend *LogBackend) SetActive()
SetActive sets this backend as the currently active log backend.
type StdinStrings ¶
type StdinStrings []string
StdinStrings is a type used for flags; it accepts a slice of strings but also if it's a single - it reads its contents from stdin.
func (StdinStrings) Get ¶
func (s StdinStrings) Get() []string
Get reads stdin if needed and returns the contents of this slice.
type URL ¶
type URL string
A URL is used for flags or config fields that represent a URL. It's just a string because it's more convenient that way; we haven't needed them as a net.URL so far.
func (*URL) UnmarshalFlag ¶
UnmarshalFlag implements the flags.Unmarshaler interface.
func (*URL) UnmarshalText ¶
UnmarshalText implements the encoding.TextUnmarshaler interface
type Verbosity ¶
type Verbosity = cli.Verbosity
A Verbosity is used as a flag to define logging verbosity.
type Version ¶
A Version is an extension to semver.Version extending it with the ability to recognise >= prefixes.
func MustNewVersion ¶
MustNewVersion creates a new version and dies if it is not parseable.
func NewVersion ¶
NewVersion creates a new version from the given string.
func (*Version) UnmarshalFlag ¶
UnmarshalFlag implements the flags.Unmarshaler interface.
func (*Version) UnmarshalText ¶
UnmarshalText implements the encoding.TextUnmarshaler interface
func (*Version) VersionString ¶
VersionString returns just the version, without any preceding >=.
Source Files