cli

Documentation

Index

• Constants
• func AddCommandsToRootCommand(rootCmd *cobra.Command, commands []cmds.Command, aliases []*alias.CommandAlias, ...) error
• func AddGlazedProcessorFlagsToCobraCommand(cmd *cobra.Command, options ...settings.GlazeParameterLayerOption) error
• func BuildCobraCommandAlias(alias *alias.CommandAlias, options ...CobraParserOption) (*cobra.Command, error)
• func BuildCobraCommandFromBareCommand(c cmds.BareCommand, options ...CobraParserOption) (*cobra.Command, error)
• func BuildCobraCommandFromCommand(command cmds.Command, options ...CobraParserOption) (*cobra.Command, error)
• func BuildCobraCommandFromCommandAndFunc(s cmds.Command, run CobraRunFunc, options ...CobraParserOption) (*cobra.Command, error)
• func BuildCobraCommandFromGlazeCommand(cmd_ cmds.GlazeCommand, options ...CobraParserOption) (*cobra.Command, error)
• func BuildCobraCommandFromWriterCommand(s cmds.WriterCommand, options ...CobraParserOption) (*cobra.Command, error)
• func CobraCommandDefaultMiddlewares(commandSettings *GlazedCommandSettings, cmd *cobra.Command, args []string) ([]cmd_middlewares.Middleware, error)
• func CreateGlazedProcessorFromCobra(cmd *cobra.Command) (*middlewares.TableProcessor, formatters.OutputFormatter, error)
• func GetVerbsFromCobraCommand(cmd *cobra.Command) []string
• func NewCobraCommandFromCommandDescription(description *cmds.CommandDescription) *cobra.Command
• func NewGlazedCommandLayer() (layers.ParameterLayer, error)
• type CobraMiddlewaresFunc
• type CobraParser
  • func NewCobraParserFromLayers(layers *layers.ParameterLayers, options ...CobraParserOption) (*CobraParser, error)
  • func (c *CobraParser) AddToCobraCommand(cmd *cobra.Command) error
  • func (c *CobraParser) Parse(cmd *cobra.Command, args []string) (*layers.ParsedLayers, error)
• type CobraParserOption
  • func WithCobraMiddlewaresFunc(middlewaresFunc CobraMiddlewaresFunc) CobraParserOption
  • func WithCobraShortHelpLayers(layers ...string) CobraParserOption
  • func WithSkipGlazedCommandLayer() CobraParserOption
• type CobraRunFunc
• type GlazedCommandSettings
  • func ParseGlazedCommandLayer(cmd *cobra.Command) (*GlazedCommandSettings, error)

Constants

const GlazedCommandSlug = "glazed-command"

Functions

func AddCommandsToRootCommand

func AddCommandsToRootCommand(
	rootCmd *cobra.Command,
	commands []cmds.Command,
	aliases []*alias.CommandAlias,
	options ...CobraParserOption,
) error

func AddGlazedProcessorFlagsToCobraCommand

func AddGlazedProcessorFlagsToCobraCommand(cmd *cobra.Command, options ...settings.GlazeParameterLayerOption) error

AddGlazedProcessorFlagsToCobraCommand is a helper for cobra centric apps that quickly want to add the glazed processing layer to their CLI flags.

func BuildCobraCommandAlias

func BuildCobraCommandAlias(
	alias *alias.CommandAlias,
	options ...CobraParserOption,
) (*cobra.Command, error)

func BuildCobraCommandFromBareCommand

func BuildCobraCommandFromBareCommand(c cmds.BareCommand, options ...CobraParserOption) (*cobra.Command, error)

func BuildCobraCommandFromCommand

func BuildCobraCommandFromCommand(
	command cmds.Command,
	options ...CobraParserOption,
) (*cobra.Command, error)

func BuildCobraCommandFromCommandAndFunc

func BuildCobraCommandFromCommandAndFunc(
	s cmds.Command,
	run CobraRunFunc,
	options ...CobraParserOption,
) (*cobra.Command, error)

func BuildCobraCommandFromGlazeCommand

func BuildCobraCommandFromGlazeCommand(cmd_ cmds.GlazeCommand, options ...CobraParserOption) (*cobra.Command, error)

func BuildCobraCommandFromWriterCommand

func BuildCobraCommandFromWriterCommand(s cmds.WriterCommand, options ...CobraParserOption) (*cobra.Command, error)

func CobraCommandDefaultMiddlewares

func CobraCommandDefaultMiddlewares(
	commandSettings *GlazedCommandSettings,
	cmd *cobra.Command,
	args []string,
) ([]cmd_middlewares.Middleware, error)

CobraCommandDefaultMiddlewares is the default implementation for creating the middlewares used in a Cobra command. It handles parsing parameters from Cobra flags, command line arguments, environment variables, and default values. The middlewares gather all these parameters into a ParsedParameters object.

If the commandSettings specify parameters to be loaded from a file, this gets added as a middleware.

func CreateGlazedProcessorFromCobra

func CreateGlazedProcessorFromCobra(cmd *cobra.Command) (*middlewares.TableProcessor, formatters.OutputFormatter, error)

CreateGlazedProcessorFromCobra is a helper for cobra centric apps that quickly want to add the glazed processing layer.

If you are more serious about using glazed, consider using the `cmds.GlazeCommand` and `parameters.ParameterDefinition` abstraction to define your CLI applications, which allows you to use Layers and other nice features of the glazed ecosystem.

If so, use SetupTableProcessor instead, and create a proper glazed.GlazeCommand for your command.

func GetVerbsFromCobraCommand

func GetVerbsFromCobraCommand(cmd *cobra.Command) []string

func NewCobraCommandFromCommandDescription

func NewCobraCommandFromCommandDescription(
	description *cmds.CommandDescription,
) *cobra.Command

func NewGlazedCommandLayer

func NewGlazedCommandLayer() (layers.ParameterLayer, error)

Types

type CobraMiddlewaresFunc

type CobraMiddlewaresFunc func(
	commandSettings *GlazedCommandSettings,
	cmd *cobra.Command,
	args []string,
) ([]cmd_middlewares.Middleware, error)

CobraMiddlewaresFunc is a function that returns a list of middlewares for a cobra command. It can be used to overload the default middlewares for cobra commands. It is mostly used to add a "load from json" layer set in the GlazedCommandSettings.

type CobraParser

type CobraParser struct {
	Layers *layers.ParameterLayers
	// contains filtered or unexported fields
}

CobraParser takes a CommandDescription, and hooks it up to a cobra command. It can then be used to parse the cobra flags and arguments back into a set of ParsedLayer and a map[string]interface{} for the lose stuff.

That command however doesn't have a Run* method, which is left to the caller to implement.

This returns a CobraParser that can be used to parse the registered Layers from the description.

func NewCobraParserFromLayers

func NewCobraParserFromLayers(
	layers *layers.ParameterLayers,
	options ...CobraParserOption,
) (*CobraParser, error)

NewCobraParserFromLayers creates a new CobraParser instance from a CommandDescription, initializes the underlying cobra.Command, and adds all the parameters specified in the Layers CommandDescription to the cobra command.

func (*CobraParser) AddToCobraCommand

func (c *CobraParser) AddToCobraCommand(cmd *cobra.Command) error

func (*CobraParser) Parse

func (c *CobraParser) Parse(
	cmd *cobra.Command,
	args []string,
) (*layers.ParsedLayers, error)

type CobraParserOption

type CobraParserOption func(*CobraParser) error

func WithCobraMiddlewaresFunc

func WithCobraMiddlewaresFunc(middlewaresFunc CobraMiddlewaresFunc) CobraParserOption

func WithCobraShortHelpLayers

func WithCobraShortHelpLayers(layers ...string) CobraParserOption

func WithSkipGlazedCommandLayer

func WithSkipGlazedCommandLayer() CobraParserOption

type CobraRunFunc

type CobraRunFunc func(ctx context.Context, parsedLayers *layers.ParsedLayers) error

type GlazedCommandSettings

type GlazedCommandSettings struct {
	CreateCommand          string `glazed.parameter:"create-command"`
	CreateAlias            string `glazed.parameter:"create-alias"`
	CreateCliopatra        string `glazed.parameter:"create-cliopatra"`
	PrintYAML              bool   `glazed.parameter:"print-yaml"`
	PrintParsedParameters  bool   `glazed.parameter:"print-parsed-parameters"`
	LoadParametersFromFile string `glazed.parameter:"load-parameters-from-file"`
	Profile                string `glazed.parameter:"profile"`
	ProfileFile            string `glazed.parameter:"profile-file"`
}

func ParseGlazedCommandLayer

func ParseGlazedCommandLayer(cmd *cobra.Command) (*GlazedCommandSettings, error)

ParseGlazedCommandLayer parses the global glazed settings from the given cobra.Command, if not nil, and from the configured viper config file.