doctor

package

v1.10.5 Latest Latest Go to latest Published: Apr 2, 2026 License: MIT Imports: 12 Imported by: 0

Details

Package doctor provides a diagnostic command that validates configuration, checks environment health, and reports runtime details.

This section is empty.

This section is empty.

func NewCmdDoctor(props *p.Props) *cobra.Command

NewCmdDoctor creates the doctor command.

func PrintReport(w io.Writer, report *DoctorReport)

PrintReport writes a human-readable report to the given writer.

type CheckFunc = setup.CheckFunc

CheckFunc is an alias for the registry's CheckFunc type.

func DefaultChecks() []CheckFunc

DefaultChecks returns the standard set of diagnostic checks.

type CheckResult = setup.CheckResult

CheckResult is an alias for the registry's CheckResult type.

type CheckStatus = string

CheckStatus is the outcome of a diagnostic check.

const (
	CheckPass CheckStatus = "pass"
	CheckWarn CheckStatus = "warn"
	CheckFail CheckStatus = "fail"
	CheckSkip CheckStatus = "skip"
)

type DoctorReport struct {
	Tool    string        `json:"tool"`
	Version string        `json:"version"`
	Checks  []CheckResult `json:"checks"`
}

DoctorReport contains all check results.

func RunChecks(ctx context.Context, props *p.Props) *DoctorReport

RunChecks executes all diagnostic checks and returns a report.