Oko/Docs

Command reference

oko onboarding

The first-use journey: the declared screens, this machine's private progress under $XDG_STATE_HOME/oko/onboarding.json (else ~/.local/state), and completion recorded only after Transcript Lake accepted a source and the shared catalogue was brought up to it.

Invocation#

Command
oko onboarding [--source RUNTIME --root DIR | --skip-source] [--reset] [--json]

Inputs and options#

  • --source with --root adopts a source through `oko lake adopt`; --skip-source completes without one; --reset starts the journey over.

Output and state effect#

  • Writes the progress file with owner-only permissions; prints the current screen and status.

Refusals and safe exits#

  • `oko onboarding takes only flags; got <verb>` (exit 2); `--source and --root must be supplied together`; `use either --source/--root or --skip-source`; `invalid bundled journey: <reason>` when the declaration beside the binary does not validate; `<path> cannot be read: <error>`, `<path> cannot be prepared: <error>`; the refusals of `oko lake adopt`.

CLI reference#