Skip to main content

​
fluffbuzz onboard

Interactive onboarding for local or remote Gateway setup.

​
Examples

For plaintext private-network ws:// targets (trusted networks only), set FLUFFBUZZ_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. LM Studio also supports a provider-specific key flag in non-interactive mode:
Non-interactive Ollama:
--custom-base-url defaults to http://127.0.0.1:11434. --custom-model-id is optional; if omitted, onboarding uses Ollama’s suggested defaults. Cloud model IDs such as kimi-k2.5:cloud also work here. 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.
Gateway token options in non-interactive mode:
  • --gateway-auth token --gateway-token <token> stores a plaintext token.
  • --gateway-auth token --gateway-token-ref-env <name> stores gateway.auth.token as an env SecretRef.
  • --gateway-token and --gateway-token-ref-env are mutually exclusive.
  • --gateway-token-ref-env requires a non-empty env var in the onboarding process environment.
  • With --install-daemon, when token auth requires a token, SecretRef-managed gateway tokens are validated but not persisted as resolved plaintext in supervisor service environment metadata.
  • With --install-daemon, if token mode requires a token and the configured token SecretRef is unresolved, onboarding fails closed with remediation guidance.
  • With --install-daemon, if both gateway.auth.token and gateway.auth.password are configured and gateway.auth.mode is unset, onboarding blocks install until mode is set explicitly.
  • Local onboarding writes gateway.mode="local" into the config. If a later config file is missing gateway.mode, treat that as config damage or an incomplete manual edit, not as a valid local-mode shortcut.
  • --allow-unconfigured is a separate gateway runtime escape hatch. It does not mean onboarding may omit gateway.mode.
Example:
Non-interactive local gateway health:
  • Unless you pass --skip-health, onboarding waits for a reachable local gateway before it exits successfully.
  • --install-daemon starts the managed gateway install path first. Without it, you must already have a local gateway running, for example fluffbuzz gateway run.
  • If you only want config/workspace/bootstrap writes in automation, use --skip-health.
  • On native Windows, --install-daemon tries Scheduled Tasks first and falls back to a per-user Startup-folder login item if task creation is denied.
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.1). 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).
  • When an auth choice implies a preferred provider, onboarding prefilters the default-model and allowlist pickers to that provider. For Volcengine and BytePlus, this also matches the coding-plan variants (volcengine-plan/*, byteplus-plan/*).
  • If the preferred-provider filter yields no loaded models yet, onboarding falls back to the unfiltered catalog instead of leaving the picker empty.
  • In the web-search step, some providers can trigger provider-specific follow-up prompts:
    • Grok can offer optional x_search setup with the same XAI_API_KEY and an x_search model choice.
    • Kimi can ask for the Moonshot API region (api.moonshot.ai vs api.moonshot.cn) and the default Kimi web-search model.
  • Local onboarding DM scope behavior: CLI Setup Reference.
  • Fastest first chat: fluffbuzz 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.

​
Common follow-up commands

--json does not imply non-interactive mode. Use --non-interactive for scripts.