bon

package module
v0.1.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 12, 2022 License: Apache-2.0 Imports: 6 Imported by: 0

README

🌳 Go Bonzai Utility Branch

GoDoc License

This bon bonzai branch contains helpers for creating and managing stateful command branches in Go.

Install

You can just download from the releases page.

curl -L https://github.com/rwxrob/bon/releases/latest/download/bon-linux-amd64 -o ~/.local/bin/bon
curl -L https://github.com/rwxrob/bon/releases/latest/download/bon-darwin-amd64 -o ~/.local/bin/bon
curl -L https://github.com/rwxrob/bon/releases/latest/download/bon-darwin-arm64 -o ~/.local/bin/bon
curl -L https://github.com/rwxrob/bon/releases/latest/download/bon-windows-amd64 -o ~/.local/bin/bon

Or with go:

go install github.com/rwxrob/bon/cmd/bon@latest

Composed

package z

import (
	Z "github.com/rwxrob/bonzai/z"
	"github.com/rwxrob/bon"
)

var Cmd = &Z.Cmd{
	Name:     `z`,
	Commands: []*Z.Cmd{help.Cmd, bon.Cmd},
}

Tab Completion

To activate bash completion just use the complete -C option from your .bashrc or command line. There is no messy sourcing required. All the completion is done by the program itself.

complete -C bon bon

If you don't have bash or tab completion check use the shortcut commands instead.

Embedded Documentation

All documentation (like manual pages) has been embedded into the source code of the application. See the source or run the program with help to access it.

Command Line Usage

bon help

Build and Release Instructions

Building workflow uses the good Go helper tool (often composited into bonzai personal command trees (z go):

cd cmd/bon
good build
gh release create
gh release upload TAGVER build/*

Documentation

Index

Constants

This section is empty.

Variables

View Source
var Cmd = &Z.Cmd{
	Name:        `bon`,
	Aliases:     []string{`bonzai`},
	Summary:     help.S(_bon),
	Description: help.D(_bon),
	Version:     `v0.1.3`,
	Copyright:   `Copyright 2022 Rob Muhlestein`,
	Site:        `rwxrob.tv`,
	Source:      `git@github.com:rwxrob/bon.git`,
	Issues:      `https://github.com/rwxrob/bon/issues`,
	License:     `Apache-2.0`,
	Commands:    []*Z.Cmd{help.Cmd, commandCmd},
}

Functions

This section is empty.

Types

This section is empty.

Directories

Path Synopsis
cmd
bon command

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL