Skip to content

Getting Started with openclaw onboard

I hate spending hours on configuration before I even see a “Hello World.” Setting up a new environment usually involves digging through environment variables and port settings. It is much better when a tool just asks what I need and does the heavy lifting for me.

Setting up your Gateway shouldn’t be a chore. The openclaw onboard command is an interactive wizard that handles the initial setup so you can get to work faster.

  • The OpenClaw CLI installed
  • A remote Gateway URL (if you are not running locally)

If you want the fastest path to a working setup, I recommend the quickstart flow. It uses minimal prompts and automatically generates your gateway token.

Terminal window
openclaw onboard --flow quickstart

If you need control over specific settings like ports, binding, or authentication, use the manual flow instead. This is an alias for the advanced setup.

Terminal window
openclaw onboard --flow manual

To connect to a Gateway hosted elsewhere, use the remote mode. You will need to provide the WebSocket URL for your host.

Terminal window
openclaw onboard --mode remote --remote-url ws://gateway-host:18789

If you don’t need to set up a channel right now and just want to see the Control UI, you can skip the onboarding wizard and run the dashboard directly.

Terminal window
openclaw dashboard

A common mistake is assuming that the --json flag makes the command script-friendly. It does not. If you are running this in a CI/CD environment or a shell script, you must use the --non-interactive flag.

  • Problem: The command hangs or asks for input in a script even with --json.
  • Solution: Add the --non-interactive flag to bypass the interactive prompts.

Once you have finished the onboarding, you can start adding agents or fine-tuning your configuration:

If you run into any other issues, check out the AI Setup Assistant.

OpenClaw

OpenClaw Expert

Still stuck?

If this page didn't answer your case, ask OpenClaw Expert for step-by-step guidance.