provideronboarding

type Action ¶

type Action struct {
	Label   string
	Command string
	Detail  string
}

func MissingCredentialAction(profile config.ProviderProfile) (Action, bool)

func ProviderActions(profile config.ProviderProfile, active bool) []Action

type DetectedLocalRuntime ¶

type DetectedLocalRuntime struct {
	LocalRuntime
	Reachable bool
	Models    []string
}

DetectedLocalRuntime is a LocalRuntime that has been probed. Reachable reports whether its default endpoint answered the probe; Models is the list of model ids the runtime advertised (best-effort, empty when the probe could not parse a model list).

func DetectLocalRuntimes(ctx context.Context, options LocalDetectOptions) []DetectedLocalRuntime

func (runtime DetectedLocalRuntime) SetupAction() Action

type LocalDetectOptions ¶

type LocalDetectOptions struct {
	HTTPClient *http.Client
	Timeout    time.Duration
	Candidates []LocalRuntime
}

LocalDetectOptions configures DetectLocalRuntimes. All fields are optional; the zero value probes the built-in candidates with a short default timeout using http.DefaultClient. Tests inject HTTPClient and Candidates.

type LocalRuntime ¶

type LocalRuntime struct {
	CatalogID    string
	Name         string
	BaseURL      string
	DefaultModel string
	RequiresKey  bool
}

LocalRuntime describes a local, OpenAI-compatible model server that ZERO can adopt with no API key. These are the runtimes the launch audience is most likely to already be running (Ollama, LM Studio), so the first-run wizard auto-detects them on their default ports and offers them with no key step.

func LocalRuntimeCandidates() []LocalRuntime

type ProviderState ¶

type ProviderState struct {
	Profile config.ProviderProfile
	Active  bool
}

func (state ProviderState) Actions() []Action

type SetupProbeClass ¶

type SetupProbeClass string

SetupProbeClass is the stable, machine-readable class of a first-run probe failure. It exists so the wizard can render a specific, fixable remedy instead of a raw stack trace: each class maps to one concrete thing the user changes.

const (
	SetupProbeAuth      SetupProbeClass = "auth"       // bad / missing API key
	SetupProbeEndpoint  SetupProbeClass = "endpoint"   // wrong base URL, unreachable, timeout
	SetupProbeModel     SetupProbeClass = "model"      // model not found at the provider
	SetupProbeRateLimit SetupProbeClass = "rate_limit" // throttled; key works, retry later
	SetupProbeConfig    SetupProbeClass = "config"     // local profile is incomplete
	SetupProbeUnknown   SetupProbeClass = "unknown"    // unclassified provider error
)

type SetupProbeError ¶

type SetupProbeError struct {
	Class   SetupProbeClass
	Message string
	Detail  string
}

SetupProbeError is a classified, user-facing first-run probe failure. It is a value type (not panicking) so a failing probe can be rendered as a single fixable line. Message is the remedy; Detail is the underlying (already secret-scrubbed) provider message for context.

func ClassifySetupProbe(result providerhealth.Result) (SetupProbeError, bool)

func (err SetupProbeError) Error() string