cliutil

README

Cli Util

• Helper util functions in cli
• color print in console terminal
• read terminal message input
• command line args string parse
• build command line string

Helper functions

cliutil.Workdir() // current workdir
cliutil.BinDir() // the program exe file dir
cliutil.QuickExec("echo $SHELL")

Color print

Quick color print in console:

cliutil.Redln("ln:red color message print in cli.")
cliutil.Blueln("ln:blue color message print in cli.")
cliutil.Cyanln("ln:cyan color message print in cli.")

Read input

name := cliutil.ReadInput("Your name: ")
name := cliutil.ReadLine("Your name: ")

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

pwd := cliutil.ReadPassword("Input password:")

Parse command line as args

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

package main

import (
	"github.com/gookit/goutil/cliutil"
	"github.com/gookit/goutil/dump"
)

func main() {
	args := cliutil.ParseLine(`./app top sub --msg "has multi words"`)
	dump.P(args)
}

output:

PRINT AT github.com/gookit/goutil/cliutil_test.TestParseLine(line_parser_test.go:30)
[]string [ #len=5
  string("./app"), #len=5
  string("top"), #len=3
  string("sub"), #len=3
  string("--msg"), #len=5
  string("has multi words"), #len=15
]

Build command line from args

	s := cliutil.BuildLine("./myapp", []string{
		"-a", "val0",
		"-m", "this is message",
		"arg0",
	})
	fmt.Println("Build line:", s)

output:

Build line: ./myapp -a val0 -m "this is message" arg0

Documentation

Overview

Package cliutil provides some util functions for CLI

Index

• func BinDir() string
• func BinFile() string
• func Bluef(format string, a ...interface{})
• func Blueln(a ...interface{})
• func Bluep(a ...interface{})
• func BuildLine(binFile string, args []string) string
• func CurrentShell(onlyName bool) (path string)
• func Cyanf(format string, a ...interface{})
• func Cyanln(a ...interface{})
• func Cyanp(a ...interface{})
• func Errorf(format string, a ...interface{})
• func Errorln(a ...interface{})
• func Errorp(a ...interface{})
• 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 Grayf(format string, a ...interface{})
• func Grayln(a ...interface{})
• func Grayp(a ...interface{})
• func Greenf(format string, a ...interface{})
• func Greenln(a ...interface{})
• func Greenp(a ...interface{})
• func HasShellEnv(shell string) bool
• func Infof(format string, a ...interface{})
• func Infoln(a ...interface{})
• func Infop(a ...interface{})
• func LineBuild(binFile string, args []string) string
• func Magentaf(format string, a ...interface{})
• func Magentaln(a ...interface{})
• func Magentap(a ...interface{})
• 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 Redf(format string, a ...interface{})
• func Redln(a ...interface{})
• func Redp(a ...interface{})
• func ShellExec(cmdLine string, shells ...string) (string, error)
• func String2OSArgs(line string) []string
• func StringToOSArgs(line string) []string
• func Warnf(format string, a ...interface{})
• func Warnln(a ...interface{})
• func Warnp(a ...interface{})
• func Workdir() string
• func Yellowf(format string, a ...interface{})
• func Yellowln(a ...interface{})
• func Yellowp(a ...interface{})

Functions

func BinDir

func BinDir() string

BinDir get

func BinFile

func BinFile() string

BinFile get

func Bluef

func Bluef(format string, a ...interface{})

Bluef print message with Blue color

func Blueln

func Blueln(a ...interface{})

Blueln print message line with Blue color

func Bluep

func Bluep(a ...interface{})

Bluep print message with Blue color

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 Cyanf

func Cyanf(format string, a ...interface{})

Cyanf print message with Cyan color

func Cyanln

func Cyanln(a ...interface{})

Cyanln print message line with Cyan color

func Cyanp

func Cyanp(a ...interface{})

Cyanp print message with Cyan color

func Errorf

func Errorf(format string, a ...interface{})

Errorf print message with error style

func Errorln

func Errorln(a ...interface{})

Errorln print message with error style

func Errorp

func Errorp(a ...interface{})

Errorp print message with error color

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 Grayf

func Grayf(format string, a ...interface{})

Grayf print message with gray color

func Grayln

func Grayln(a ...interface{})

Grayln print message line with gray color

func Grayp

func Grayp(a ...interface{})

Grayp print message with gray color

func Greenf

func Greenf(format string, a ...interface{})

Greenf print message with green color

func Greenln

func Greenln(a ...interface{})

Greenln print message line with green color

func Greenp

func Greenp(a ...interface{})

Greenp print message with green color

func HasShellEnv

func HasShellEnv(shell string) bool

HasShellEnv has shell env check.

Usage:

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

func Infof

func Infof(format string, a ...interface{})

Infof print message with info style

func Infoln

func Infoln(a ...interface{})

Infoln print message with info style

func Infop

func Infop(a ...interface{})

Infop print message with info color

func LineBuild

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

LineBuild build command line string by given args.

func Magentaf

func Magentaf(format string, a ...interface{})

Magentaf print message with magenta color

func Magentaln

func Magentaln(a ...interface{})

Magentaln print message line with magenta color

func Magentap

func Magentap(a ...interface{})

Magentap print message with magenta color

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 a 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 Redf

func Redf(format string, a ...interface{})

Redf print message with Red color

func Redln

func Redln(a ...interface{})

Redln print message line with Red color

func Redp

func Redp(a ...interface{})

Redp print message with Red color

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 Warnf

func Warnf(format string, a ...interface{})

Warnf print message with warn style

func Warnln

func Warnln(a ...interface{})

Warnln print message with warn style

func Warnp

func Warnp(a ...interface{})

Warnp print message with warn color

func Workdir

func Workdir() string

Workdir get

func Yellowf

func Yellowf(format string, a ...interface{})

Yellowf print message with yellow color

func Yellowln

func Yellowln(a ...interface{})

Yellowln print message line with yellow color

func Yellowp

func Yellowp(a ...interface{})

Yellowp print message with yellow color