cli

package
v1.3.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 29, 2026 License: MIT Imports: 19 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Execute

func Execute() error

Execute runs the root command.

func SetVersionInfo

func SetVersionInfo(version, commit, date string)

SetVersionInfo sets build-time version info from ldflags.

Types

type RunContext

type RunContext struct {
	Client  flashdutyClient
	Cmd     *cobra.Command
	Args    []string
	Writer  io.Writer
	Printer output.Printer
	Format  output.Format
}

RunContext provides helpers for command execution. It is created by runCommand and passed to the command's handler function.

func (*RunContext) PrintList

func (ctx *RunContext) PrintList(items any, cols []output.Column, count, page, total int) error

PrintList prints items as a table and appends a "Showing N results (page P, total T)." footer.

func (*RunContext) PrintTotal

func (ctx *RunContext) PrintTotal(items any, cols []output.Column, total int) error

PrintTotal prints items as a table and appends a "Total: N" footer.

func (*RunContext) Structured added in v1.3.1

func (ctx *RunContext) Structured() bool

Structured reports whether output should be a machine-readable dump (JSON or TOON) rather than the human table/detail view. Command handlers branch on this to suppress detail views, footers, and interactive prompts.

func (*RunContext) WriteResult

func (ctx *RunContext) WriteResult(message string)

WriteResult prints a success message as plain text or JSON.

func (*RunContext) WriteResultJSON added in v1.1.0

func (ctx *RunContext) WriteResultJSON(data any, humanMessage string) error

WriteResultJSON outputs structured data in JSON or TOON mode, or a human-readable message in table mode. JSON stays indented (byte-compatible with the legacy --json path); TOON routes through the SDK marshaller.

Jump to

Keyboard shortcuts

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