Skip to main content

Module quickstart

Module quickstart 

Expand description

Quickstart apply path.

Structs§

AppliedAgent
FieldDescriptor
QuickstartError
QuickstartState
QuickstartTypeOption

Enums§

FieldSection
Selector kinds that the Quickstart “field shape” descriptor covers. The TUI / web ask the runtime for the shape, then render inputs dumbly off the response.
QuickstartStep
Surface
Which surface invoked the Quickstart. Stamped on every event in the apply path so SSE/dashboard consumers can filter by origin without parsing message strings.

Functions§

apply
apply_with_surface
field_shape
Return the renderable field shape for a single section + type combination. Walks prop_fields() against a synthetic config with one default-instantiated entry under the requested type, then filters to the per-section “essential” allowlist.
model_catalog
model_catalog_with_config
model_provider_is_local
true for model_provider families that need no remote credential.
record_dismissed
resolve_model_provider_type
Resolve a Quickstart provider-type input to the canonical config family.
should_auto_launch
onboard_state.quickstart_completed is false and no agents.* entries exist. Returning users with existing agents never see the auto-trigger even if the flag was never flipped.
snapshot_state
Build a QuickstartState snapshot from the live config.
validate_only
validate_only_with_surface