Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bobg/subcmd
https://github.com/bobg/subcmd
Last synced: 14 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/bobg/subcmd
- Owner: bobg
- License: mit
- Created: 2020-07-29T15:04:00.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-07-03T15:50:20.000Z (4 months ago)
- Last Synced: 2024-07-31T20:43:36.208Z (3 months ago)
- Language: Go
- Size: 45.9 KB
- Stars: 8
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: Readme.md
- License: LICENSE
Awesome Lists containing this project
- awesome-go - subcmd - Another approach to parsing and running subcommands. Works alongside the standard `flag` package. (Command Line / Standard CLI)
- fucking-awesome-go - subcmd - Another approach to parsing and running subcommands. Works alongside the standard `flag` package. (Command Line / Standard CLI)
- awesome-go - subcmd - Another approach to parsing and running subcommands. Works alongside the standard `flag` package. (Command Line / Standard CLI)
- awesome-go - subcmd - Another approach to parsing and running subcommands. Works alongside the standard `flag` package. (Command Line / Standard CLI)
- awesome-go-extra - subcmd - 07-29T15:04:00Z|2022-06-29T19:53:36Z| (Build Automation / Standard CLI)
- awesome-go-with-stars - subcmd - Another approach to parsing and running subcommands. Works alongside the standard `flag` package. (Command Line / Standard CLI)
- awesome-go-plus - subcmd - Another approach to parsing and running subcommands. Works alongside the standard `flag` package.   (Command Line / Standard CLI)
- awesome-go-plus - subcmd - Another approach to parsing and running subcommands. Works alongside the standard `flag` package.   (Command Line / Standard CLI)
README
# Subcmd - command-line interfaces with subcommands and flags
[](https://pkg.go.dev/github.com/bobg/subcmd/v2)
[](https://goreportcard.com/report/github.com/bobg/subcmd/v2)
[](https://github.com/bobg/subcmd/actions/workflows/go.yml)
[](https://coveralls.io/github/bobg/subcmd?branch=master)
This is subcmd,
a Go package for writing command-line programs that require flag parsing
and that have “subcommands” that also require flag parsing.
Use it when you want your program to parse command lines that look like this:
```
command -globalopt subcommand -subopt1 FOO -subopt2 ARG1 ARG2
```
Subcommands may have sub-subcommands and so on.
Subcommands may also be implemented as separate executables.
This is a layer on top of the standard Go `flag` package.
## Usage
```go
import (
"context"
"database/sql"
"flag"
"github.com/bobg/subcmd/v2"
)
func main() {
// Parse global flags normally.
dbname := flag.String("db", "", "database connection string")
flag.Parse()
db, err := sql.Open(dbdriver, *dbname)
if err != nil { ... }
// Stash global options in a top-level command object.
c := command{db: db}
// Run the subcommand given in the remainder of the command line.
err = subcmd.Run(context.Background(), c, flag.Args())
if err != nil { ... }
}
// The top-level command object.
type command struct {
db *sql.DB
}
// To be used in subcmd.Run above, `command` must implement this method.
func (c command) Subcmds() subcmd.Map {
return subcmd.Commands(
// The "list" subcommand takes one flag, -reverse.
"list", c.list, "list employees", subcmd.Params(
"-reverse", subcmd.Bool, false, "reverse order of list",
),
// The "add" subcommand takes no flags but one positional argument.
"add", c.add, "add new employee", subcmd.Params(
"name", subcmd.String, "", "employee name",
)
)
}
// Implementation of the "list" subcommand.
// The value of the -reverse flag is passed as an argument.
func (c command) list(ctx context.Context, reverse bool, _ []string) error {
query := "SELECT name FROM employees ORDER BY name"
if reverse {
query += " DESC"
}
rows, err := c.db.QueryContext(ctx, query)
if err != nil { ... }
defer rows.Close()
for rows.Next() { ... }
return rows.Err()
}
// Implementation of the "add" subcommand.
func (c command) add(ctx context.Context, name string, _ []string) error {
_, err := c.db.ExecContext(ctx, "INSERT INTO employees (name) VALUES ($1)", name)
return err
}
```