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§
- Applied
Agent - Field
Descriptor - One renderable input the TUI / web modal must draw.
- Quickstart
Error - Quickstart
State - Snapshot of the bits of
Configthe Quickstart UI needs to render each step’s “Use existing” section without pulling the entire config. - Quickstart
Type Option - 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.
kindis the canonical kebab-case identifier written into config;display_nameis the picker label.
Enums§
- Field
Section - 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.
- Quickstart
Step - 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=truemeans surfaces should render a picker;live=falsemeans fall back to free text. TriesModelProvider::list_models_with_pricing()first, then the family catalog table (no pricing for fallbacks). - model_
provider_ is_ local truefor model_provider families that need no remote credential.- record_
dismissed - Record a
dismissedevent 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_stepis optional and names whichever selector the user got furthest with; passNonefor “didn’t progress past the first selector.” - should_
auto_ launch onboard_state.quickstart_completedis false and noagents.*entries exist. Returning users with existing agents never see the auto-trigger even if the flag was never flipped.- snapshot_
state - Build a
QuickstartStatesnapshot from the live config. - validate_
only - validate_
only_ with_ surface