https://github.com/eteran/cligo
https://github.com/eteran/cligo
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/eteran/cligo
- Owner: eteran
- License: gpl-3.0
- Created: 2023-10-07T15:49:10.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-02-19T16:51:17.000Z (over 1 year ago)
- Last Synced: 2025-05-04T08:44:07.801Z (about 1 year ago)
- Language: Go
- Size: 114 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# cligo
cligo is an opinionated argument parser library that is designed to be clean, intuitive, but powerful. It library was inspired the very robust CLI11 library, and incorporates many of its user friendly features. Go does have argument parsing in the standard library, but I've never liked how it deviates from the expected unix style. Cobra is great, but I personally find it to be a bit more heavy weight than I'd like. So cligo was born.
cligo implements classic GNU style parameters with both long and short forms of arguments. It supports validation of arguments, the ability to group them, and as well as the ability to group have arguments require that others do or do not exist. Because validators are just functions, they can be of course be expanded on by consumers of the library. The following is a classic example of an application which requires a filename, and has an optional verbosity flag.
```go
package main
import (
"errors"
"fmt"
"os"
"github.com/eteran/cligo"
)
func main() {
var filename string
var verbose bool
app := cligo.NewApp()
app.AddOption("-f,--file", &filename, "filename", cligo.Required(), cligo.AddValidator(cligo.ExistingFile()))
app.AddFlag("-v,--verbose", &verbose, "increase verbosity")
if err := app.ParseStrict(); err != nil {
fmt.Println(err)
os.Exit(0)
}
}
```
If we want, we can make the filename positional instead.
```go
package main
import (
"errors"
"fmt"
"os"
"github.com/eteran/cligo"
)
func main() {
var filename string
var verbose bool
app := cligo.NewApp()
app.AddOption("filename", &filename, "filename", cligo.Required(), cligo.AddValidator(cligo.ExistingFile()))
app.AddFlag("-v,--verbose", &verbose, "increase verbosity")
if err := app.ParseStrict(); err != nil {
fmt.Println(err)
os.Exit(0)
}
}
```