cli

Documentation

Overview

Package cli is the shared flaggy wrapper (D23).

flaggy: zero deps, flags at any position, shell completion scripts. Individual tools keep ShowCompletion off so a query like "completion" is not stolen; dump scripts with bin/cli/complete.go.

Index

• Variables
• func BashScript(tools []Tool) string
• func BindQA(c *QAStats) *flaggy.Parser
• func Code(err error) int
• func Fail(err error) int
• func New(name string) *flaggy.Parser
• func Parse(p *flaggy.Parser, args []string) error
• func QAParser() *flaggy.Parser
• func Query(first string, trailing []string) string
• type QAStats
  • func ParseQAStats(args []string) (QAStats, error)
• type Tool

Variables

var ErrHelp = errors.New("help")

ErrHelp means -h/--help was requested (exit 0).

Functions

func BashScript

func BashScript(tools []Tool) string

BashScript concatenates flaggy bash complete scripts and binds each function to the shebang path (./bin/subject/method.go).

func BindQA

func BindQA(c *QAStats) *flaggy.Parser

func Code

func Code(err error) int

Code maps parse errors to process exit codes (0 help, 2 usage).

func Fail

func Fail(err error) int

Fail prints err unless it is help or a flaggy exit that already wrote stderr.

func New

func New(name string) *flaggy.Parser

New returns a per-call parser. Never reuse: flaggy parses once.

func Parse

func Parse(p *flaggy.Parser, args []string) error

Parse runs p.ParseArgs and turns flaggy's os.Exit into an error. Not safe to call in parallel (flaggy.PanicInsteadOfExit is process-global).

func QAParser

func QAParser() *flaggy.Parser

func Query

func Query(first string, trailing []string) string

Query joins the first positional with leftover trailing words.

Types

type QAStats

type QAStats struct {
	JSONL string
}

func ParseQAStats

func ParseQAStats(args []string) (QAStats, error)

type Tool

type Tool struct {
	Path string
	Name string
	New  func() *flaggy.Parser
}

Tool is one shebang CLI for completion dump.