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 ¶
- func CommandExplain(cliParams *settings.Run, ioStreams *terminal.IOStreams, path string) *cobra.Command
- func CommandProvider(cliParams *settings.Run, ioStreams *terminal.IOStreams, path string) *cobra.Command
- func CommandSchema(cliParams *settings.Run, ioStreams *terminal.IOStreams, path string) *cobra.Command
- func CommandSolution(cliParams *settings.Run, ioStreams *terminal.IOStreams, path string) *cobra.Command
- func LoadSolution(ctx context.Context, path string) (*solution.Solution, error)
- func LookupProvider(ctx context.Context, name string, reg *provider.Registry) (*provider.Descriptor, error)
- type ActionInfo
- type CatalogInfo
- type LinkInfo
- type MaintainerInfo
- type ProviderOptions
- type ResolverInfo
- type SchemaOptions
- type SolutionExplanation
- type SolutionOptions
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
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 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
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
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 ¶
SolutionOptions holds configuration for the explain solution command