Documentation
¶
Index ¶
- Constants
- func FilterMessages(items []listItem, opts FilterOptions) []listItem
- func GetExitCode(err error) int
- func NotFoundError(format string, args ...any) error
- func Run(args []string, version string) error
- func TimeoutError(format string, args ...any) error
- func UsageError(format string, args ...any) error
- func WithExitCode(code int, err error) error
- type CommandHandler
- type CommandInfo
- type ExitCodeError
- type FilterOptions
Constants ¶
const ( // ExitSuccess indicates the command completed successfully. ExitSuccess = 0 // ExitError indicates a general error occurred. ExitError = 1 // ExitUsage indicates invalid arguments or flags were provided. ExitUsage = 2 // ExitNotFound indicates a requested resource was not found // (message, config, agent, etc.). ExitNotFound = 3 // ExitTimeout indicates a timeout occurred (watch, monitor commands). ExitTimeout = 4 )
Exit codes for CLI commands. These provide semantic meaning for scripting and automation.
Variables ¶
This section is empty.
Functions ¶
func FilterMessages ¶ added in v0.9.6
func FilterMessages(items []listItem, opts FilterOptions) []listItem
FilterMessages returns items that match all provided filter options.
func GetExitCode ¶ added in v0.9.6
GetExitCode extracts the exit code from an error. Returns ExitSuccess (0) if err is nil. Returns the wrapped code if err is an *ExitCodeError. Returns ExitError (1) for all other errors.
func NotFoundError ¶ added in v0.9.6
NotFoundError creates an error with ExitNotFound code.
func TimeoutError ¶ added in v0.9.6
TimeoutError creates an error with ExitTimeout code.
func UsageError ¶ added in v0.9.6
UsageError creates an error with ExitUsage code.
func WithExitCode ¶ added in v0.9.6
WithExitCode wraps an error with a specific exit code.
Types ¶
type CommandHandler ¶ added in v0.23.0
CommandHandler is the function signature for command handlers in the registry.
type CommandInfo ¶ added in v0.23.0
type CommandInfo struct {
Name string
Summary string
Description string
LongDescription []string
Examples []string
Handler CommandHandler
Children []CommandInfo
}
CommandInfo describes a top-level command or subcommand for help generation and future routing/completion work.
type ExitCodeError ¶ added in v0.9.6
ExitCodeError wraps an error with a specific exit code.
func (*ExitCodeError) Error ¶ added in v0.9.6
func (e *ExitCodeError) Error() string
func (*ExitCodeError) Unwrap ¶ added in v0.9.6
func (e *ExitCodeError) Unwrap() error
Source Files
¶
- cleanup.go
- cli.go
- common.go
- completion.go
- coop.go
- coop_exec_unix.go
- dlq.go
- doctor.go
- doctor_ops.go
- drain.go
- env.go
- exitcode.go
- extensions.go
- filter.go
- inbox_collect.go
- inbox_item.go
- init.go
- integration_kanban.go
- integration_symphony.go
- list.go
- monitor.go
- presence.go
- read.go
- receipts.go
- registry.go
- reply.go
- route.go
- send.go
- shell_setup.go
- swarm.go
- thread.go
- update_check.go
- upgrade.go
- validate.go
- wake.go
- wake_input_linux.go
- wake_lock.go
- wake_metadata.go
- wake_metadata_unix.go
- wake_process_linux.go
- wake_target.go
- wake_target_owner_unix.go
- wake_tiocsti_unix.go
- wake_unix.go
- watch.go
- who.go