https://github.com/google/subcommands

Go subcommand library.
https://github.com/google/subcommands

Last synced: 22 days ago
JSON representation

Go subcommand library.

• Host: GitHub
• URL: https://github.com/google/subcommands
• Owner: google
• License: apache-2.0
• Created: 2016-02-23T17:02:31.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2022-11-17T00:00:06.000Z (about 2 years ago)
• Last Synced: 2024-11-17T12:45:54.535Z (26 days ago)
• Language: Go
• Homepage:
• Size: 19.5 KB
• Stars: 756
• Watchers: 15
• Forks: 49
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING
  • License: LICENSE

Awesome Lists containing this project

• awesome-hacking-lists - google/subcommands - Go subcommand library. (Go)

README

        
# subcommands #

[![GoDoc](https://godoc.org/github.com/google/subcommands?status.svg)](https://godoc.org/github.com/google/subcommands)  

Subcommands is a Go package that implements a simple way for a single command to

have many subcommands, each of which takes arguments and so forth.

This is not an official Google product.

## Usage ##

Set up a 'print' subcommand:

```go

import (

  "context"

  "flag"

  "fmt"

  "os"

  "strings"

  "github.com/google/subcommands"

)

type printCmd struct {

  capitalize bool

}

func (*printCmd) Name() string     { return "print" }

func (*printCmd) Synopsis() string { return "Print args to stdout." }

func (*printCmd) Usage() string {

  return `print [-capitalize] :

  Print args to stdout.

`

}

func (p *printCmd) SetFlags(f *flag.FlagSet) {

  f.BoolVar(&p.capitalize, "capitalize", false, "capitalize output")

}

func (p *printCmd) Execute(_ context.Context, f *flag.FlagSet, _ ...interface{}) subcommands.ExitStatus {

  for _, arg := range f.Args() {

    if p.capitalize {

      arg = strings.ToUpper(arg)

    }

    fmt.Printf("%s ", arg)

  }

  fmt.Println()

  return subcommands.ExitSuccess

}

```

Register using the default Commander, also use some built in subcommands,

finally run Execute using ExitStatus as the exit code:

```go

func main() {

  subcommands.Register(subcommands.HelpCommand(), "")

  subcommands.Register(subcommands.FlagsCommand(), "")

  subcommands.Register(subcommands.CommandsCommand(), "")

  subcommands.Register(&printCmd{}, "")

  flag.Parse()

  ctx := context.Background()

  os.Exit(int(subcommands.Execute(ctx)))

}

```