chroblert/jishell

jishell - A powerful modern CLI and SHELL,with a msfconsole-like style

jishell - A powerful modern CLI and SHELL,with a msfconsole-like style

本框架基于desertbit/grumble进行开发，在其基础上做了如下改变：

• list类型的arg和flag，基于,进行分割
• 子命令中可使用多个list类型的arg
• 使用具有msfconsole风格的shell
• 增加setf,seta,unsetf,unseta,help,run,show，use等核心命令，命令说明如下：
  • setf:用来设置flag
  • seta:用来设置arg
  • unsetf:取消设置的flag
  • unseta:取消设置的arg
  • help:查看特定命令的说明
  • show:显示当前命令的arg和flag值
  • run:执行当前命令
  • use:切换命令
• 修改词法分析器shlex，使之能够完成基于特定字符的分割
• 为seta,setf,unseta,unsetf增加自动补全
• 支持三种模式
  • 控制台模式：./samples cdnChkD --boolf test.com false
  • 普通交互模式：
    • ./samples进入交互模式
    • cdnChkD --boolf test.com false
  • msfconsole风格模式：
    • ./samples进入交互模式
    • 使用use切换到目标子命令
    • 使用seta,setf设置flag和arg
    • 使用run执行命令
• ...

使用

可借用jishell-cli工具来进行辅助创建

go get -u github.com/chroblert/jishell-cli
jishell-cli init --package Test
cd Test
jishell-cli add subcommand

or

go get -u github.com/chroblert/jishell-cli
jishell-cli init Test
jishell-cli add subcommand

若遇到报错，可更新到最新版，提issue

Introduction

目录层级

|main.go 					// 启动函数
|cmd     
|-app.go  					// APP
|-CDNCheck
|---------cdn_chk_ip.go		// subCommand
|---------cdn_chk_domain.go // subCommand

app.go创建一个jishell APP

var App = jishell.New(&jishell.Config{
	Name:                  "CheckTest",
	Description:           "",
	Flags: func(f *jishell.Flags) {
		f.BoolL("verbose",false,"")
	},
})

app.go加载存储子命令

func init() {
	App.SetPrintASCIILogo(func(a *jishell.App) {
		jlog.Warn("=============================")
		jlog.Warn("         CDN Check          ")
		jlog.Warn("=============================")
	})
	App.OnInit(func(a *jishell.App, flags jishell.FlagMap) error {
		if flags.Bool("verbose") {
			jlog.Info("verbose")
		}
		// load commands
		if viper.Get("jCommands") != nil {
			for _, v := range viper.Get("jCommands").([]*jishell.Command) {
				a.AddCommand(v)
			}
		}
		return nil
	})
}

cdn_chk_domain.go创建一个APP下的子命令

var cdnChkDomainCmd = &jishell.Command{
	Name:      "cdnChkD",
	Help:      "检测目标域名是否使用了CDN",
	LongHelp:  "",
	HelpGroup: "CDN Check",
	Usage:     "",
	Flags: func(f *jishell.Flags) {
		f.Bool("b","boolf",true,"")
	},
	Args: func(a *jishell.Args) {
		a.String("host", "hostname.eg: www.test.com")
		a.Bool("verbose","")
        a.StringList("t", "")
	},
	Run: func(c *jishell.Context) error {
		jlog.Info("boolf:",c.Flags.Bool("boolf"))
		jlog.Info("host:",c.Args.String("host"))
		jlog.Info("verbose:",c.Args.Bool("verbose"))
        jlog.Info("t:",c.Args.StringList("t"))
		return nil
	},
}

List类型的值以,进行分隔。
控制台中输入List类型的值，建议以'进行包裹。
- 若想输入',"，则需要使用\进行转义。如：'1,\",2 经过处理后，List包含1,"和2两个元素
shell中没有限制.

cdn_chk_domain.go存储子命令

func init() {
	var tmpCommands []*jishell.Command
	if viper.Get("jCommands") == nil {
		tmpCommands = make([]*jishell.Command, 0)
	} else {
		tmpCommands = viper.Get("jCommands").([]*jishell.Command)
	}
	tmpCommands = append(tmpCommands, cdnChkDomainCmd)
	viper.Set("jCommands", tmpCommands)
}

main.go运行

err := App.Run()

Or

使用内置函数*jishell.Main* 自动处理异常。

func main() {
	jishell.Main(App)
}

示例

https://github.com/chroblert/jishell/tree/master/samples

Credits

This project is based on ideas from the great grumble library.

License

MIT