oclaw/docs/OPEN_SOURCE_QUICKSTART.md

Open Source Quickstart (Windows)

This guide is the shortest path for first-time users.

For a Chinese step-by-step “out of the box” checklist (env file, gateway, optional netx), see the repository root README.md → 开箱即用（从零跑起来）.

Prerequisites

• Python 3.11+
• Node.js 22+
• PowerShell (Windows 10/11)

Environment file (recommended)

Copy the template once at repo root:

copy _local\system.env.example _local\system.env

Gateway startup loads _local/system.env. Configure LLM keys here or later in Admin (docs/ENVIRONMENT_VARIABLES.md).

Path A: Web/Admin only (no Weixin/WhatsApp required)

1. Bootstrap Python venv:

powershell -ExecutionPolicy Bypass -File .\scripts\bootstrap_venv.ps1

2. Start full stack in background:

powershell -ExecutionPolicy Bypass -File .\scripts\start_all.ps1 -Background

3. Open:

• Admin: http://127.0.0.1:8787/admin
• Chat: http://127.0.0.1:8787/chat

Notes:

• If Weixin/WhatsApp sidecars are not installed, start_all.ps1 will skip them with a warning and continue.
• This does not block Admin/Chat.

Path B: Enable Weixin (Personal WeChat)

powershell -ExecutionPolicy Bypass -File .\runtime\operations\scripts\weixin_install.ps1
powershell -ExecutionPolicy Bypass -File .\runtime\operations\scripts\weixin_login.ps1
powershell -ExecutionPolicy Bypass -File .\runtime\operations\scripts\weixin_start.ps1

Notes:

• No global openclaw CLI installation is required.
• Runtime dependencies are installed locally in sidecar workspace.
• Login/account state is persisted under data/channel_sidecar/oclaw-weixin/state/.
• The Weixin flow does not rely on %USERPROFILE%\.openclaw.

Path C: Enable WhatsApp (experimental)

powershell -ExecutionPolicy Bypass -File .\runtime\operations\scripts\whatsapp_install.ps1
powershell -ExecutionPolicy Bypass -File .\runtime\operations\scripts\whatsapp_login.ps1
powershell -ExecutionPolicy Bypass -File .\runtime\operations\scripts\whatsapp_start.ps1

Admin dispatch controls (Weixin/WhatsApp)

In Admin:

• Stack page: channel-level controls (Bind specialist / Comprehensive)
• User/Channel binding page: account-level controls per channel/account

Priority:

1. Account-level dispatch config
2. Channel-level dispatch config
3. Default (expert + generalist)

Common commands

Start:

.\scripts\start_all.ps1 -Background

Status:

.\scripts\status_all.ps1

Stop:

.\scripts\stop_all.ps1

Force stop:

.\scripts\stop_all.ps1 -Force