cmd

Documentation

Index

• func Execute() error
• func GetJQ() string
• func GetMode() string
• func GetOutputFormat() output.Format
• func GetProfile() string
• func IsVerbose() bool
• type CheckResult
• type CheckStatus
• type Doctor
  • func (doctor *Doctor) Run() *DoctorReport
• type DoctorReport
• type UpgradeOutcome

Functions

func Execute

func Execute() error

func GetJQ

func GetJQ() string

GetJQ returns the jq expression configured via --jq, or empty string when the user did not opt in. Commands that produce JSON output should pass this through ApplyJQ before rendering so the filter is honored uniformly.

func GetMode

func GetMode() string

func GetOutputFormat

func GetOutputFormat() output.Format

func GetProfile

func GetProfile() string

func IsVerbose

func IsVerbose() bool

Types

type CheckResult

type CheckResult struct {
	Name        string      `json:"name"`
	Status      CheckStatus `json:"status"`
	Message     string      `json:"message"`
	Remediation string      `json:"remediation,omitempty"`
	LatencyMS   int64       `json:"latencyMs,omitempty"`
	// contains filtered or unexported fields
}

type CheckStatus

type CheckStatus string

const (
	StatusOK   CheckStatus = "ok"
	StatusWarn CheckStatus = "warn"
	StatusFail CheckStatus = "fail"
)

type Doctor

type Doctor struct {
	// contains filtered or unexported fields
}

func (*Doctor) Run

func (doctor *Doctor) Run() *DoctorReport

type DoctorReport

type DoctorReport struct {
	Version     string        `json:"version"`
	Platform    string        `json:"platform"`
	GeneratedAt time.Time     `json:"generatedAt"`
	Checks      []CheckResult `json:"checks"`
	Summary     string        `json:"summary"`
}

type UpgradeOutcome

type UpgradeOutcome int

UpgradeOutcome enumerates the conclusions runUpgrade can reach about the installed binary versus the latest release. Used by tests to assert branching without rendering full output.

const (
	UpgradeOutcomeUnknown UpgradeOutcome = iota
	UpgradeOutcomeUpToDate
	UpgradeOutcomeAvailable
	UpgradeOutcomeDevBuild
	UpgradeOutcomeNoReleaseInfo
)