Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/devfacet/gocmd
A Go library for building command line applications.
https://github.com/devfacet/gocmd
go golang golang-library
Last synced: about 2 months ago
JSON representation
A Go library for building command line applications.
- Host: GitHub
- URL: https://github.com/devfacet/gocmd
- Owner: devfacet
- License: mit
- Created: 2018-01-08T04:52:02.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-04-04T21:43:27.000Z (over 1 year ago)
- Last Synced: 2024-09-30T23:23:08.343Z (2 months ago)
- Topics: go, golang, golang-library
- Language: Go
- Homepage:
- Size: 134 KB
- Stars: 66
- Watchers: 3
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-go - gocmd - Go library for building command line applications. (Command Line / Standard CLI)
- fucking-awesome-go - gocmd - Go library for building command line applications. (Command Line / Standard CLI)
- awesome-go - gocmd - Go library for building command line applications. (Command Line / Standard CLI)
- awesome-go - gocmd - Go library for building command line applications. (Command Line / Standard CLI)
- awesome-go - gocmd - A Go library for building command line applications - ★ 23 (Command Line)
- awesome-go-extra - gocmd - 01-08T04:52:02Z|2022-05-04T03:54:19Z| (Build Automation / Standard CLI)
- awesome-go-with-stars - gocmd - Go library for building command line applications. (Command Line / Standard CLI)
- awesome-go-cn - gocmd
- awesome-go-plus - gocmd - Go library for building command line applications.  (Command Line / Standard CLI)
- awesome-go-plus - gocmd - Go library for building command line applications.   (Command Line / Standard CLI)
README
# gocmd
[![Godoc][doc-image]][doc-url] [![Release][release-image]][release-url] [![Build][build-image]][build-url] [![Report][report-image]][report-url]
A Go library for building command line applications.
## Features
- Advanced command line arguments handling
- Subcommand handling
- Short and long command line arguments
- Multiple arguments (repeated or delimited)
- Support for environment variables
- Well formatted usage printing
- Auto usage and version printing
- Unknown argument handling
- Output tables in the terminal
- Template support for config files
- No external dependency
## Installation
```shell
go get github.com/devfacet/gocmd/v3
```
## Usage
### A basic app
For the full code [click here](_examples/basic/main.go).
```go
func main() {
flags := struct {
Help bool `short:"h" long:"help" description:"Display usage" global:"true"`
Version bool `short:"v" long:"version" description:"Display version"`
VersionEx bool `long:"vv" description:"Display version (extended)"`
Echo struct {
Settings bool `settings:"true" allow-unknown-arg:"true"`
} `command:"echo" description:"Print arguments"`
Math struct {
Sqrt struct {
Number float64 `short:"n" long:"number" required:"true" description:"Number"`
} `command:"sqrt" description:"Calculate square root"`
Pow struct {
Base float64 `short:"b" long:"base" required:"true" description:"Base"`
Exponent float64 `short:"e" long:"exponent" required:"true" description:"Exponent"`
} `command:"pow" description:"Calculate base exponential"`
} `command:"math" description:"Math functions" nonempty:"true"`
}{}
// Echo command
gocmd.HandleFlag("Echo", func(cmd *gocmd.Cmd, args []string) error {
fmt.Printf("%s\n", strings.Join(cmd.FlagArgs("Echo")[1:], " "))
return nil
})
// Math commands
gocmd.HandleFlag("Math.Sqrt", func(cmd *gocmd.Cmd, args []string) error {
fmt.Println(math.Sqrt(flags.Math.Sqrt.Number))
return nil
})
gocmd.HandleFlag("Math.Pow", func(cmd *gocmd.Cmd, args []string) error {
fmt.Println(math.Pow(flags.Math.Pow.Base, flags.Math.Pow.Exponent))
return nil
})
// Init the app
gocmd.New(gocmd.Options{
Name: "basic",
Description: "A basic app",
Version: fmt.Sprintf("%s (%s)", version, gitCommit),
Flags: &flags,
ConfigType: gocmd.ConfigTypeAuto,
})
}
```
## Test
```shell
# Run tests
make test
# Continuous testing
make test-ui
# Benchmarks
make test-benchmarks
```
## Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md)
## License
Licensed under The MIT License (MIT)
For the full copyright and license information, please view the LICENSE.txt file.
[doc-url]: https://pkg.go.dev/github.com/devfacet/gocmd
[doc-image]: https://pkg.go.dev/badge/github.com/devfacet/gocmd
[release-url]: https://github.com/devfacet/gocmd/releases/latest
[release-image]: https://img.shields.io/github/release/devfacet/gocmd.svg?style=flat-square
[build-url]: https://github.com/devfacet/gocmd/actions/workflows/test.yaml
[build-image]: https://github.com/devfacet/gocmd/workflows/Test/badge.svg
[report-url]: https://goreportcard.com/report/github.com/devfacet/gocmd
[report-image]: https://goreportcard.com/badge/github.com/devfacet/gocmd?style=flat-square