jobala/commando

An elegant Go CLI framework

commando's Issues

Command Help

Command help is shown when a user adds the --help flag after a command. For Commando, I want to separate concerns between registering commands and command groups and their help information. Developers will define help in help.yaml file then commando will load the file and add help to the commands.

The yaml file should have the following format

parent child grand-child
    type: command
    short-summary: "grand-child help"
    parameters:
      - name: --body
        short-summary: "itemBody"
        long-summary: |
            Usage: --body content=XX content-type=XX
            content: The content of the item.
      - name: --end
        short-summary: "dateTimeTimeZone"
        long-summary: |
            Usage: --end date-time=XX time-zone=XX

Running parent child grand-child --help will result in the output below

usage: parent child grand-child [-h|--help] --body <string> --end <string>

Arguments:

  -h  --help      Print help information
       --body      itemBody
       --end        dateTimeTimeZone

Shell Autocomplete

Show command usage information

Support more data types float, selector, etc

Commando currently supports string and int flags and needs to support the following types

• int list
• string list
• float
• float list
• file
• file list
• selector

Hooks

Preview Commands aka Experimental/Beta Commands

Log Command Execution

Register Commands

type args struct {
  fname string  `required`
  lname string 
}

func handler(input args) {
    fmt.Printf("%s %s\n", input.fname, input.lname)
}

cli.Command("print", handler, args)

mg print --fname "Hello" --lname "World"
Hello World

Group Commands

Open-sourcing Checklist

• Add License
• Add integration test workflow
• Add issue and pull request template
• Add getting started section in README.md
• Add conventional commits GitHub action
• Add Go CI lint

Execute Commands