cmdbase

package module

v0.2.3 Latest Latest Go to latest Published: May 6, 2023 License: MIT Imports: 11 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Base initialization and helpers for our CLI applications.

go get github.com/altipla-consulting/cmdbase

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

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

This section is empty.

This section is empty.

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 Neutralf(format string, args ...interface{})

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

type RootOption func(name string)

RootOption configures the root command.

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

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

func WithInstall() RootOption

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

func WithUpdate(pkgname string) RootOption

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