gcs

README

gcs

介绍

使用Golang编写的系统命令执行模块,实现类似Python3的os.System、subprocess.getstatusoutput及subprocess.getoutput

安装教程

执行下面的命令

go get -u gitee.com/liumou_site/gcs

效果如下

PS D:\data\git\Go\glbm> go  get -u gitee.com/liumou_site/gcs   
go: downloading gitee.com/liumou_site/gcs v1.1.0
go: downloading golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1
go: added gitee.com/liumou_site/gcs v1.1.0
PS D:\data\git\Go\glbm> 

使用说明

package demo

import (
	"fmt"
	"gitee.com/liumou_site/gcs"
	"gitee.com/liumou_site/logger"
)

func GcsShell(cmd string) {
	shell := gcs.NewShell()
	shell.RunSudo(cmd)
	if shell.Err != nil {
		logger.Error("执行失败")
	} else {
		logger.Info("执行成功")
		fmt.Println(shell.Strings)
	}
}

func GcsSudo(cmd, password string)  {
	s := gcs.NewSudo(password)
	s.Realtime = true // 开启实时打印
	s.RunSudo(cmd)
	s.Line(1).Column(5, " ")
	fmt.Println(s.Strings)
}

常用参数说明

参数名称	值	作用
Realtime	bool	实时打印命令执行反馈信息
Strings	String	存储命令执行反馈文本信息

更多参数请查阅api.go文件

问题反馈

点击链接加入QQ群聊【坐公交也用券】

Documentation

Index

• func CheckCmd(cmd string) bool
• func GetUserInfo(display bool) (ok bool, username string, userid int, UserHome string)
• func Version() string
• type ApiHandle
• type ApiShell
  • func NewShell() *ApiShell
  • func (api *ApiShell) AwkCol(col string)
  • func (api *ApiShell) Column(col int, sep string) *ApiShell
  • func (api *ApiShell) Echo()
  • func (api *ApiShell) Grep(match string) *ApiShell
  • func (api *ApiShell) Line(n int) *ApiShell
  • func (api *ApiShell) ProcessIsRunning(command string) bool
  • func (api *ApiShell) RunScript(command ...string)
  • func (api *ApiShell) RunShell(command ...string)
  • func (api *ApiShell) RunShellList(cs []string)
  • func (api *ApiShell) RunTerminal(command ...string)
  • func (api *ApiShell) RunTimeout(n time.Duration, command ...string) *ApiShell
• type ApiSudo
  • func NewSudo(password string) *ApiSudo
  • func (api *ApiSudo) Grep(match string) *ApiSudo
  • func (api *ApiSudo) RunScriptSudo(command ...string)
  • func (api *ApiSudo) RunSudo(command ...string)
  • func (api *ApiSudo) RunSudoList(cs []string)

Functions

func CheckCmd

func CheckCmd(cmd string) bool

CheckCmd 检查命令是否存在

func GetUserInfo

func GetUserInfo(display bool) (ok bool, username string, userid int, UserHome string)

GetUserInfo 获取用户名,用户uid,用户家目录

func Version

func Version() string

Types

type ApiHandle

type ApiHandle struct {
	Strings string   // 处理结果
	Err     error    // 错误
	Slice   []string // 切片

}

type ApiShell

type ApiShell struct {
	PrintErr  bool // 打印详细错误信息(默认: true)
	PrintInfo bool // 是否打印详细信息(默认: false)
	Debug     bool // 是否打印调试信息(默认: false)

	Realtime bool   // 是否开启实时打印信息
	Result   bool   // 是否执行成功
	Text     string // 需要执行的命令
	OsType   string // 系统类型

	Strings  string // 输出结果
	ExitCode int    // 命令执行退出代码
	Err      error  // 错误

	Slice      []string // 数据切片
	Script     string   // 脚本文件
	ScriptMode bool     // 脚本文件

	Terminal     string // 使用的终端命令
	TerminalArg  string // 使用的终端参数
	TerminalBool bool   // 是否可以使用终端
	BlackHole    bool   // 是否使用黑洞模式(忽略错误信息)
	Ignore       bool   // 是否忽略标准输出
	// contains filtered or unexported fields
}

ApiShell 定义命令的结构体

func NewShell

func NewShell() *ApiShell

NewShell 命令实例构造函数 Realtime 是否开启实时打印数据

func (*ApiShell) AwkCol

func (api *ApiShell) AwkCol(col string)

AwkCol 打印命令执行反馈信息

func (*ApiShell) Column

func (api *ApiShell) Column(col int, sep string) *ApiShell

Column 截取指定列

func (*ApiShell) Echo

func (api *ApiShell) Echo()

Echo 打印命令执行反馈信息

func (*ApiShell) Grep

func (api *ApiShell) Grep(match string) *ApiShell

Grep 通过关键词筛选所有匹配行

func (*ApiShell) Line

func (api *ApiShell) Line(n int) *ApiShell

Line 截取指定行

func (*ApiShell) ProcessIsRunning

func (api *ApiShell) ProcessIsRunning(command string) bool

ProcessIsRunning 通过进程命令检测进程是否存在,例如传入： dpkg

func (*ApiShell) RunScript

func (api *ApiShell) RunScript(command ...string)

RunScript 通过生成脚本的方式执行Shell，支持Shell管道

func (*ApiShell) RunShell

func (api *ApiShell) RunShell(command ...string)

RunShell 执行命令

func (*ApiShell) RunShellList

func (api *ApiShell) RunShellList(cs []string)

RunShellList 批量执行命令

func (*ApiShell) RunTerminal

func (api *ApiShell) RunTerminal(command ...string)

RunTerminal 通过调用图形化终端程序的方式执行Shell命令，使用脚本封装的方式,支持Shell管道

func (*ApiShell) RunTimeout

func (api *ApiShell) RunTimeout(n time.Duration, command ...string) *ApiShell

RunTimeout 执行系统命令并设置超时时间

type ApiSudo

type ApiSudo struct {
	//PrintErr    bool          // 打印详细错误信息(默认: true)
	//PrintInfo     bool          // 是否打印详细信息(默认: false)
	//Debug      bool          // 是否打印调试信息(默认: false)
	//home       string        // 当前用户家目录(自动判断)
	//user       string        // 当前用户名(自动判断)
	//uid        int           // 当前用户uid(自动判断)
	//Realtime   bool          // 是否开启实时打印信息
	//Result     bool          // 是否执行成功
	//Text       string        // 需要执行的命令
	//OsType     string        // 系统类型
	//Err        error         // 错误
	//gfs        gf.ReadScreen // 文本处理实例
	//args       []string // 执行参数
	//Strings    string   // 输出结果
	//ExitCode   int      // 命令执行退出代码
	//Slice      []string // 数据切片
	//Script     string   // 脚本文件
	//ScriptMode bool     // 脚本文件
	//Shell    ApiShell // 实例化Shell
	SudoPath string // sudo命令绝对路径
	Password string // sudo权限使用的密码

	ApiShell // 继承Shell实例
	// contains filtered or unexported fields
}

ApiSudo 定义命令的结构体

func NewSudo

func NewSudo(password string) *ApiSudo

NewSudo 命令实例构造函数, 当不需要执行sudo命令的时候直接传入任意字符串给password即可 Realtime 是否开启实时打印数据

func (*ApiSudo) Grep

func (api *ApiSudo) Grep(match string) *ApiSudo

func (*ApiSudo) RunScriptSudo

func (api *ApiSudo) RunScriptSudo(command ...string)

RunScriptSudo 通过生成脚本的方式执行Shell，支持Shell管道

func (*ApiSudo) RunSudo

func (api *ApiSudo) RunSudo(command ...string)

RunSudo 执行命令

func (*ApiSudo) RunSudoList

func (api *ApiSudo) RunSudoList(cs []string)

RunSudoList 批量执行命令