Skip to main content

Module quickstart

Module quickstart 

Source
Expand description

Quickstart apply path.

Single entry point both surfaces (web gateway, zerocode RPC, CLI) call to land a BuilderSubmission into the live Config. The runtime never enumerates channel types, provider types, or storage backends itself — every write goes through Config::set_prop_persistent, which dispatches through the schema-derived Configurable tree. Adding a new channel / provider / storage backend to the schema lights up in the Quickstart for free.

Structs§

AppliedAgent
FieldDescriptor
One renderable input the TUI / web modal must draw.
QuickstartError
QuickstartState
Snapshot of the bits of Config the Quickstart UI needs to render each step’s “Use existing” section without pulling the entire config.
QuickstartTypeOption
One row in the Quickstart “Create new …” picker, sourced from a schema- or registry-level inventory so neither the TUI nor the web surface needs its own list. kind is the canonical kebab-case identifier written into config; display_name is the picker label.

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
Live model catalog for a provider type. (models, pricing, live): live=true means surfaces should render a picker; live=false means fall back to free text. Tries ModelProvider::list_models_with_pricing() first, then the family catalog table (no pricing for fallbacks).
model_provider_is_local
true for model_provider families that need no remote credential.
record_dismissed
Record a dismissed event for a run that exited without a Create. Surfaces call this when the user closes the Quickstart page / leaves the modal stack before submitting. last_step is optional and names whichever selector the user got furthest with; pass None for “didn’t progress past the first selector.”
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