cristalhq / acmd

Simple, useful and opinionated CLI package in Go.

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

$ yarn

Local Development

$ yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

Using SSH:

$ USE_SSH=true yarn deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.

acmd's Issues

Integrate build info after Go 1.18 release

See golang/go#37475

Default cpomm

Remove command error wrapping

Lost stacktrace if err is pkg/errors

https://go.dev/play/p/R1YjxbwxKEQ

Support to `<context>:<command>` style

Hey, it's just a suggestion which I can contribute on to create it

Particularly, I like a lot heroku's command style <context>:<command> and I looked at that acmd doens't has support to put : as caracter in a command. What do you think about starting to accept : caracter to contemple this suggestion?

🎈 I know that already exists support to put subcommand (congrats for this) but I would like to support <context>:<command> as command for example app:create or user:delete

What about subcommands

I think it would be nice to have subcommands inside of acmd.Command

Default command

Hello, how can i execute an specific command (the default one) if no argument is provided

Failed with example

Tried to make example with acmd, but have no success.

package main

import (
	"context"
	"fmt"
	"github.com/cristalhq/acmd"
	"os"
)

func main() {
	cmds := []acmd.Command{
		{
			Name:        "test",
			Description: "test cmd",
			Do: func(ctx context.Context, args []string) error {
				fmt.Println("test")
				return nil
			},
		},
	}

	r := acmd.RunnerOf(cmds, acmd.Config{
		AppName:        "test",
		AppDescription: "Test example",
		Version:        "v0.0.1",
		Output: os.Stdout,
		Args: os.Args,
	})

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

}

Build with go build main.go. All attempts to exec the command are failed with panic panic: acmd: cannot run command: no such command "./main".

Update Command.Do field after Go 1.19

After golang/go#47487 Command.Do can be an interface

type Doer interface {
	Do(ctx context.Context, args []string) error
}