https://github.com/rwxrob/help

🌳 Go Bonzai™ Default help Command
https://github.com/rwxrob/help

bonzai commander documentation go golang help

Last synced: over 1 year ago
JSON representation

🌳 Go Bonzai™ Default help Command

• Host: GitHub
• URL: https://github.com/rwxrob/help
• Owner: rwxrob
• License: apache-2.0
• Created: 2022-04-08T09:18:08.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2022-12-09T16:30:11.000Z (over 3 years ago)
• Last Synced: 2024-10-11T01:47:42.348Z (over 1 year ago)
• Topics: bonzai, commander, documentation, go, golang, help
• Language: Go
• Homepage:
• Size: 55.7 KB
• Stars: 1
• Watchers: 2
• Forks: 3
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

          
# 🌳 Go Bonzai™ Default `help` Command

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

[![License](https://img.shields.io/badge/license-Apache2-brightgreen.svg)](LICENSE)

This is the default help originally included with the [Go Bonzai

package](https://github.com/rwxrob/bonzai) itself but factored out so

that it's `Version` tag could be consistent with other Bonzai branches

(which correspond to git tags by convention). This also allows other

(potentially better) `help.Cmd` to be developed without a substantial

bias one way or another.

## Install

```go

package z

import (

	Z "github.com/rwxrob/bonzai/z"

	"github.com/rwxrob/help"

)

var Cmd = &Z.Cmd{

	Name:     `z`,

	Commands: []*Z.Cmd{help.Cmd}, // usually first

}

```

## Other Examples

*  - the one that started it all