Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/windomz/go-commander
:lollipop: The solution for building command shell programs, drive by <docopt>, inspired by <commander.js>
https://github.com/windomz/go-commander
cli command-line commander commandline-interface docopt go golang shell
Last synced: 22 days ago
JSON representation
:lollipop: The solution for building command shell programs, drive by <docopt>, inspired by <commander.js>
- Host: GitHub
- URL: https://github.com/windomz/go-commander
- Owner: WindomZ
- License: mit
- Created: 2017-02-28T03:05:41.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-07-04T10:08:12.000Z (over 7 years ago)
- Last Synced: 2024-10-11T20:24:09.836Z (about 1 month ago)
- Topics: cli, command-line, commander, commandline-interface, docopt, go, golang, shell
- Language: Go
- Homepage:
- Size: 146 KB
- Stars: 7
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# go-commander
[](https://travis-ci.org/WindomZ/go-commander)
[](https://opensource.org/licenses/MIT)
[](https://goreportcard.com/report/github.com/WindomZ/go-commander)
[](https://coveralls.io/github/WindomZ/go-commander?branch=master)
> The solution for building command shell programs,
drive by <[docopt](https://github.com/docopt/docopt.go)>,
inspired by <[commander.js](https://github.com/tj/commander.js)>
## Features
- [x] Has all the features of [docopt](https://github.com/docopt/docopt.go).
- [x] Usage like [commander.js](https://github.com/tj/commander.js) as simple and readable.
- [x] Automatic generated a help message, easy to use, or advanced usage see [documents](http://docopt.org/) of docopt.
- [x] Automatically execute the correct action function, don't worry about conflict.
- [x] Can customize the action function, better with context.
- [x] Code colloquial use, from top to bottom.
## Installation
To get the package, execute:
```bash
go get gopkg.in/WindomZ/go-commander.v1
```
To import this package, add the following line to your code:
```go
import "gopkg.in/WindomZ/go-commander.v1"
```
## Examples
### [Quick example](https://github.com/WindomZ/go-commander/blob/master/examples/quick_example/quick_example.go)
Such as the following help message
```markdown
Usage:
quick_example tcp [--timeout=]
quick_example serial [--baud=9600] [--timeout=]
quick_example -h|--help
quick_example -v|--version
Options:
-h --help output usage information
-v --version output the version number
```
To coding with `go-commander` just like this:
```go
import "github.com/WindomZ/go-commander"
...
// quick_example
commander.Program.
Command("quick_example").
Version("0.1.1rc")
// quick_example tcp [--timeout=]
commander.Program.
Command("tcp ").
Option("--timeout=").
Action(func() {
fmt.Printf("tcp %s %s %s\n",
commander.Program.MustString(""),
commander.Program.MustString(""),
commander.Program.MustString("--timeout"),
)
})
// quick_example serial [--baud=9600] [--timeout=]
commander.Program.
Command("serial ").
Option("--baud=9600").
Option("--timeout=").
Action(func() {
fmt.Printf("serial %s %s %s\n",
commander.Program.MustString(""),
commander.Program.MustString("--baud"),
commander.Program.MustString("--timeout"),
)
})
commander.Program.Parse()
```
Get the terminal output:
```bash
$ quick_example --version
# output: 0.1.1rc
$ quick_example tcp 127.0.0.1 1080 --timeout=110
# output: tcp 127.0.0.1 1080 110
$ quick_example serial 80 --baud=5800 --timeout=120
# output: serial 80 5800 120
```
### [Counted example](https://github.com/WindomZ/go-commander/blob/master/examples/counted_example/counted_example.go)
Such as the following help message
```markdown
Usage:
counted_example -v...
counted_example go [go]
counted_example (--path=)...
counted_example
counted_example -h|--help
counted_example -v|--version
Options:
-h --help output usage information
-v --version output the version number
```
To coding with `go-commander` just like this:
```go
import "github.com/WindomZ/go-commander"
...
// counted_example -v...
commander.Program.
Command("counted_example").
Option("-v...", "", func(c commander.Context) {
fmt.Println("-v =", c.Get("-v"))
})
// counted_example go [go]
commander.Program.
Command("go [go]").
Action(func(c commander.Context) {
fmt.Println("go =", c.Get("go"))
})
// counted_example (--path=)...
commander.Program.
Command("(--path=)...", "", func(c commander.Context) {
fmt.Printf("--path = %q\n",
c.MustStrings("--path"))
})
// counted_example
commander.Program.
Command(" ", "", func(c commander.Context) {
fmt.Printf(" = %q\n",
c.MustStrings(""))
})
commander.Program.Parse()
```
Get the terminal output:
```bash
$ counted_example -vvvvvvvvvv
# output: -v = 10
$ counted_example go go
# output: go = 2
$ counted_example --path ./here --path ./there
# output: --path = ["./here" "./there"]
$ counted_example this.txt that.txt
# output: = ["this.txt" "that.txt"]
```
### [Calculator example](https://github.com/WindomZ/go-commander/blob/master/examples/calculator_example/calculator_example.go)
Such as the following help message
```markdown
simple calculator example
Usage:
calculator_example ( ( + | - | * | / ) )...
calculator_example [( , )]...
calculator_example -h|--help
calculator_example -v|--version
Options:
-h --help output usage information
-v --version output the version number
Examples:
calculator_example 1 + 2 + 3 + 4 + 5
calculator_example 1 + 2 '*' 3 / 4 - 5 # note quotes around '*'
calculator_example sum 10 , 20 , 30 , 40
```
To coding with `go-commander` just like this:
```go
import . "github.com/WindomZ/go-commander"
...
// calculator_example
Program.Command("calculator_example").
Version("0.0.1").
Description("Simple calculator example")
// calculator_example ( ( + | - | * | / ) )...
Program.Command(" ( ( + | - | * | / ) )...", "", func() {
var result int
values := Program.MustStrings("")
for index, value := range values {
if i, err := strconv.Atoi(value); err != nil {
} else if index == 0 {
result = i
} else {
switch Program.GetArg(index*2 - 1) {
case "+":
result += i
case "-":
result -= i
case "*":
result *= i
case "/":
result /= i
}
}
}
fmt.Println(Program.ArgsString(), "=", result)
})
// calculator_example [( , )]...
Program.Command(" [( , )]...", "", func() {
var result int
switch Program.MustString("") {
case "sum":
values := Program.MustStrings("")
for _, value := range values {
if i, err := strconv.Atoi(value); err == nil {
result += i
}
}
}
fmt.Println(Program.ArgsString(), "=", result)
})
// Examples: ...
Program.Annotation("Examples",
[]string{
"calculator_example 1 + 2 + 3 + 4 + 5",
"calculator_example 1 + 2 '*' 3 / 4 - 5 # note quotes around '*'",
"calculator_example sum 10 , 20 , 30 , 40",
},
)
commander.Program.Parse()
```
Get the terminal output:
```bash
$ calculator_example 1 + 2 + 3 + 4 + 5
# output: 15
$ calculator_example 1 + 2 '*' 3 / 4 - 5
# output: -3
$ calculator_example sum 10 , 20 , 30 , 40
# output: 100
```
## UsingList
- [gitclone](https://github.com/WindomZ/gitclone)
- [gitinit](https://github.com/WindomZ/gitinit)
- [gitdate](https://github.com/WindomZ/gitdate)
- [gituser](https://github.com/WindomZ/gituser)
## Development
I would **love** to hear what you think about `go-commander` on [issues page](https://github.com/WindomZ/go-commander/issues)
Make pull requests, report bugs, suggest ideas and discuss `go-commander`.
## License
The [MIT License](https://github.com/WindomZ/go-commander/blob/master/LICENSE)