Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/steverusso/goclap
Generate command line argument parsing code from Go comments.
https://github.com/steverusso/goclap
cli codegen command-line generator go golang
Last synced: 3 days ago
JSON representation
Generate command line argument parsing code from Go comments.
- Host: GitHub
- URL: https://github.com/steverusso/goclap
- Owner: steverusso
- License: unlicense
- Created: 2023-02-19T14:55:59.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-09-30T13:11:47.000Z (5 months ago)
- Last Synced: 2025-02-09T00:52:46.029Z (6 days ago)
- Topics: cli, codegen, command-line, generator, go, golang
- Language: Go
- Homepage:
- Size: 151 KB
- Stars: 9
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# goclap
[](https://pkg.go.dev/github.com/steverusso/goclap)
[](https://github.com/steverusso/goclap/actions/workflows/ci.yaml)
[](https://goreportcard.com/report/github.com/steverusso/goclap)
```
go install github.com/steverusso/goclap@latest
```
A pre-build tool to generate **c**ommand **l**ine **a**rgument **p**arsing code from Go
comments. The idea is inspired by the [`clap` Rust
crate](https://github.com/clap-rs/clap), specifically its use of documentation and proc
macros.
## Example
The following is taken from [`examples/simple/main.go`](./examples/simple/main.go).
```go
//go:generate goclap -type mycli
...
// Print a string with the option to make it uppercase.
type mycli struct {
// Make the input string all uppercase.
//
// clap:opt upper
toUpper bool
// The input string.
//
// clap:arg_required
input string
}
func main() {
c := mycli{}
c.Parse(os.Args[1:])
s := c.input
if c.toUpper {
s = strings.ToUpper(s)
}
fmt.Println(s)
}
```
By running `go generate` (assuming `goclap` is installed), the `mycli` struct, its fields,
and their comments will be used to generate code for parsing command line arguments into a
`mycli`. That code will be placed in a file named `clap.gen.go` (see [the `simple`
example's one](./examples/simple/clap.gen.go)). The program can then be built with `go
build`.
Running `./simple -u hello` will output "HELLO", and running `./simple -h` will output the
following help message:
```
simple - Print a string with the option to make it uppercase
usage:
simple [options]
options:
-upper Make the input string all uppercase
-h Show this help message
arguments:
The input string
```
## Building
To just build the project as is, run `go build`. If you have
[`task`](https://github.com/go-task/task) installed, you can run `task get-tools` to
install the latest versions of
([`goimports`](https://pkg.go.dev/golang.org/x/tools/cmd/goimports),
[`gofumpt`](https://github.com/mvdan/gofumpt), and
[`staticcheck`](https://staticcheck.io/)). Once you have those tools, you can run `task`
to format, build, and lint the code, or you can run `task install` to format, lint, and
install `goclap`.
## Projects Using Goclap
* [lockbook-x/lbcli](https://github.com/steverusso/lockbook-x/tree/master/lbcli)
## License
This is free and unencumbered software released into the public domain. Please
see the [UNLICENSE](./UNLICENSE) file for more information.