output

package

v0.17.2 Latest Latest Go to latest Published: Mar 9, 2026 License: MPL-2.0 Imports: 18 Imported by: 0

Documentation ¶

Overview ¶

Package output provides formatting utilities for CLI output.

Package output provides output formatting and rendering for CLI commands.

Index ¶

func CommandHelp(info CommandHelpInfo) string
type CommandHelpInfo
type PipelineRenderer
- func NewPipelineRenderer(ui terminal.UI, client *client.Client) *PipelineRenderer
- func (r *PipelineRenderer) Render(ctx context.Context, pipelineID string) error

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func CommandHelp ¶ added in v0.16.0

func CommandHelp(info CommandHelpInfo) string

CommandHelp builds and formats help text for a command with syntax highlighting. It assembles usage, description, flags, and example sections, then applies color highlighting to headers, flags, and command references.

Types ¶

type CommandHelpInfo ¶ added in v0.16.0

type CommandHelpInfo struct {
	ProductName string
	Usage       string
	Description string
	Flags       *flag.FlagSet
	Example     string
}

CommandHelpInfo contains the components of command help text.

type PipelineRenderer ¶

type PipelineRenderer struct {
	// contains filtered or unexported fields
}

PipelineRenderer displays the pipeline status in realtime

func NewPipelineRenderer ¶

func NewPipelineRenderer(ui terminal.UI, client *client.Client) *PipelineRenderer

NewPipelineRenderer returns a new PipelineRenderer

func (*PipelineRenderer) Render ¶

func (r *PipelineRenderer) Render(ctx context.Context, pipelineID string) error

Render renders the pipeline status in realtime

Source Files ¶

View all Source files

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