cliutil

Documentation

Overview

Package cliutil provides some util functions for CLI

Index

• func BinDir() string
• func BinFile() string
• func BuildLine(binFile string, args []string) string
• 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 ReadFirstByte(question string) (byte, error)
• func ReadFirstRune(question string) (rune, 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 String2OSArgs(line string) []string
• func StringToOSArgs(line string) []string
• func Workdir() string

Functions

func BinDir

func BinDir() string

BinDir get

func BinFile

func BinFile() string

BinFile get

func BuildLine

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

BuildLine build command line string by given args.

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 ReadFirstByte

func ReadFirstByte(question string) (byte, error)

ReadFirstByte read first byte char

Usage:

ans, _ := cliutil.ReadFirstByte("continue?[y/n] ")

func ReadFirstRune

func ReadFirstRune(question string) (rune, error)

ReadFirstRune read first rune 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 := cliutil.ReadLine("")
ans, _ := cliutil.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

Usage: ret, err := cliutil.ShellExec("ls -al")

func String2OSArgs

func String2OSArgs(line string) []string

String2OSArgs parse input command line text to os.Args

func StringToOSArgs

func StringToOSArgs(line string) []string

StringToOSArgs parse input command line text to os.Args

func Workdir

func Workdir() string

Workdir get