cli

package

v0.2.4 Latest Latest Go to latest Published: Feb 3, 2023 License: Apache-2.0 Imports: 9 Imported by: 0

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

Repository

github.com/mkungla/happy

Documentation ¶

Overview ¶

Package cli provides utilities for happy command line interfaces.

Index ¶

Variables
func AskForConfirmation(q string) bool
func AskForInput(q string) string
func ExecCommand(sess *happy.Session, cmd *exec.Cmd) (string, error)
func ExecCommandRaw(sess *happy.Session, cmd *exec.Cmd) ([]byte, error)
func RunCommand(sess *happy.Session, cmd *exec.Cmd) error

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// ErrCommand        = happyx.NewError("command error")
	// ErrCommandAction  = happyx.NewError("command action error")
	ErrCommandInvalid = errors.New("invalid command definition")
	ErrCommandArgs    = errors.New("command arguments error")
	ErrCommandFlags   = errors.New("command flags error")
	ErrPanic          = errors.New("there was panic, check logs for more info")
)

Functions ¶

func AskForConfirmation ¶

func AskForConfirmation(q string) bool

AskForConfirmation gets (y/Y)es or (n/N)o from cli input.

func AskForInput ¶

func AskForInput(q string) string

func ExecCommand ¶

func ExecCommand(sess *happy.Session, cmd *exec.Cmd) (string, error)

ExecCommand wraps ExecCommandRaw to return output as string.

func ExecCommandRaw ¶

func ExecCommandRaw(sess *happy.Session, cmd *exec.Cmd) ([]byte, error)

ExecCommandRaw wraps and executes provided command and returns its CombinedOutput. It ensures that -x flag is taken into account and Command is Session Context aware.

func RunCommand ¶

func RunCommand(sess *happy.Session, cmd *exec.Cmd) error

RunCommand wraps and executes provided command and writes its Stdout and Stderr. It ensures that -x flag is taken into account and Command is Session Context aware.

Types ¶

This section is empty.

Source Files ¶

View all Source files

cli.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL