Module quickstart 

Quickstart apply path.

Structs

AppliedAgent

FieldDescriptor

QuickstartError

QuickstartState

QuickstartTypeOption

StagedQuickstartApply

One staged quickstart application: a validated, mutated working config plus its personality temp files, ready for the irreversible persist-and-publish phase. Created by stage_apply; completed either as a one-shot (complete_staged_apply, for private-config callers like the CLI) or as an admitted config commit (complete_staged_apply_as_commit, for the supervised transports).

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.

QuickstartApplyOutcome

Terminal outcome of one quickstart application.

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

One-shot quickstart application for callers that own a private Config with no supervised publication domain (the CLI). Persists the staged config and installs the personality files; there is no live publication to make, so a post-commit side-effect failure is reported without any publication semantics.

apply_with_surface_checked

One-shot application with a policy compile check before persistence.

complete_staged_apply

Persist one staged quickstart and install its personality files without a publication domain. A persistence failure returns with nothing committed; a personality failure returns QuickstartApplyOutcome::CommittedWithSideEffectErrors because the config is already on disk.

complete_staged_apply_as_commit

Complete one staged quickstart as an admitted, serialized config commit: persist the staged config, publish it under revision (the caller allocated it before any irreversible I/O), then move the staged personality files into place.

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

Backward-compatible catalog projection for callers that intentionally treat discovery failure as an unavailable catalog. Configured-profile surfaces should call model_catalog_with_config_result to preserve actionable errors.

model_catalog_with_config_result

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.

stage_apply

Validate one submission and stage it onto a working config clone: every mutation (provider, presets, channels, peer groups, agent, completion flag) plus personality-file staging to tempfiles. No irreversible work happens here — a rejected submission returns with nothing on disk changed, and dropping the returned staging (or never completing it) cleans up its temp files.

stage_apply_checked

Compile the staged authorization policy before any persistent write.

validate_only

validate_only_with_surface