examples

package
v0.13.0 Latest Latest
Warning

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

Go to latest
Published: Apr 30, 2026 License: Apache-2.0 Imports: 15 Imported by: 0

Documentation

Overview

Package examples provides commands for browsing and retrieving embedded scafctl examples.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CommandExamples

func CommandExamples(cliParams *settings.Run, ioStreams *terminal.IOStreams, path string) *cobra.Command

CommandExamples creates the 'examples' command group.

func CommandGet

func CommandGet(cliParams *settings.Run, ioStreams *terminal.IOStreams, path string) *cobra.Command

CommandGet creates the 'examples get' command.

func CommandList

func CommandList(cliParams *settings.Run, ioStreams *terminal.IOStreams, path string) *cobra.Command

CommandList creates the 'examples list' command.

Types

type GetOptions

type GetOptions struct {
	IOStreams *terminal.IOStreams
	CliParams *settings.Run
	Path      string
	Output    string // output file path (empty = stdout)
}

GetOptions holds options for the examples get command.

func (*GetOptions) Run

func (o *GetOptions) Run(ctx context.Context) error

Run executes the examples get command.

type ListOptions

type ListOptions struct {
	IOStreams      *terminal.IOStreams
	CliParams      *settings.Run
	KvxOutputFlags flags.KvxOutputFlags
	Category       string
}

ListOptions holds options for the examples list command.

func (*ListOptions) Run

func (o *ListOptions) Run(ctx context.Context) error

Run executes the examples list command.

Jump to

Keyboard shortcuts

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