cmd

Documentation

Overview

Package cmd is beekeeper's command line.

Index

• Constants
• func Code(err error) int
• func Main() int
• func New() *cobra.Command

Constants

const (
	// ExitGateQueued: the merge keeps its place; run the same command again.
	ExitGateQueued = 76
	// ExitGateRefused: a hold, the budget floor or an unreadable installation.
	ExitGateRefused = 77
	// GatePrefix starts every line the gate prints.
	GatePrefix = "beekeeper gate: "
	// DefaultGateWait is a foreground merge's wait for its turn; the hook
	// gives a background one BackgroundGateWait.
	DefaultGateWait    = 2 * time.Minute
	BackgroundGateWait = 30 * time.Minute
)

The gate's own exit codes, apart from devctl's 1-9 and the busy machine's 75.

const (
	ExitError    = 1
	ExitUsage    = 2
	ExitRefused  = 3
	ExitRelieved = 4
	ExitOutdated = 125
)

Exit codes: 0 done, 1 error, 2 usage, 3 refused (a lease held or not granted, a hold set, the budget under its floor), 4 relieved (supervisor status in the session a relay relieved), 125 outdated (a newer release exists: self-update --check, the status devctl's version check and muster's self-update --check use).

Functions

func Code

func Code(err error) int

Code returns the exit code err asks for.

func Main

func Main() int

Main runs the command line and returns the process exit code. An error without a message (a wrapped command's exit code) prints nothing.

func New

func New() *cobra.Command

New returns the root command.