doctor

Documentation

Overview

Package doctor runs deterministic health checks over a memcode project — the built-in answer to "is the runtime actually doing what we think?". It exists because this is the question that kept recurring while building: the .memcode self-ignore silently not firing, the key not resolving, the index not built. /doctor (TUI) and `memcode doctor` (CLI) both render these.

Index

• func Render(rs []Result) string
• type Result
  • func Check(ctx context.Context, st store.Store, root string, prov provider.ModelProvider) []Result
• type Status

Functions

func Render

func Render(rs []Result) string

Render formats results as a checklist with a one-line summary.

Types

type Result

type Result struct {
	Name   string
	Status Status
	Detail string
}

Result is one check's outcome with an actionable detail.

func Check

func Check(ctx context.Context, st store.Store, root string, prov provider.ModelProvider) []Result

Check runs the health checks. st may be nil (not initialized); prov may be nil (web check skipped). root is the resolved project root.

type Status

type Status int

Status is a check outcome. Warn = works but worth knowing; Fail = broken + actionable.

const (
	OK Status = iota
	Warn
	Fail
)