cliutil

Documentation

Overview

Package cliutil provides some util functions for CLI

Index

• func CurrentShell(onlyName bool) (path string)
• func ExecCmd(binName string, args []string, workDir ...string) (string, error)
• func ExecCommand(binName string, args []string, workDir ...string) (string, error)
• func ExecLine(cmdLine string, workDir ...string) (string, error)
• func HasShellEnv(shell string) bool
• func LineBuild(binFile string, args []string) string
• func ParseLine(line string) []string
• func QuickExec(cmdLine string, workDir ...string) (string, error)
• func ReadFirst(question string) (string, error)
• func ReadInput(question string) (string, error)
• func ReadLine(question string) (string, error)
• func ReadPassword(question ...string) string
• func ShellExec(cmdLine string, shells ...string) (string, error)
• func StringToOSArgs(line string) []string
• type LineBuilder
  • func NewLineBuilder(binFile string, args ...string) *LineBuilder
  • func (b *LineBuilder) AddArg(arg string)
  • func (b *LineBuilder) AddArgs(args ...string)
  • func (b *LineBuilder) AddArray(args []string)
  • func (b *LineBuilder) Len() int
  • func (b *LineBuilder) Reset()
  • func (b *LineBuilder) String() string
  • func (b *LineBuilder) WriteString(a string) (int, error)
• type LineParser
  • func NewLineParser(line string) *LineParser
  • func (p *LineParser) AlsoEnvParse() []string
  • func (p *LineParser) BinAndArgs() (bin string, args []string)
  • func (p *LineParser) NewExecCmd() *exec.Cmd
  • func (p *LineParser) Parse() []string

Functions

func CurrentShell

func CurrentShell(onlyName bool) (path string)

CurrentShell get current used shell env file. eg "/bin/zsh" "/bin/bash"

func ExecCmd

func ExecCmd(binName string, args []string, workDir ...string) (string, error)

ExecCmd a CLI bin file and return output. Usage:

ExecCmd("ls", []string{"-al"})

func ExecCommand

func ExecCommand(binName string, args []string, workDir ...string) (string, error)

ExecCommand alias of the ExecCmd()

func ExecLine

func ExecLine(cmdLine string, workDir ...string) (string, error)

ExecLine quick exec an command line string

func HasShellEnv

func HasShellEnv(shell string) bool

HasShellEnv has shell env check. Usage:

HasShellEnv("sh")
HasShellEnv("bash")

func LineBuild

func LineBuild(binFile string, args []string) string

LineBuild build command line string by given args.

func ParseLine

func ParseLine(line string) []string

ParseLine input command line text. alias of the StringToOSArgs()

func QuickExec

func QuickExec(cmdLine string, workDir ...string) (string, error)

QuickExec quick exec an simple command line

func ReadFirst

func ReadFirst(question string) (string, error)

ReadFirst read first char

func ReadInput

func ReadInput(question string) (string, error)

ReadInput read user input form Stdin

func ReadLine

func ReadLine(question string) (string, error)

ReadLine read one line from user input. Usage:

in := ReadLine("")
ans, _ := ReadLine("your name?")

func ReadPassword

func ReadPassword(question ...string) string

ReadPassword from console terminal

func ShellExec

func ShellExec(cmdLine string, shells ...string) (string, error)

ShellExec exec command by shell cmdStr eg. "ls -al"

func StringToOSArgs

func StringToOSArgs(line string) []string

StringToOSArgs parse input command line text to os.Args

Types

type LineBuilder

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

LineBuilder build command line string. codes refer from strings.Builder

func NewLineBuilder

func NewLineBuilder(binFile string, args ...string) *LineBuilder

NewLineBuilder create

func (*LineBuilder) AddArg

func (b *LineBuilder) AddArg(arg string)

AddArg to builder

func (*LineBuilder) AddArgs

func (b *LineBuilder) AddArgs(args ...string)

AddArgs to builder

func (*LineBuilder) AddArray

func (b *LineBuilder) AddArray(args []string)

AddArray to builder

func (*LineBuilder) Len

func (b *LineBuilder) Len() int

Len of the builder

func (*LineBuilder) Reset

func (b *LineBuilder) Reset()

Reset builder

func (*LineBuilder) String

func (b *LineBuilder) String() string

String to command line string

func (*LineBuilder) WriteString

func (b *LineBuilder) WriteString(a string) (int, error)

WriteString arg string to the builder, will auto quote special string. refer strconv.Quote()

type LineParser

type LineParser struct {

	// Line the full input command line text
	// eg `kite top sub -a "the a message" --foo val1 --bar "val 2"`
	Line string
	// ParseEnv parse ENV var on the line.
	ParseEnv bool
	// contains filtered or unexported fields
}

LineParser struct parse input command line to []string, such as cli os.Args

func NewLineParser

func NewLineParser(line string) *LineParser

NewLineParser create

func (*LineParser) AlsoEnvParse

func (p *LineParser) AlsoEnvParse() []string

AlsoEnvParse input command line text to os.Args, will parse ENV var

func (*LineParser) BinAndArgs

func (p *LineParser) BinAndArgs() (bin string, args []string)

BinAndArgs get binName and args

func (*LineParser) NewExecCmd

func (p *LineParser) NewExecCmd() *exec.Cmd

NewExecCmd quick create exec.Cmd by cmdline string

func (*LineParser) Parse

func (p *LineParser) Parse() []string

Parse input command line text to os.Args