Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/muesli/mango
mango is a man-page generator for the Go flag, pflag, cobra, coral, and kong packages
https://github.com/muesli/mango
cobra coral flag go kong man-pages pflag self-documenting
Last synced: about 1 month ago
JSON representation
mango is a man-page generator for the Go flag, pflag, cobra, coral, and kong packages
- Host: GitHub
- URL: https://github.com/muesli/mango
- Owner: muesli
- License: mit
- Created: 2022-01-12T15:34:12.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-09-04T12:38:29.000Z (about 1 year ago)
- Last Synced: 2024-06-18T14:09:03.430Z (3 months ago)
- Topics: cobra, coral, flag, go, kong, man-pages, pflag, self-documenting
- Language: Go
- Homepage:
- Size: 74.2 KB
- Stars: 249
- Watchers: 4
- Forks: 7
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# mango
[](https://github.com/muesli/mango/releases)
[](/LICENSE)
[](https://github.com/muesli/mango/actions)
[](https://goreportcard.com/report/muesli/mango)
[](https://pkg.go.dev/github.com/muesli/mango)
mango is a man-page generator for the Go flag, pflag, cobra, coral, and kong
packages. It extracts commands, flags, and arguments from your program and
enables it to self-document.
## Adapters
Currently the following adapters exist:
- flag: support for Go's standard flag package
- [mango-cobra](https://github.com/muesli/mango-cobra): an adapter for [cobra](https://github.com/spf13/cobra)
- [mango-coral](https://github.com/muesli/mango-coral): an adapter for [coral](https://github.com/muesli/coral)
- [mango-kong](https://github.com/alecthomas/mango-kong): an adapter for [kong](https://github.com/alecthomas/kong)
- [mango-pflag](https://github.com/muesli/mango-pflag): an adapter for the [pflag](https://github.com/spf13/pflag) package
## Usage with flag:
```go
import (
"flag"
"fmt"
"github.com/muesli/mango"
"github.com/muesli/mango/mflag"
"github.com/muesli/roff"
)
var (
one = flag.String("one", "", "first value")
two = flag.String("two", "", "second value")
)
func main() {
flag.Parse()
manPage := mango.NewManPage(1, "mango", "a man-page generator").
WithLongDescription("mango is a man-page generator for Go.\n"+
"Features:\n"+
"* User-friendly\n"+
"* Plugable").
WithSection("Copyright", "(C) 2022 Christian Muehlhaeuser.\n"+
"Released under MIT license.")
flag.VisitAll(mflag.FlagVisitor(manPage))
fmt.Println(manPage.Build(roff.NewDocument()))
}
```
Mango will extract all the flags from your app and generate a man-page similar
to this example:
## Usage with pflag:
```go
import (
"fmt"
"github.com/muesli/mango"
mpflag "github.com/muesli/mango-pflag"
"github.com/muesli/roff"
flag "github.com/spf13/pflag"
)
func main() {
flag.Parse()
manPage := mango.NewManPage(1, "mango", "a man-page generator").
WithLongDescription("mango is a man-page generator for Go.").
WithSection("Copyright", "(C) 2022 Christian Muehlhaeuser.\n"+
"Released under MIT license.")
flag.VisitAll(mpflag.PFlagVisitor(manPage))
fmt.Println(manPage.Build(roff.NewDocument()))
}
```
## Usage with cobra:
```go
import (
"fmt"
mcobra "github.com/muesli/mango-cobra"
"github.com/muesli/roff"
"github.com/spf13/cobra"
)
var (
rootCmd = &cobra.Command{
Use: "mango",
Short: "A man-page generator",
}
)
func main() {
manPage, err := mcobra.NewManPage(1, rootCmd)
if err != nil {
panic(err)
}
manPage = manPage.WithSection("Copyright", "(C) 2022 Christian Muehlhaeuser.\n"+
"Released under MIT license.")
fmt.Println(manPage.Build(roff.NewDocument()))
}
```
## Usage with coral:
```go
import (
"fmt"
mcoral "github.com/muesli/mango-coral"
"github.com/muesli/roff"
"github.com/muesli/coral"
)
var (
rootCmd = &coral.Command{
Use: "mango",
Short: "A man-page generator",
}
)
func main() {
manPage, err := mcoral.NewManPage(1, rootCmd)
if err != nil {
panic(err)
}
manPage = manPage.WithSection("Copyright", "(C) 2022 Christian Muehlhaeuser.\n"+
"Released under MIT license.")
fmt.Println(manPage.Build(roff.NewDocument()))
}
```
## Feedback
Got some feedback or suggestions? Please open an issue or drop me a note!
* [Twitter](https://twitter.com/mueslix)
* [The Fediverse](https://mastodon.social/@fribbledom)