Skip to main content

Module onboard

Module onboard 

Source
Expand description

Onboard orchestrator.

Thin dispatcher above the OnboardUi trait (defined in zeroclaw-config::traits). Section-scoped entry points let callers run just one slice (zeroclaw onboard channels) or the whole flow.

Everything writes through Config::set_prop (or its helpers); direct struct-field assignment is off-limits per the DRY contract.

Modules§

field_visibility
Per-section field visibility helpers.
ui
OnboardUi backends. term is the dialoguer-based terminal UI; quick is the headless, flag-driven backend for scripted/CI runs. The ratatui backend lives in zeroclaw-tui and lands in a later commit.

Structs§

FieldDefault
Per-field default override. When a section knows a sensible default that lives outside the config (e.g. AnthropicModelProvider::default_temperature()), it builds a list of these and passes them to prompt_fields_under. The prompt surfaces the default as ghost-text inside the input box plus a “Default: X. Press Enter to accept.” line in the help blurb, only when the field is unset in cfg.
Flags
Runtime knobs sourced from CLI flags. --quick/--tui select the UI backend at the binary edge and don’t appear here — the orchestrator only cares about per-section behavior.

Enums§

Section
One pickable section. The variant ordering follows the sections! macro invocation.

Functions§

run
Top-level onboard dispatcher. target is the canonical Option<Section> from zeroclaw_runtime::onboard::TargetNone walks the full wizard, Some(s) runs a single section.
section_for_path
First segment of a dotted property path mapped back to the wizard section it lives under, or None for non-wizard paths (onboard_state.completed_sections, etc.).

Type Aliases§

Target
What slice of onboarding the orchestrator should run. None walks the full wizard (every Section in canonical order); Some(s) targets one section. The runtime intentionally has no parallel Section-with-All enum — that was three drift surfaces in one file.