cli

Documentation

Overview

Package cli provides commands to use Kocho.

Index

• Constants
• Variables
• func Execute()
• func NewKochoCmd()
• type Command
• type KochoConfiguration
  • func NewConfig() *KochoConfiguration

Constants

const (
	LabelToken                = "Slack token"
	LabelUsername             = "Your username"
	LabelNotificationUsername = "Bot username (optional)"
	LabelEmoji                = "Bot emoji (optional)"
	LabelNotificationChannel  = "Notification channel"
)

Constants related to Slack.

Variables

var (
	// ConfigHomePath defines where to load configuration files from.
	ConfigHomePath = os.Getenv("HOME") + "/.giantswarm/"
)

Functions

func Execute

func Execute()

Execute loads configuration, determines the necessary command to run, and runs it.

func NewKochoCmd

func NewKochoCmd()

NewKochoCmd configures available commands, and runs them.

Types

type Command

type Command struct {
	Name        string        // Name of the Command and the string to use to invoke it
	Summary     string        // One-sentence summary of what the Command does
	Usage       string        // Usage options/arguments
	Description string        // Detailed description of command
	Flags       pflag.FlagSet // Set of flags associated with this command

	Run func(args []string) int // Run a command with the given arguments, return exit status
}

Command describes a command that can be run.

type KochoConfiguration

type KochoConfiguration struct {
	*viper.Viper
}

KochoConfiguration holds Viper configuration.

func NewConfig

func NewConfig() *KochoConfiguration

NewConfig returns a new KochoConfiguration.