fang

Fang

The CLI starter kit. A small, experimental library for batteries-included Cobra applications.

Features

• Fancy output: fully styled help and usage pages
• Fancy errors: fully styled errors
• Automatic --version: set it to the build info, or a version of your choice
• Manpages: Adds a hidden man command to generate manpages using mango[^1]
• Completions: Adds a completion command to generate shell completions
• Themeable: use the built-in theme, or make your own
• UX: Silent usage output (help is not shown after a user error)

[^1]: Default cobra man pages generates one man page for each command. This is generally fine for programs with a lot of sub commands, like git, but its an overkill for smaller programs. Mango also uses roff directly instead of converting from markdown, so it should render better looking man pages.

Usage

To use it, invoke fang.Execute passing your root *cobra.Command:

package main

import (
	"context"
	"os"

	"github.com/charmbracelet/fang"
	"github.com/spf13/cobra"
)

func main() {
	cmd := &cobra.Command{
		Use:   "example",
		Short: "A simple example program!",
	}
	if err := fang.Execute(context.Background(), cmd); err != nil {
		os.Exit(1)
	}
}

That's all there is to it!

Contributing

See contributing.

Feedback

We’d love to hear your thoughts on this project. Feel free to drop us a note!

• Twitter
• Discord
• The Fediverse

License

MIT

Part of Charm.

Charm热爱开源 • Charm loves open source