docs: clarify source control-ui dev/build flow (#68814)

This commit is contained in:
Rubén Cuevas
2026-04-19 02:48:32 -04:00
committed by GitHub
parent 39cb6ecbb9
commit 6d427f8c2a
9 changed files with 43 additions and 14 deletions

View File

@@ -160,7 +160,7 @@ Quick answers plus deeper troubleshooting for real-world setups (local dev, VPS,
cd openclaw
pnpm install
pnpm build
pnpm ui:build # auto-installs UI deps on first run
pnpm ui:build
openclaw onboard
```

View File

@@ -115,7 +115,7 @@ For contributors or anyone who wants to run from a local checkout:
```bash
git clone https://github.com/openclaw/openclaw.git
cd openclaw
pnpm install && pnpm ui:build && pnpm build
pnpm install && pnpm build && pnpm ui:build
pnpm link --global
openclaw onboard --install-daemon
```

View File

@@ -222,15 +222,25 @@ systemctl --user status
### 3) Install OpenClaw (inside WSL)
Follow the Linux Getting Started flow inside WSL:
For a normal first-time setup inside WSL, follow the Linux Getting Started flow:
```bash
git clone https://github.com/openclaw/openclaw.git
cd openclaw
pnpm install
pnpm ui:build # auto-installs UI deps on first run
pnpm build
openclaw onboard
pnpm ui:build
pnpm openclaw onboard --install-daemon
```
If you are developing from source instead of doing first-time onboarding, use the
source dev loop from [Setup](/start/setup):
```bash
pnpm install
# First run only (or after resetting local OpenClaw config/workspace)
pnpm openclaw setup
pnpm gateway:watch
```
Full guide: [Getting Started](/start/getting-started)

View File

@@ -91,16 +91,22 @@ If you also want the macOS app on the bleeding edge:
```bash
pnpm install
# First run only (or after resetting local OpenClaw config/workspace)
pnpm openclaw setup
pnpm gateway:watch
```
`gateway:watch` runs the gateway in watch mode and reloads on relevant source,
config, and bundled-plugin metadata changes.
`pnpm openclaw setup` is the one-time local config/workspace initialization step for a fresh checkout.
`pnpm gateway:watch` does not rebuild `dist/control-ui`, so rerun `pnpm ui:build` after `ui/` changes or use `pnpm ui:dev` while developing the Control UI.
If you are intentionally using the Bun workflow, the equivalent commands are:
```bash
bun install
# First run only (or after resetting local OpenClaw config/workspace)
bun run openclaw setup
bun run gateway:watch
```

View File

@@ -278,7 +278,7 @@ See [Tailscale](/gateway/tailscale) for HTTPS setup guidance.
The Gateway serves static files from `dist/control-ui`. Build them with:
```bash
pnpm ui:build # auto-installs UI deps on first run
pnpm ui:build
```
Optional absolute base (when you want fixed asset URLs):
@@ -290,7 +290,7 @@ OPENCLAW_CONTROL_UI_BASE_PATH=/openclaw/ pnpm ui:build
For local development (separate dev server):
```bash
pnpm ui:dev # auto-installs UI deps on first run
pnpm ui:dev
```
Then point the UI at your Gateway WS URL (e.g. `ws://127.0.0.1:18789`).

View File

@@ -122,5 +122,5 @@ Open:
The Gateway serves static files from `dist/control-ui`. Build them with:
```bash
pnpm ui:build # auto-installs UI deps on first run
pnpm ui:build
```