Files
moltbot/docs/start/onboarding-overview.md
Blossom c0befdee0b feat(onboard): add custom/local API configuration flow (#11106)
* feat(onboard): add custom/local API configuration flow

* ci: retry macos check

* fix: expand custom API onboarding (#11106) (thanks @MackDing)

* fix: refine custom endpoint detection (#11106) (thanks @MackDing)

* fix: streamline custom endpoint onboarding (#11106) (thanks @MackDing)

* fix: skip model picker for custom endpoint (#11106) (thanks @MackDing)

* fix: avoid allowlist picker for custom endpoint (#11106) (thanks @MackDing)

* Onboard: reuse shared fetch timeout helper (#11106) (thanks @MackDing)

* Onboard: clarify default base URL name (#11106) (thanks @MackDing)

---------

Co-authored-by: OpenClaw Contributor <contributor@openclaw.ai>
Co-authored-by: Gustavo Madeira Santana <gumadeiras@gmail.com>
2026-02-10 07:31:02 -05:00

1.4 KiB

summary, read_when, title, sidebarTitle
summary read_when title sidebarTitle
Overview of OpenClaw onboarding options and flows
Choosing an onboarding path
Setting up a new environment
Onboarding Overview Onboarding Overview

Onboarding Overview

OpenClaw supports multiple onboarding paths depending on where the Gateway runs and how you prefer to configure providers.

Choose your onboarding path

  • CLI wizard for macOS, Linux, and Windows (via WSL2).
  • macOS app for a guided first run on Apple silicon or Intel Macs.

CLI onboarding wizard

Run the wizard in a terminal:

openclaw onboard

Use the CLI wizard when you want full control of the Gateway, workspace, channels, and skills. Docs:

macOS app onboarding

Use the OpenClaw app when you want a fully guided setup on macOS. Docs:

Custom API Endpoint

If you need an endpoint that is not listed, including hosted providers that expose standard OpenAI or Anthropic APIs, choose Custom API Endpoint in the CLI wizard. You will be asked to:

  • Pick OpenAI-compatible, Anthropic-compatible, or Unknown (auto-detect).
  • Enter a base URL and API key (if required by the provider).
  • Provide a model ID and optional alias.
  • Choose an Endpoint ID so multiple custom endpoints can coexist.

For detailed steps, follow the CLI onboarding docs above.