https://github.com/unsafe-risk/broccoli

Broccoli: CLI Package for Go
https://github.com/unsafe-risk/broccoli

cli command-line golang zero-dependencies

Last synced: about 1 year ago
JSON representation

Broccoli: CLI Package for Go

• Host: GitHub
• URL: https://github.com/unsafe-risk/broccoli
• Owner: unsafe-risk
• License: cc0-1.0
• Created: 2022-08-19T10:27:06.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2023-02-27T06:32:21.000Z (over 3 years ago)
• Last Synced: 2025-05-07T22:44:09.525Z (about 1 year ago)
• Topics: cli, command-line, golang, zero-dependencies
• Language: Go
• Homepage: https://pkg.go.dev/gopkg.eu.org/broccoli
• Size: 75.2 KB
• Stars: 8
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![GitHub](https://img.shields.io/github/license/unsafe-risk/broccoli?style=for-the-badge)](https://github.com/unsafe-risk/broccoli/blob/main/LICENSE)

[![GitHub Workflow Status (event)](https://img.shields.io/github/actions/workflow/status/unsafe-risk/broccoli/go-test.yml?event=push&style=for-the-badge)](https://github.com/unsafe-risk/broccoli/actions/workflows/go-test.yml)

[![Go Reference](https://img.shields.io/badge/go-reference-%23007d9c?style=for-the-badge&logo=go)](https://pkg.go.dev/gopkg.eu.org/broccoli)

# broccoli

Broccoli: [CLI](https://en.wikipedia.org/wiki/Command-line_interface) Package for Go

## Usage

```go

package main

import (

	"fmt"

	"gopkg.eu.org/broccoli"

)

type Config struct {

	_    struct{} `version:"0.0.1" command:"hello" about:"Test App"`

	Name string   `flag:"name" alias:"n" required:"true" about:"Your name"`

	Sub *SubCommand `subcommand:"sub"`

}

type SubCommand struct {

	_    struct{} `command:"sub" longabout:"Test Sub Command"`

	Name string   `flag:"name" alias:"n" required:"true" about:"Your name"`

}

func main() {

	var cfg Config

	_ = broccoli.BindOSArgs(&cfg)

	if cfg.Sub != nil {

		fmt.Printf("Hello %s from sub command\n", cfg.Sub.Name)

		return

	}

	fmt.Printf("Hello %s from main command\n", cfg.Name)

}

```

```

$ hello --help

hello 0.0.1

Test App

Usage:

        hello  [OPTIONS] --name  [ARGUEMENTS]

Options:

        -n, --name     Your name  (required)

        -h, --help     Print this help message and exit

Commands:

        sub    Test Sub Command

$ hello --name World

Hello World from main command

$ hello sub --name World

Hello World from sub command

```

## Installation

```bash

go get -u gopkg.eu.org/broccoli

```