Documentation
¶
Index ¶
- func New(v any) (provider.Provider, error)
- type Spec
- func (s *Spec) Configure(cmd *cobra.Command)
- func (s *Spec) Execute(ctx context.Context, in provider.Inputs) (*provider.Result, error)
- func (s *Spec) Preview(_ context.Context, in provider.Inputs) (*provider.RequestPreview, error)
- func (s *Spec) Sections() []provider.Section
- func (s *Spec) Summary() string
- func (s *Spec) Type() string
- func (s *Spec) Validate() error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Spec ¶
type Spec struct {
Name string `json:"name" yaml:"name"`
Args []string `json:"args,omitempty" yaml:"args,omitempty"`
Parameters provider.ParameterSet `json:"params,omitempty" yaml:"params,omitempty"`
Echo bool `json:"echo,omitempty" yaml:"echo,omitempty"`
}
Spec describes the provider.
func (*Spec) Configure ¶ added in v0.5.0
Configure wires up the command's positional arguments, flags, and run behavior.
func (*Spec) Execute ¶ added in v0.8.0
Execute assigns the collected parameter values, runs the command, and returns its combined output (stdout+stderr) as a text result. The process exit code is reported in the result rather than terminating clic.
func (*Spec) Preview ¶ added in v0.9.0
Preview reports the resolved command line and the headless CLI arguments that reproduce it, without running anything.
func (*Spec) Sections ¶ added in v0.8.0
Sections describes the command's parameters for interactive entry.
Source Files
Click to show internal directories.
Click to hide internal directories.