output

Documentation

Overview

Package output renders command results as a human table or as machine JSON or YAML, selected by the --format flag. Agents pass --format json for a stable, parseable surface.

Index

• func Blue(s string) string
• func Bold(s string) string
• func Check() string
• func Emit(format string, v interface{}, tableFn func() Table) error
• func Green(s string) string
• func Slate(s string) string
• func Str(m map[string]interface{}, key string) string
• func Success(w io.Writer, format string, a ...interface{})
• func Wordmark() string
• type Table

Functions

func Blue

func Blue(s string) string

func Bold

func Bold(s string) string

func Check

func Check() string

Check returns a light brand-green check mark (plain ASCII when colour is off).

func Emit

func Emit(format string, v interface{}, tableFn func() Table) error

Emit writes v in the requested format. For "table" it calls tableFn to build the columns; for "json"/"yaml" it marshals v directly. tableFn may be nil when only structured output makes sense.

func Green

func Green(s string) string

Green/Blue/Slate/Bold colourise a string for human terminals (no-ops when colour is disabled).

func Slate

func Slate(s string) string

func Str

func Str(m map[string]interface{}, key string) string

Str returns a string field from a generic record, or "" if absent.

func Success

func Success(w io.Writer, format string, a ...interface{})

Success writes a "✔ <message>" line (to stderr by convention, so stdout stays the data channel for piping).

func Wordmark

func Wordmark() string

Wordmark returns the "privasys" wordmark in bold white (the brand colours stay on the logo mark, not the name).

Types

type Table

type Table struct {
	Headers []string
	Rows    [][]string
}

Table is a set of column headers and rows.