Skip to main content

wednesdayai onboard

Interactive onboarding wizard (local or remote Gateway setup).

Examples

For plaintext private-network ws:// targets (trusted networks only), set OPENCLAW_ALLOW_INSECURE_PRIVATE_WS=1 in the onboarding process environment. Non-interactive custom provider:
--custom-api-key is optional in non-interactive mode. If omitted, onboarding checks CUSTOM_API_KEY. Store provider keys as refs instead of plaintext:
With --secret-input-mode ref, onboarding writes env-backed refs instead of plaintext key values. For auth-profile backed providers this writes keyRef entries; for custom providers this writes models.providers.<id>.apiKey as an env ref (for example { source: "env", provider: "default", id: "CUSTOM_API_KEY" }). Non-interactive ref mode contract:
  • Set the provider env var in the onboarding process environment (for example OPENAI_API_KEY).
  • Do not pass inline key flags (for example --openai-api-key) unless that env var is also set.
  • If an inline key flag is passed without the required env var, onboarding fails fast with guidance.
Interactive onboarding behavior with reference mode:
  • Choose Use secret reference when prompted.
  • Then choose either:
    • Environment variable
    • Configured secret provider (file or exec)
  • Onboarding performs a fast preflight validation before saving the ref.
    • If validation fails, onboarding shows the error and lets you retry.
Non-interactive Z.AI endpoint choices: Note: --auth-choice zai-api-key now auto-detects the best Z.AI endpoint for your key (prefers the general API with zai/glm-5). If you specifically want the GLM Coding Plan endpoints, pick zai-coding-global or zai-coding-cn.
Non-interactive Mistral example:
Flow notes:
  • quickstart: minimal prompts, auto-generates a gateway token.
  • manual: full prompts for port/bind/auth (alias of advanced).
  • Local onboarding DM scope behavior: CLI Onboarding Reference.
  • Fastest first chat: wednesdayai dashboard (Control UI, no channel setup).
  • Custom Provider: connect any OpenAI or Anthropic compatible endpoint, including hosted providers not listed. Use Unknown to auto-detect.

Shell completion

wednesdayai onboard reconciles shell completion for wednesdayai. QuickStart installs completion automatically, while other interactive flows prompt to enable it. It silently upgrades legacy OpenClaw completion blocks and regenerates missing caches (PowerShell requires manual setup). See Shell completion.

Common follow-up commands

--json does not imply non-interactive mode. Use --non-interactive for scripts. With --non-interactive --json, stdout is exactly one JSON summary document; progress lines and log output go to stderr or are dropped.