cli_helpers

README

Linolabx Cli Helper

github.com/linolabx/cli_helpers/command_helper

import "github.com/linolabx/cli_helpers/command_helper"

Documentation

Index

• func FlagHelperTest(arguments []string, plugin CommandPlugin, callback func())
• type CommandHelper
  • func (this *CommandHelper) AddPlugin(plugin CommandPlugin)
  • func (this *CommandHelper) GetCommand() *cli.Command
• type CommandPlugin
• type FlagHelper
  • func (this *FlagHelper) GetEnvVar() string
  • func (this *FlagHelper) GetFlagName() string
  • func (this *FlagHelper) StringFlag() *cli.StringFlag
  • func (this *FlagHelper) StringValue(cCtx *cli.Context) string

Functions

func FlagHelperTest

func FlagHelperTest(arguments []string, plugin CommandPlugin, callback func())

Types

type CommandHelper

type CommandHelper struct {
	Command *cli.Command
	Plugins []CommandPlugin
	Action  func(cCtx *cli.Context) error
}

func (*CommandHelper) AddPlugin

func (this *CommandHelper) AddPlugin(plugin CommandPlugin)

func (*CommandHelper) GetCommand

func (this *CommandHelper) GetCommand() *cli.Command

type CommandPlugin

type CommandPlugin interface {
	HandleCommand(cmd *cli.Command) error
	HandleContext(cCtx *cli.Context) error
}

type FlagHelper

type FlagHelper struct {
	Prefix   string
	Name     string
	Category string
	Value    string
	Usage    string
	Required bool
	// contains filtered or unexported fields
}

func (*FlagHelper) GetEnvVar

func (this *FlagHelper) GetEnvVar() string

func (*FlagHelper) GetFlagName

func (this *FlagHelper) GetFlagName() string

func (*FlagHelper) StringFlag

func (this *FlagHelper) StringFlag() *cli.StringFlag

func (*FlagHelper) StringValue

func (this *FlagHelper) StringValue(cCtx *cli.Context) string