cli

Documentation

Overview

Package cli builds the cobra command tree — the curated, stable UX surface.

Index

• Constants
• func Execute() int
• func ExitCodeFor(err error) int
• func NewRootCmd() *cobra.Command

Constants

const (
	ExitOK         = 0
	ExitGeneric    = 1
	ExitAuthConfig = 2
	ExitNotFound   = 3
	ExitAPIServer  = 4
	ExitTaskFailed = 5
	ExitValidation = 6
)

Exit codes (documented contract). Scripts may rely on these.

Functions

func Execute

func Execute() int

Execute runs the root command and maps errors to exit codes. Before handing off to cobra, it checks whether the invocation targets an external plugin (pc-<name>) and, if so, dispatches to it. Built-in commands take precedence.

func ExitCodeFor

func ExitCodeFor(err error) int

ExitCodeFor maps an error to its process exit code.

func NewRootCmd

func NewRootCmd() *cobra.Command

NewRootCmd assembles the full command tree.