explain

package
v0.4.0 Latest Latest
Warning

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

Go to latest
Published: Feb 17, 2026 License: Apache-2.0 Imports: 20 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CommandExplain

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

CommandExplain creates the 'explain' command which provides detailed documentation about resource schemas and solution/provider instances.

func CommandProvider

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

CommandProvider creates the 'explain provider' subcommand

func CommandSchema

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

CommandSchema creates the 'explain <kind>' subcommand for schema browsing

func CommandSolution

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

CommandSolution creates the 'explain solution' subcommand

Types

type ProviderOptions

type ProviderOptions struct {
	IOStreams *terminal.IOStreams
	CliParams *settings.Run
	// contains filtered or unexported fields
}

ProviderOptions holds configuration for the explain provider command

func (*ProviderOptions) Run

func (o *ProviderOptions) Run(ctx context.Context, name string) error

Run executes the explain provider command

type SchemaOptions

type SchemaOptions struct {
	IOStreams *terminal.IOStreams
	CliParams *settings.Run

	// Expression is a CEL-style path to drill into nested fields
	Expression string

	// Recursive shows all nested fields at full depth
	Recursive bool
}

SchemaOptions holds configuration for the explain schema command

func (*SchemaOptions) Run

func (o *SchemaOptions) Run(_ context.Context, args []string) error

Run executes the explain schema command

type SolutionOptions

type SolutionOptions struct {
	IOStreams *terminal.IOStreams
	CliParams *settings.Run
	Path      string
}

SolutionOptions holds configuration for the explain solution command

func (*SolutionOptions) Run

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

Run executes the explain solution command

Jump to

Keyboard shortcuts

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