provider

package
v0.7.0 Latest Latest
Warning

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

 Go to latest Published: Jun 6, 2026 License: MIT Imports: 9 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	FlagServer   = "server"
	FlagToken    = "token"
	FlagUsername = "username"
	FlagPassword = "password"
	FlagAPIKey   = "api-key"
)

Names of clic's global flags used for server selection and auth.

View Source 
const (
	AuthBearer = "bearer"
	AuthBasic  = "basic"
	AuthAPIKey = "apikey"
)

Auth scheme types.

View Source 
const (
	// BoolParamType is a bool parameter.
	BoolParamType = "bool"

	// IntParamType is an int parameter.
	IntParamType = "int"

	// NumberParamType is a number parameter.
	NumberParamType = "number"

	// StringParamType is a string parameter.
	StringParamType = "string"
)
View Source 
const FlagInteractive = "interactive"

FlagInteractive is clic's persistent flag that opts into interactive prompts (e.g. building a request body via a form instead of passing raw JSON).

Variables

This section is empty.

Functions

func NewInvalidParameterSpecError 

func NewInvalidParameterSpecError(reason string) error

NewInvalidParameterSpecError creates a new error indicating that a parameter spec is invalid.

func RegisterGlobalFlags added in v0.7.0 

func RegisterGlobalFlags(flags *pflag.FlagSet, defaultServer string)

RegisterGlobalFlags registers clic's invocation-wide flags on the given flag set. These are clic's own flags, distinct from any spec-derived parameters; defaultServer pre-populates the --server override (use "" when unknown).

func WithAuth added in v0.6.0 

func WithAuth(ctx context.Context, a *AuthScheme) context.Context

WithAuth returns a context carrying the given auth scheme.

func WithOptions added in v0.7.0 

func WithOptions(ctx context.Context, o *Options) context.Context

WithOptions returns a context carrying the given options.

Types

type AuthScheme added in v0.6.0 

type AuthScheme struct {
	Type string `json:"type"           yaml:"type"`           // bearer | basic | apikey
	In   string `json:"in,omitempty"   yaml:"in,omitempty"`   // header | query (apikey)
	Name string `json:"name,omitempty" yaml:"name,omitempty"` // header/query name (apikey)
}

AuthScheme describes how requests are authenticated, surfaced as CLI flags with CLIC_* environment-variable fallback.

func AuthFromContext added in v0.6.0 

func AuthFromContext(ctx context.Context) *AuthScheme

AuthFromContext returns the auth scheme carried by the context, if any.

func (*AuthScheme) Apply added in v0.6.0 

func (a *AuthScheme) Apply(req *http.Request, o *Options)

Apply adds credentials to the request using the values resolved into the given options.

type Options added in v0.7.0 

type Options struct {
	Server      string
	Interactive bool
	Token       string
	Username    string
	Password    string
	APIKey      string
}

Options carries clic's invocation-wide settings. They are resolved from clic's own global flags (with CLIC_* environment fallback for credentials) and threaded to providers via the context, deliberately kept out of the per-command flag namespace so they can never collide with a spec parameter.

func OptionsFromContext added in v0.7.0 

func OptionsFromContext(ctx context.Context) *Options

OptionsFromContext returns the options carried by the context, or zero-valued options when none are present.

func ResolveOptions added in v0.7.0 

func ResolveOptions(flags *pflag.FlagSet) *Options

ResolveOptions reads clic's global flags from the given flag set into an Options value, falling back to CLIC_* environment variables for credentials.

type Parameter 

type Parameter struct {
	Name        string `json:"name"                  yaml:"name"`
	Description string `json:"description,omitempty" yaml:"description,omitempty"`
	Type        string `json:"type"                  yaml:"type"`
	Required    bool   `json:"required"              yaml:"required"`
	Default     any    `json:"default,omitempty"     yaml:"default,omitempty"`
	AsFlag      string `json:"as_flag,omitempty"     yaml:"as_flag,omitempty"`
	// contains filtered or unexported fields
}

A Parameter specifies a command parameter.

func NewParameter 

func NewParameter(content []byte) (*Parameter, error)

NewParameter creates a new Parameter from the provided spec.

func (*Parameter) CLIFlagName 

func (param *Parameter) CLIFlagName() string

CLIFlagName returns the parameter name formatted as a CLI flag name. The original Name is preserved for use as the request key (header/query/body); only the flag spelling is normalized to lower-kebab-case.

func (*Parameter) SetDefaultValue 

func (param *Parameter) SetDefaultValue()

SetDefaultValue assigns the default value to the parameter.

func (*Parameter) SetValue 

func (param *Parameter) SetValue(value any)

SetValue assigns a value to the parameter.

func (*Parameter) Validate 

func (param *Parameter) Validate() error

Validate validates a Parameter.

func (*Parameter) Value 

func (param *Parameter) Value() any

Value returns the parameter's assigned value.

type ParameterSet 

type ParameterSet []*Parameter

A ParameterSet is a slice of parameter pointers.

func (ParameterSet) ArgsUsage added in v0.5.0 

func (ps ParameterSet) ArgsUsage() string

ArgsUsage returns a usage string describing the set's required positional arguments.

func (ParameterSet) InjectPathValues added in v0.6.0 

func (ps ParameterSet) InjectPathValues(endpoint string) string

InjectPathValues substitutes {name} placeholders in a URL path template with the URL-escaped values of the matching parameters.

func (ParameterSet) InjectValues 

func (ps ParameterSet) InjectValues(str string) string

InjectValues replaces all param references with their corresponding values in the given string.

func (ParameterSet) Optional 

func (ps ParameterSet) Optional() ParameterSet

Optional returns a subset of the ParameterSet containing only optional parameters.

func (ParameterSet) RegisterAsFlags added in v0.6.0 

func (ps ParameterSet) RegisterAsFlags(cmd *cobra.Command)

RegisterAsFlags registers every parameter in the set as a flag, marking required parameters as required flags on the command.

func (ParameterSet) RegisterFlags added in v0.5.0 

func (ps ParameterSet) RegisterFlags(flags *pflag.FlagSet)

RegisterFlags registers the set's optional parameters as flags on the given flag set.

func (ParameterSet) Required 

func (ps ParameterSet) Required() ParameterSet

Required returns a subset of the ParameterSet containing only required parameters.

func (ParameterSet) ResolveFromFlags added in v0.6.0 

func (ps ParameterSet) ResolveFromFlags(cmd *cobra.Command)

ResolveFromFlags assigns every parameter's value from its flag, applying defaults for optional parameters that were not set.

func (ParameterSet) ResolveValues 

func (ps ParameterSet) ResolveValues(cmd *cobra.Command, args []string) error

ResolveValues assigns values to the parameters from the positional arguments, flags, and defaults provided via the cobra command.

func (ParameterSet) Validate 

func (ps ParameterSet) Validate() error

Validate validates the parameter set, returning the first error it encounters, if any.

type Provider 

type Provider interface {
	// Configure wires the provider's positional arguments, flags, and run
	// behavior onto the given cobra command.
	Configure(cmd *cobra.Command)
	Type() string
	Validate() error
}

A Provider defines what happens when a command is invoked on the command line.

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.