args

Documentation

Overview

Package args defines the Trice command-line interface.

It owns subcommand flag sets, parses command-line arguments, and dispatches to the corresponding runtime actions (log, help, version, add, insert, clean, generate, scan, display server, and shutdown).

Handler is the package entry point used by cmd/trice.

Index

• Variables
• func FlagsInit()
• func Handler(w io.Writer, fSys *afero.Afero, args []string) error
• func RenderHelpText(helpArgs ...string) (string, error)

Variables

var (
	// Version is injected at build time (typically by goreleaser).
	Version string

	// Commit is the VCS revision hash injected at build time.
	Commit string

	// Date is the build timestamp injected at build time.
	Date string

	// Verbose enables additional informational output.
	Verbose bool

	// Branch is the Git branch name at build time.
	Branch string

	// GitState indicates repository state at build time ("clean" or "dirty").
	GitState string

	// GitStatus contains a '|' separated summary of modified files at build time.
	GitStatus string

	// BuiltBy is an optional builder identifier (see .goreleaser.yaml).
	BuiltBy string
)

var (

	// LogfileName is the filename of the logfile. "off" inhibits logfile writing.
	LogfileName = "off"
)

Functions

func FlagsInit

func FlagsInit()

FlagsInit initializes all sub-command flag sets.

func Handler

func Handler(w io.Writer, fSys *afero.Afero, args []string) error

Handler parses args and executes the selected sub-command.

args is expected in os.Args form where args[0] is the executable name and args[1] is the sub-command.

func RenderHelpText

func RenderHelpText(helpArgs ...string) (string, error)

RenderHelpText returns the help output for the passed help command arguments.