cliutil

Documentation

Overview

Package cliutil is common command line utils for Go.

Index

• Variables
• func DefaultLoggingFunc(_ []byte)
• func ExecContext(ctx context.Context, command string, args ...string) (output string, err error)
• func ExecErrPipe(ctx context.Context, fn LoggingFunc, command string, args ...string) error
• func ExecPipe(ctx context.Context, fn LoggingFunc, command string, args ...string) error
• func IsHelpCmd(short ...string) bool
• func IsVersionCmd(short ...string) bool
• func RetrieveFlag(args []string, long, short string) (value string, ok bool)
• func RetrieveFlagFromCLI(long string, short string) (value string, ok bool)
• func ShellExec(command string) (output string, err error)
• func ShellExecContext(ctx context.Context, command string) (output string, err error)
• func ShellExecPipe(ctx context.Context, fn LoggingFunc, command string) error
• type ErrExit
  • func (e *ErrExit) Code() int
  • func (e *ErrExit) Error() string
  • func (e *ErrExit) Stderr() string
  • func (e *ErrExit) Stdout() string
• type LoggingFunc

Variables

var ErrInvalidCmd = errors.New("invalid command")

ErrInvalidCmd represents a invalid command error.

Functions

func DefaultLoggingFunc

func DefaultLoggingFunc(_ []byte)

DefaultLoggingFunc do nothing

func ExecContext

func ExecContext(ctx context.Context, command string, args ...string) (output string, err error)

ExecContext executes the given command.

func ExecErrPipe

func ExecErrPipe(ctx context.Context, fn LoggingFunc, command string, args ...string) error

ExecErrPipe executes the given command with a pipe that will be connected to the command's stderr when the command starts.

func ExecPipe

func ExecPipe(ctx context.Context, fn LoggingFunc, command string, args ...string) error

ExecPipe executes the given command with a pipe that will be connected to the command's stdout when the command starts.

func IsHelpCmd

func IsHelpCmd(short ...string) bool

IsHelpCmd this function simply calls RetrieveFlagFromCLI("--help", "") Optionally, a single extra argument of type string can be provided to indicate the short name of the help flag.

func IsVersionCmd

func IsVersionCmd(short ...string) bool

IsVersionCmd this function simply calls RetrieveFlagFromCLI("--version", "") Optionally, a single extra argument of type string can be provided to indicate the short name of the version flag.

func RetrieveFlag

func RetrieveFlag(args []string, long, short string) (value string, ok bool)

RetrieveFlag returns value of the given flag from args.

func RetrieveFlagFromCLI

func RetrieveFlagFromCLI(long string, short string) (value string, ok bool)

RetrieveFlagFromCLI returns value of the given flag from os.Args.

func ShellExec

func ShellExec(command string) (output string, err error)

ShellExec executes the given command by shell, errors.g. "ls -al"

func ShellExecContext

func ShellExecContext(ctx context.Context, command string) (output string, err error)

ShellExecContext executes the given command by shell.

func ShellExecPipe

func ShellExecPipe(ctx context.Context, fn LoggingFunc, command string) error

ShellExecPipe executes the given command with a pipe that will be connected to the command's stdout and stderr when the command starts.

Types

type ErrExit

type ErrExit struct {
	// contains filtered or unexported fields
}

ErrExit error with stdout and stderr.

func (*ErrExit) Code

func (e *ErrExit) Code() int

Code returns exit code.

func (*ErrExit) Error

func (e *ErrExit) Error() string

Error implements error.

func (*ErrExit) Stderr

func (e *ErrExit) Stderr() string

Stderr returns stderr.

func (*ErrExit) Stdout

func (e *ErrExit) Stdout() string

Stdout returns stdout.

type LoggingFunc

type LoggingFunc func(line []byte)

LoggingFunc callback function for logging command output