kmgCmd

Documentation

Index

• Variables
• func BashEscape(inS string) (outS string)
• func Exist(cmd string) bool
• func FindCurrentPlatformExecute(prefix string) (path string, err error)
• func GetExecCmdExitStatus(cmd *exec.Cmd) int
• func IsErrorExitStatus(err error) bool
• func MustCombinedOutput(cmd string) []byte
• func MustCombinedOutputAndNotExitStatusCheck(cmd string) []byte
• func MustCombinedOutputWithErrorPrintln(cmd string) []byte
• func MustRun(cmd string)
• func MustRunAndReturnOutput(cmd string) []byte
• func MustRunInBash(cmd string)
• func MustRunNotExistStatusCheck(cmd string)
• func ProxyRun(cmd string)
• func Run(cmd string) (err error)
• func SetCmdEnv(cmd *exec.Cmd, key string, value string) error
• func StdioSliceRun(args []string) (err error)
• type Cmd
  • func CmdBash(cmd string) *Cmd
  • func CmdSlice(args []string) *Cmd
  • func CmdString(cmd string) *Cmd
  • func (c *Cmd) CombinedOutput() (b []byte, err error)
  • func (c *Cmd) FprintCmdLine(w io.Writer)
  • func (c *Cmd) GetExecCmd() *exec.Cmd
  • func (c *Cmd) MustCombinedOutput() (b []byte)
  • func (c *Cmd) MustCombinedOutputAndNotExitStatusCheck() (b []byte)
  • func (c *Cmd) MustCombinedOutputWithErrorPrintln() (b []byte)
  • func (c *Cmd) MustHiddenRunAndGetExitStatus() int
  • func (c *Cmd) MustHiddenRunAndIsSuccess() bool
  • func (c *Cmd) MustRun()
  • func (c *Cmd) MustRunAndNotExitStatusCheck()
  • func (c *Cmd) MustRunAndReturnOutput() (b []byte)
  • func (c *Cmd) MustRunAndReturnOutputAndNotExitStatusCheck() (b []byte)
  • func (c *Cmd) MustRunWithStdin(stdin []byte)
  • func (c *Cmd) MustSetEnv(key string, value string) *Cmd
  • func (c *Cmd) MustStdioRun()
  • func (c *Cmd) PrintCmdLine()
  • func (c *Cmd) ProxyRun()
  • func (c *Cmd) Run() error
  • func (c *Cmd) RunAndNotExitStatusCheck() error
  • func (c *Cmd) RunAndReturnOutput() (b []byte, err error)
  • func (c *Cmd) RunAndTeeOutputToFile(path string) (err error)
  • func (c *Cmd) SetDir(path string) *Cmd
  • func (c *Cmd) StdioRun() error
• type Env
  • func NewEnvFromArray(env []string) (envObj *Env, err error)
  • func (env *Env) ToArray() []string

Variables

var ErrNotFound = errors.New("executable file not found.")

Functions

func BashEscape

func BashEscape(inS string) (outS string)

escape string to put it into bash

func Exist

func Exist(cmd string) bool

func FindCurrentPlatformExecute

func FindCurrentPlatformExecute(prefix string) (path string, err error)

func GetExecCmdExitStatus

func GetExecCmdExitStatus(cmd *exec.Cmd) int

func IsErrorExitStatus

func IsErrorExitStatus(err error) bool

func MustCombinedOutput

func MustCombinedOutput(cmd string) []byte

相比MustRun 返回输出结果，但是不会输出到 stdout

func MustCombinedOutputAndNotExitStatusCheck

func MustCombinedOutputAndNotExitStatusCheck(cmd string) []byte

func MustCombinedOutputWithErrorPrintln

func MustCombinedOutputWithErrorPrintln(cmd string) []byte

func MustRun

func MustRun(cmd string)

func MustRunAndReturnOutput

func MustRunAndReturnOutput(cmd string) []byte

相比MustRun 也返回输出结果

func MustRunInBash

func MustRunInBash(cmd string)

相比MustRun 输入的命令会被放到bash中执行,cmd的语法和bash一致.

func MustRunNotExistStatusCheck

func MustRunNotExistStatusCheck(cmd string)

相比MustRun 如果进程返回值不是0,不报错

func ProxyRun

func ProxyRun(cmd string)

代理运行命令,同run,出现错误时,会退出进程 请仅在命令行程序中使用

func Run

func Run(cmd string) (err error)

运行命令,并且把命令输入输出和当前的输入输出接起来 会回显输入的命令 会显示输出的结果 应该可以从命令行输入输入,但是没有使用过.

传入一个字符串是命令, 不允许参数中包含空格,如果命令有复杂参数请使用 RunOsStdioCmd 不支持bash语法, 不能在里面使用bash的各种连接符之类的. 只能写一条命令

不支持下列用法:

ls 'a b' //不允许参数中包含空格.
echo 1 > /dev/null //不支持bash语法,会输出 1 > /dev/null

func SetCmdEnv

func SetCmdEnv(cmd *exec.Cmd, key string, value string) error

func StdioSliceRun

func StdioSliceRun(args []string) (err error)

相比Run 不回显命令 并且使用slice作为输入方式

Types

type Cmd

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

please use Cmd* function to new a Cmd,do not create one yourself.

func CmdBash

func CmdBash(cmd string) *Cmd

func CmdSlice

func CmdSlice(args []string) *Cmd

you need at least one args: the path of the command, or it will panic

func CmdString

func CmdString(cmd string) *Cmd

func (*Cmd) CombinedOutput

func (c *Cmd) CombinedOutput() (b []byte, err error)

func (*Cmd) FprintCmdLine

func (c *Cmd) FprintCmdLine(w io.Writer)

func (*Cmd) GetExecCmd

func (c *Cmd) GetExecCmd() *exec.Cmd

get the os/exec.Cmd

func (*Cmd) MustCombinedOutput

func (c *Cmd) MustCombinedOutput() (b []byte)

允许命令,返回命令的内容,不回显任何东西

func (*Cmd) MustCombinedOutputAndNotExitStatusCheck

func (c *Cmd) MustCombinedOutputAndNotExitStatusCheck() (b []byte)

func (*Cmd) MustCombinedOutputWithErrorPrintln

func (c *Cmd) MustCombinedOutputWithErrorPrintln() (b []byte)

允许命令,返回命令的内容,不回显任何东西, 出现错误就回显输出结果,没有错误,什么也不显示.

func (*Cmd) MustHiddenRunAndGetExitStatus

func (c *Cmd) MustHiddenRunAndGetExitStatus() int

func (*Cmd) MustHiddenRunAndIsSuccess

func (c *Cmd) MustHiddenRunAndIsSuccess() bool

func (*Cmd) MustRun

func (c *Cmd) MustRun()

func (*Cmd) MustRunAndNotExitStatusCheck

func (c *Cmd) MustRunAndNotExitStatusCheck()

func (*Cmd) MustRunAndReturnOutput

func (c *Cmd) MustRunAndReturnOutput() (b []byte)

func (*Cmd) MustRunAndReturnOutputAndNotExitStatusCheck

func (c *Cmd) MustRunAndReturnOutputAndNotExitStatusCheck() (b []byte)

func (*Cmd) MustRunWithStdin

func (c *Cmd) MustRunWithStdin(stdin []byte)

func (*Cmd) MustSetEnv

func (c *Cmd) MustSetEnv(key string, value string) *Cmd

func (*Cmd) MustStdioRun

func (c *Cmd) MustStdioRun()

func (*Cmd) PrintCmdLine

func (c *Cmd) PrintCmdLine()

func (*Cmd) ProxyRun

func (c *Cmd) ProxyRun()

如果代理运行失败,当前进程会退出

func (*Cmd) Run

func (c *Cmd) Run() error

回显命令,并且运行,并且和标准输入输出接起来

func (*Cmd) RunAndNotExitStatusCheck

func (c *Cmd) RunAndNotExitStatusCheck() error

回显命令,并且运行,并且忽略输出结果

func (*Cmd) RunAndReturnOutput

func (c *Cmd) RunAndReturnOutput() (b []byte, err error)

回显命令,并且运行,返回运行的输出结果.并且把输出结果放在stdout中

func (*Cmd) RunAndTeeOutputToFile

func (c *Cmd) RunAndTeeOutputToFile(path string) (err error)

不能传递signel

func (*Cmd) SetDir

func (c *Cmd) SetDir(path string) *Cmd

func (*Cmd) StdioRun

func (c *Cmd) StdioRun() error

不回显命令,运行,并且返回运行的输出结果

type Env

type Env struct {
	Values map[string]string
}

func NewEnvFromArray

func NewEnvFromArray(env []string) (envObj *Env, err error)

func (*Env) ToArray

func (env *Env) ToArray() []string