acmd

Simple, useful and opinionated CLI package in Go.

Programming language: Go

License: MIT License

Tags: Command Line     Standard CLI    

README

acmd

Simple, useful and opinionated CLI package in Go. For config loader see aconfig

Rationale

Popular CLI libraries (or better frameworks) have too large and unclear API, in most cases, you just want to define commands for your CLI application and run them without additional work. This package does this by providing a small API, good defaults and clear code.

Features

• Simple API.
• Dependency-free.
• Clean and tested code.
• Command aliases.
• Auto suggesting command.
• Builtin help and version commands.

See GUIDE.md for more details

Install

Go version 1.17+

go get github.com/cristalhq/acmd

Example

cmds := []acmd.Command{
    {
        Name:        "now",
        Description: "prints current time",
        ExecFunc: func(ctx context.Context, args []string) error {
            fmt.Printf("now: %s\n", now.Format("15:04:05"))
            return nil
        },
    },
    {
        Name:        "status",
        Description: "prints status of the system",
        ExecFunc: func(ctx context.Context, args []string) error {
            // do something with ctx :)
            return nil
        },
    },
}

// all the acmd.Config fields are optional
r := acmd.RunnerOf(cmds, acmd.Config{
    AppName:        "acmd-example",
    AppDescription: "Example of acmd package",
    Version:        "the best v0.x.y",
    // Context - if nil `signal.Notify` will be used
    // Args - if nil `os.Args[1:]` will be used
    // Usage - if nil default print will be used
})

if err := r.Run(); err != nil {
    r.Exit(err)
}

Also see examples: examples_test.go.

Documentation

See these docs.

License

[MIT License](LICENSE).