output

package

v1.59.0 Latest Latest Go to latest Published: Jan 5, 2026 License: MIT Imports: 11 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/hetznercloud/cli

Links

Open Source Insights

Documentation ¶

Index ¶

func AddFlag(cmd *cobra.Command, options ...Option)
type FieldFn
type Option
type Opts
- func FlagsForCommand(cmd *cobra.Command) Opts
type Table
- func NewTable[T any](out io.Writer) *Table[T]

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func AddFlag ¶

func AddFlag(cmd *cobra.Command, options ...Option)

Types ¶

type FieldFn ¶

type FieldFn[T any] func(obj T) string

type Option ¶ added in v1.41.0

type Option struct {
	Name   string
	Values []string
}

func OptionColumns ¶

func OptionColumns(columns []string) Option

func OptionFormat ¶

func OptionFormat() Option

func OptionJSON ¶

func OptionJSON() Option

func OptionNoHeader ¶

func OptionNoHeader() Option

func OptionYAML ¶ added in v1.41.0

func OptionYAML() Option

type Opts ¶ added in v1.41.0

type Opts map[string][]string

func FlagsForCommand ¶

func FlagsForCommand(cmd *cobra.Command) Opts

func (Opts) Add ¶ added in v1.41.0

func (o Opts) Add(key, value string)

Add adds the value to key. It appends to any existing values associated with key.

func (Opts) IsSet ¶ added in v1.41.0

func (o Opts) IsSet(key string) bool

func (Opts) Set ¶ added in v1.41.0

func (o Opts) Set(key, value string)

Set sets the key to value. It replaces any existing values.

type Table ¶

type Table[T any] struct {
	// contains filtered or unexported fields
}

Table is a generic way to format object as a table.

func NewTable ¶

func NewTable[T any](out io.Writer) *Table[T]

NewTable creates a new Table.

func (*Table[T]) AddAllowedFields ¶

func (o *Table[T]) AddAllowedFields(obj T) *Table[T]

AddAllowedFields reads all first level fieldnames of the struct and allows them to be used.

func (*Table[T]) AddFieldAlias ¶

func (o *Table[T]) AddFieldAlias(field, alias string) *Table[T]

AddFieldAlias overrides the field name to allow custom column headers.

func (*Table[T]) AddFieldFn ¶

func (o *Table[T]) AddFieldFn(field string, fn FieldFn[T]) *Table[T]

AddFieldFn adds a function which handles the output of the specified field.

func (*Table[T]) Columns ¶

func (o *Table[T]) Columns() (cols []string)

Columns returns a list of known output columns.

func (*Table[T]) Flush ¶

func (o *Table[T]) Flush() error

func (*Table[T]) RemoveAllowedField ¶

func (o *Table[T]) RemoveAllowedField(fields ...string) *Table[T]

RemoveAllowedField removes fields from the allowed list.

func (*Table[T]) ToAny ¶ added in v1.56.0

func (o *Table[T]) ToAny() *Table[any]

func (*Table[T]) ValidateColumns ¶

func (o *Table[T]) ValidateColumns(cols []string) error

ValidateColumns returns an error if invalid columns are specified.

func (*Table[T]) Write ¶

func (o *Table[T]) Write(columns []string, obj T)

Write writes a table line.

func (*Table[T]) WriteHeader ¶

func (o *Table[T]) WriteHeader(columns []string)

WriteHeader writes the table header.

Source Files ¶

View all Source files

output.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL