command

Documentation

Overview

Package command implements the root command for the command line tool.

Index

• func IsInvalidConfig(err error) bool
• type Command
  • func New(config Config) (*Command, error)
  • func (c *Command) CobraCommand() *cobra.Command
  • func (c *Command) Execute(cmd *cobra.Command, args []string)
  • func (c *Command) UpdateCommand() *update.Command
  • func (c *Command) VersionCommand() *version.Command
• type Config
  • func DefaultConfig() Config

Functions

func IsInvalidConfig

func IsInvalidConfig(err error) bool

IsInvalidConfig asserts invalidConfigError.

Types

type Command

type Command struct {
	// contains filtered or unexported fields
}

func New

func New(config Config) (*Command, error)

New creates a new root command.

func (*Command) CobraCommand

func (c *Command) CobraCommand() *cobra.Command

func (*Command) Execute

func (c *Command) Execute(cmd *cobra.Command, args []string)

func (*Command) UpdateCommand

func (c *Command) UpdateCommand() *update.Command

func (*Command) VersionCommand

func (c *Command) VersionCommand() *version.Command

type Config

type Config struct {
	// Dependencies.
	Logger micrologger.Logger

	// Settings.
	Description string
	GitCommit   string
	Name        string
	Source      string
}

Config represents the configuration used to create a new root command.

func DefaultConfig

func DefaultConfig() Config

DefaultConfig provides a default configuration to create a new root command by best effort.