explain

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: 16 Imported by: 0

Documentation

Overview

Package explain provides the CLI explain commands. Business logic has been extracted to pkg/solution/inspect for reuse across CLI, MCP, and future API layers.

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

func LoadSolution added in v0.5.0

func LoadSolution(ctx context.Context, path string) (*solution.Solution, error)

LoadSolution delegates to pkg/solution/inspect.LoadSolution.

func LookupProvider added in v0.5.0

func LookupProvider(ctx context.Context, name string, reg *provider.Registry) (*provider.Descriptor, error)

LookupProvider delegates to pkg/solution/inspect.LookupProvider.

Types

type ActionInfo added in v0.5.0

type ActionInfo = inspect.ActionInfo

Type aliases re-exporting from pkg/solution/inspect for backward compatibility. Callers that import this package continue to work without modification.

type CatalogInfo added in v0.5.0

type CatalogInfo = inspect.CatalogInfo

Type aliases re-exporting from pkg/solution/inspect for backward compatibility. Callers that import this package continue to work without modification.

type LinkInfo added in v0.5.0

type LinkInfo = inspect.LinkInfo

Type aliases re-exporting from pkg/solution/inspect for backward compatibility. Callers that import this package continue to work without modification.

type MaintainerInfo added in v0.5.0

type MaintainerInfo = inspect.MaintainerInfo

Type aliases re-exporting from pkg/solution/inspect for backward compatibility. Callers that import this package continue to work without modification.

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 ResolverInfo added in v0.5.0

type ResolverInfo = inspect.ResolverInfo

Type aliases re-exporting from pkg/solution/inspect for backward compatibility. Callers that import this package continue to work without modification.

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 SolutionExplanation added in v0.5.0

type SolutionExplanation = inspect.SolutionExplanation

Type aliases re-exporting from pkg/solution/inspect for backward compatibility. Callers that import this package continue to work without modification.

func BuildSolutionExplanation added in v0.5.0

func BuildSolutionExplanation(sol *solution.Solution) *SolutionExplanation

BuildSolutionExplanation delegates to pkg/solution/inspect.BuildSolutionExplanation.

type SolutionOptions

type SolutionOptions struct {
	IOStreams *terminal.IOStreams
	CliParams *settings.Run
	File      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