cli

aperturerobotics/cli is a fork of the popular urfave/cli v2 package for building command line apps in Go. The goal is to enable developers to write fast and distributable command line applications in an expressive way, while minimizing dependencies and maximizing compatibility.

Key differences from urfave/cli:

Slim and Reflection-Free:
- Removed reflect usage for smaller binaries and better performance.
- Tinygo compatible.
- Removed documentation generators.
- Removed altsrc package to focus on CLI handling only.
Stability: Try to maintain backward compatibility as much as possible.

Installation

Using this package requires a working Go environment. See the install instructions for Go.

Go Modules are required when using this package. See the go blog guide on using Go Modules.

go get github.com/aperturerobotics/cli

Getting Started

Here's a simple example to get you started:

package main

import (
	"fmt"
	"log"
	"os"

	"github.com/aperturerobotics/cli"
)

func main() {
	app := &cli.App{
		Name:  "greet",
		Usage: "a simple greeter application",
		Flags: []cli.Flag{
			&cli.StringFlag{
				Name:    "name",
				Value:   "world",
				Usage:   "who to greet",
				EnvVars: []string{"GREET_NAME"},
			},
		},
		// The action for the root command (optional)
		Action: func(ctx *cli.Context) error {
			name := ctx.String("name")
			fmt.Printf("Hello %s!\n", name)
			return nil
		},
		// Define subcommands
		Commands: []*cli.Command{
			{
				Name:  "add",
				Usage: "add a task to the list",
				// Action for the 'add' subcommand
				Action: func(ctx *cli.Context) error {
					fmt.Println("added task: ", ctx.Args().First())
					return nil
				},
			},
			{
				Name:  "complete",
				Usage: "complete a task on the list",
				// Action for the 'complete' subcommand
				Action: func(ctx *cli.Context) error {
					fmt.Println("completed task: ", ctx.Args().First())
					return nil
				},
			},
		},
	}

	// Run the application
	if err := app.Run(os.Args); err != nil {
		log.Fatal(err)
	}
}

// Try running this:
// GREET_NAME=everyone ./greet --name someone add some-task
// ./greet complete --help

Running this provides basic command functionality, including help text generation, flag parsing, environment variable handling, and subcommand routing. You can easily add more flags, subcommands, and complex actions.

Documentation

Full documentation and examples are available in the ./docs directory and online at https://cli.aperture.app.

License

This fork retains the original MIT license from urfave/cli. See LICENSE.

License

aperturerobotics/cli

ErrorLooks like something went wrong!

About

Resources

License

Code of conduct

Uh oh!

Stars

Watchers

Forks

Releases

Uh oh!

Languages

Error
Looks like something went wrong!