clicommand

Documentation

Overview

Package clicommand declares the command line interface for Cider.

Index

• Variables
• func Execute(version string, exit func(int), args []string)
• type Root
  • func NewRoot(version string, exit func(int)) *Root
  • func (cmd *Root) Execute(args []string)

Variables

var ErrConfigNotFound = errors.New("config file not found at any default path")

ErrConfigNotFound happens if a config file could not be found at any of the default locations.

var ErrSkipGitWithoutSetVersionFlag = errors.New("if --skip-git is set, --set-version must also be set")

ErrSkipGitWithoutSetVersionFlag indicates an error when the --skip-git flag is set without also setting the --set-version flag.

var ErrUnsupportedShell = errors.New("shell for completions is unsupported")

ErrUnsupportedShell happens when a shell that Cobra does not support is passed for the completions command.

Functions

func Execute

func Execute(version string, exit func(int), args []string)

Execute is the primary function to initiate the command line interface for Cider.

Types

type Root

type Root struct {
	Cmd *cobra.Command
	// contains filtered or unexported fields
}

Root defines a rough structure for a root command type.

func NewRoot

func NewRoot(version string, exit func(int)) *Root

NewRoot creates a new instance of the root command for the cider executable.

func (*Root) Execute

func (cmd *Root) Execute(args []string)

Execute executes the root command.