README
¶
System Utils
Provide some system util functions. eg: sysenv, exec, user, process
- quick exec a command line string.
- quick build a command for run
Install
go get github.com/gookit/goutil/sysutil
Usage
out, err := sysutil.ExecCmd("ls", []string{"-al"})
Clipboard
Package clipboard provide a simple clipboard read and write operations.
Install
go get github.com/gookit/goutil/sysutil/clipboard
Usage
Examples:
src := "hello, this is clipboard"
err = clipboard.WriteString(src)
assert.NoErr(t, err)
// str: "hello, this is clipboard"
str, err = clipboard.ReadString()
assert.NoErr(t, err)
assert.NotEmpty(t, str)
assert.Eq(t, src, str)
Cmd run
Install
go get github.com/gookit/goutil/sysutil/cmdr
Usage
Cmd Builder:
c := cmdr.NewCmd("ls").
WithArg("-l").
WithArgs([]string{"-h"}).
AddArg("-a").
AddArgf("%s", "./")
c.OnBefore(func(c *cmdr.Cmd) {
assert.Eq(t, "ls -l -h -a ./", c.Cmdline())
})
out := c.SafeOutput()
fmt.Println(out)
Batch Cmd Tasks:
Can use cmdr.Runner run multi cmd tasks at once.
buf := new(bytes.Buffer)
rr := cmdr.NewRunner()
rr.Add(&cmdr.Task{
ID: "task1",
Cmd: cmdr.NewCmd("id", "-F").WithOutput(buf, buf),
})
rr.AddCmd(cmdr.NewCmd("ls").AddArgs([]string{"-l", "-h"}).WithOutput(buf, buf))
err = rr.Run()
Documentation
¶
Overview ¶
Package sysutil provide some system util functions. eg: sysenv, exec, user, process
Index ¶
- func BinDir() string
- func BinFile() string
- func ChangeUserByName(newUname string) (err error)
- func ChangeUserUidGid(newUid int, newGid int) (err error)
- func CurrentShell(onlyName bool) (path string)
- func CurrentUser() *user.User
- func EnvPaths() []string
- func ExecCmd(binName string, args []string, workDir ...string) (string, error)
- func ExecLine(cmdLine string, workDir ...string) (string, error)
- func Executable(binName string) (string, error)
- func ExpandPath(path string) string
- func FindExecutable(binName string) (string, error)
- func FlushExec(bin string, args ...string) error
- func GoVersion() string
- func HasExecutable(binName string) bool
- func HasShellEnv(shell string) bool
- func HomeDir() string
- func Hostname() string
- func IsConsole(out io.Writer) bool
- func IsDarwin() bool
- func IsLinux() bool
- func IsMSys() bool
- func IsMac() bool
- func IsShellSpecialVar(c uint8) bool
- func IsTerminal(fd uintptr) bool
- func IsWin() bool
- func IsWindows() bool
- func Kill(pid int, signal syscall.Signal) error
- func LoginUser() *user.User
- func MustFindUser(uname string) *user.User
- func NewCmd(bin string, args ...string) *cmdr.Cmd
- func OpenBrowser(URL string) error
- func ProcessExists(pid int) bool
- func QuickExec(cmdLine string, workDir ...string) (string, error)
- func SearchPath(keywords string) []string
- func ShellExec(cmdLine string, shells ...string) (string, error)
- func StdIsTerminal() bool
- func UHomeDir() string
- func UserCacheDir(subPath string) string
- func UserConfigDir(subPath string) string
- func UserDir(subPath string) string
- func UserHomeDir() string
- func Workdir() string
- type CallerInfo
- type GoInfo
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ChangeUserByName ¶ added in v0.4.2
ChangeUserByName change work user by new username.
func ChangeUserUidGid ¶ added in v0.4.2
ChangeUserUidGid change work user by new username uid,gid
func CurrentShell ¶ added in v0.1.4
CurrentShell get current used shell env file.
eg "/bin/zsh" "/bin/bash". if onlyName=true, will return "zsh", "bash"
func ExecCmd ¶ added in v0.1.4
ExecCmd a command and return output.
Usage:
ExecCmd("ls", []string{"-al"})
func ExpandPath ¶ added in v0.3.9
ExpandPath will parse `~` as user home dir path.
func FindExecutable ¶ added in v0.3.8
FindExecutable in the system
Usage:
sysutil.FindExecutable("bash")
func GoVersion ¶ added in v0.5.11
func GoVersion() string
GoVersion get go runtime version. eg: "1.18.2"
func HasShellEnv ¶ added in v0.1.4
HasShellEnv has shell env check.
Usage:
HasShellEnv("sh")
HasShellEnv("bash")
func Hostname ¶ added in v0.3.12
func Hostname() string
Hostname is alias of os.Hostname, but ignore error
func IsConsole ¶ added in v0.2.2
IsConsole check out is in stderr/stdout/stdin
Usage:
sysutil.IsConsole(os.Stdout)
func IsShellSpecialVar ¶ added in v0.3.12
IsShellSpecialVar reports whether the character identifies a special shell variable such as $*.
func MustFindUser ¶ added in v0.4.2
MustFindUser must find an system user by name
func OpenBrowser ¶ added in v0.5.6
OpenBrowser Open browser URL
Mac：
open 'https://github.com/inhere'
Linux:
xdg-open URL x-www-browser 'https://github.com/inhere'
Windows:
cmd /c start https://github.com/inhere
func SearchPath ¶ added in v0.5.11
SearchPath search executable files in the system $PATH
Usage:
sysutil.SearchPath("go")
func UserCacheDir ¶ added in v0.4.0
UserCacheDir will prepend user `$HOME/.cache` to subPath
func UserConfigDir ¶ added in v0.4.0
UserConfigDir will prepend user `$HOME/.config` to subPath
func UserHomeDir ¶ added in v0.3.12
func UserHomeDir() string
UserHomeDir is alias of os.UserHomeDir, but ignore error
Types ¶
type CallerInfo ¶ added in v0.5.6
CallerInfo struct
func CallersInfos ¶ added in v0.5.6
CallersInfos returns an array of the CallerInfo.
Usage:
cs := sysutil.CallersInfos(3, 2)
for _, ci := range cs {
fc := runtime.FuncForPC(pc)
// maybe need check fc = nil
fnName = fc.Name()
}
type GoInfo ¶ added in v0.5.11
GoInfo define
On os by:
go env GOVERSION GOOS GOARCH go version // "go version go1.19 darwin/amd64"
func ParseGoVersion ¶ added in v0.5.11
ParseGoVersion get info by parse `go version` results.
Examples:
line, err := sysutil.ExecLine("go version")
if err != nil {
return err
}
info, err := sysutil.ParseGoVersion()
dump.P(info)
Source Files
¶
Directories
¶
| Path | Synopsis |
|---|---|
|
Package clipboard provide a simple clipboard read and write operations.
|
Package clipboard provide a simple clipboard read and write operations. |
|
Package cmdr Provide for quick build and run a cmd, batch run multi cmd tasks
|
Package cmdr Provide for quick build and run a cmd, batch run multi cmd tasks |
|
Package process Provide some process handle util functions
|
Package process Provide some process handle util functions |