https://github.com/alexsjones/cli
golang interactive cli with sub commands
https://github.com/alexsjones/cli
cli commandline go golang prompt
Last synced: 10 months ago
JSON representation
golang interactive cli with sub commands
- Host: GitHub
- URL: https://github.com/alexsjones/cli
- Owner: AlexsJones
- Created: 2017-06-26T15:07:55.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2023-11-06T08:11:27.000Z (over 2 years ago)
- Last Synced: 2024-12-16T00:51:48.532Z (over 1 year ago)
- Topics: cli, commandline, go, golang, prompt
- Language: Go
- Size: 710 KB
- Stars: 34
- Watchers: 2
- Forks: 9
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# cli
[](https://travis-ci.org/AlexsJones/cli)
[](https://godoc.org/github.com/AlexsJones/cli/cli)
[](https://codeclimate.com/github/AlexsJones/cli/maintainability)
This is a simple interactive prompt for go that actually supports sub-commands, because I couldn't find one that did...
Supports unlimited subcommand nesting.
It is ultra light weight and whilst is no where near as good as Cobra, it might be useful to someone.
It looks a bit like this (Once you wire up your commands: see example):
```
>>>github login auth alex
Hit auth
Authenticated with alex
>>>github logout
Logged out
>>>help
npm sub commands:
[npm] file: relink an npm package locally
[npm] remove: remove a dep from package.json
[npm] usage: find usage of a package within submodules
github sub commands:
[github] pr: pr command palette
[pr] attach: attach the current issue to a pr
[github] issue: Issue command palette
[issue] set: set the current working issue
[issue] unset: unset the current working issue
[issue] show: show the current working issue
[github] login: use an access token to login to github
submodule sub commands:
[submodule] exec: execute in all submodules
```
# Installation
```
go get github.com/AlexsJones/cli/cli
```
# Simple example
```go
package main
import (
"fmt"
"github.com/AlexsJones/cli/cli"
"github.com/AlexsJones/cli/command"
)
func main() {
c := cli.NewCli()
c.AddCommand(command.Command{
Name: "github",
Help: "github primary command interface",
Func: func(args []string) {
fmt.Println("I do nothing...")
},
})
c.Run()
}
```
This gives you something like:
```
>>>github
I do nothing...
```
# Recursive subcommand example
```go
package main
import (
"fmt"
"github.com/AlexsJones/cli/cli"
"github.com/AlexsJones/cli/command"
)
func main() {
c := cli.NewCli()
c.AddCommand(command.Command{
Name: "github",
Help: "github primary command interface",
Func: func(args []string) {
fmt.Println("I do nothing...")
},
SubCommands: []command.Command{
command.Command{
Name: "login",
Help: "access token to github",
Func: func(args []string) {
if len(args) == 0 {
fmt.Println("Failed login")
return
}
fmt.Printf("Logged in %s", args[0])
},
SubCommands: []command.Command{
command.Command{
Name: "auth",
Help: "login sub command",
Func: func(args []string) {
fmt.Println("Hit auth")
if len(args) == 0 {
fmt.Println("Failed login")
return
}
fmt.Printf("Authenticated with %s\n", args[0])
},
SubCommands: []command.Command{
command.Command{
Name: "sub",
Help: "login sub-sub command",
Func: func(args []string) {
if len(args) == 0 {
fmt.Println("Failed login")
return
}
fmt.Printf("Logged in with username %s\n", args[0])
},
},
},
},
},
},
command.Command{
Name: "logout",
Help: "allows you to logout from github",
Func: func(args []string) {
fmt.Println("Logged out")
if len(args) == 0 {
fmt.Println("Failed logout")
return
}
fmt.Printf("Logged out with username %s\n", args[0])
},
},
},
})
c.AddCommand(command.Command{
Name: "sql",
Help: "sql primary command interface",
Func: func(args []string) {
fmt.Println("I do nothing...")
}})
c.Run()
```
# System commands
`help` & `exit`
Gives you information such as:
```
>>>help
npm sub commands:
[npm] file: relink an npm package locally
[npm] remove: remove a dep from package.json
[npm] usage: find usage of a package within submodules
github sub commands:
[github] pr: pr command palette
[pr] attach: attach the current issue to a pr
[github] issue: Issue command palette
[issue] set: set the current working issue
[issue] unset: unset the current working issue
[issue] show: show the current working issue
[github] login: use an access token to login to github
submodule sub commands:
[submodule] exec: execute in all submodules
```