cmdbase

README

cmdbase

Base initialization and helpers for our CLI applications.

Install

go get github.com/altipla-consulting/cmdbase

Contributing

You can make pull requests or create issues in GitHub. Any code you send should be formatted using make gofmt.

License

MIT License

Documentation

Overview

Package cmdbase provides base initialization and helpers for our CLI applications.

Index

• func CmdRoot(name, short string, opts ...RootOption) *cobra.Command
• func Main()
• func Neutralf(format string, args ...interface{})
• func Successf(format string, args ...interface{})
• type RootOption
  • func WithFileLogger(config func() (*lumberjack.Logger, error)) RootOption
  • func WithInstall() RootOption
  • func WithUpdate(pkgname string) RootOption

Functions

func CmdRoot

func CmdRoot(name, short string, opts ...RootOption) *cobra.Command

CmdRoot creates a new root command. Can only be called once per application.

func Main

func Main()

func Neutralf

func Neutralf(format string, args ...interface{})

func Successf

func Successf(format string, args ...interface{})

Types

type RootOption

type RootOption func(settings *root.Settings) error

RootOption configures the root command.

func WithFileLogger

func WithFileLogger(config func() (*lumberjack.Logger, error)) RootOption

WithFileLogger configures logrus to emit logs to a file with rotation.

func WithInstall

func WithInstall() RootOption

WithInstall configures an install command that installs the autocomplete script in the user's bashrc.

func WithUpdate

func WithUpdate(pkgname string) RootOption

WithUpdate configures an update command that installs using Go the remote repository.