docs: refresh bun install and onboarding references

This commit is contained in:
Peter Steinberger 2026-04-04 11:19:11 +01:00
parent 5779831723
commit 7807e1ef05
No known key found for this signature in database
5 changed files with 27 additions and 8 deletions

View File

@ -63,7 +63,7 @@ curl -fsSL https://openclaw.ai/install-cli.sh | bash
It supports npm installs by default, plus git-checkout installs under the same
prefix flow. Full reference: [Installer internals](/install/installer#install-clish).
### npm or pnpm
### npm, pnpm, or bun
If you already manage Node yourself:
@ -86,6 +86,17 @@ If you already manage Node yourself:
</Note>
</Tab>
<Tab title="bun">
```bash
bun add -g openclaw@latest
openclaw onboard --install-daemon
```
<Note>
Bun is supported for the global CLI install path. For the Gateway runtime, Node remains the recommended daemon runtime.
</Note>
</Tab>
</Tabs>
<Accordion title="Troubleshooting: sharp build errors (npm)">

View File

@ -21,7 +21,7 @@ capabilities to the agent as a node.
- Exposes macOSonly tools (Canvas, Camera, Screen Recording, `system.run`).
- Starts the local node host service in **remote** mode (launchd), and stops it in **local** mode.
- Optionally hosts **PeekabooBridge** for UI automation.
- Installs the global CLI (`openclaw`) via npm/pnpm on request (bun not recommended for the Gateway runtime).
- Installs the global CLI (`openclaw`) on request via npm, pnpm, or bun (the app prefers npm, then pnpm, then bun; Node remains the recommended Gateway runtime).
## Local vs remote mode

View File

@ -79,8 +79,9 @@ Onboarding requests TCC permissions needed for:
</Step>
<Step title="CLI">
<Info>This step is optional</Info>
The app can install the global `openclaw` CLI via npm/pnpm so terminal
workflows and launchd tasks work out of the box.
The app can install the global `openclaw` CLI via npm, pnpm, or bun.
It prefers npm first, then pnpm, then bun if that is the only detected
package manager. For the Gateway runtime, Node remains the recommended path.
</Step>
<Step title="Onboarding Chat (dedicated session)">
After setup, the app opens a dedicated onboarding chat session so the agent can

View File

@ -22,7 +22,7 @@ For onboarding details, see [Onboarding (CLI)](/start/wizard).
## Prereqs (from source)
- Node 24 recommended (Node 22 LTS, currently `22.14+`, still supported)
- `pnpm`
- `pnpm` preferred (or Bun if you intentionally use the [Bun workflow](/install/bun))
- Docker (optional; only for containerized setup/e2e — see [Docker](/install/docker))
## Tailoring strategy (so updates do not hurt)
@ -44,7 +44,7 @@ From inside this repo, use the local CLI entry:
openclaw setup
```
If you dont have a global install yet, run it via `pnpm openclaw setup`.
If you dont have a global install yet, run it via `pnpm openclaw setup` (or `bun run openclaw setup` if you are using the Bun workflow).
## Run the Gateway from this repo
@ -97,6 +97,13 @@ pnpm gateway:watch
`gateway:watch` runs the gateway in watch mode and reloads on relevant source,
config, and bundled-plugin metadata changes.
If you are intentionally using the Bun workflow, the equivalent commands are:
```bash
bun install
bun run gateway:watch
```
### 2) Point the macOS app at your running Gateway
In **OpenClaw.app**:
@ -141,7 +148,7 @@ Use this when debugging auth or deciding what to back up:
## Updating (without wrecking your setup)
- Keep `~/.openclaw/workspace` and `~/.openclaw/` as “your stuff”; dont put personal prompts/config into the `openclaw` repo.
- Updating source: `git pull` + `pnpm install` (when lockfile changed) + keep using `pnpm gateway:watch`.
- Updating source: `git pull` + your chosen package-manager install step (`pnpm install` by default; `bun install` for Bun workflow) + keep using the matching `gateway:watch` command.
## Linux (systemd user service)

View File

@ -90,7 +90,7 @@ It does not install or modify anything on the remote host.
</Step>
<Step title="Skills">
- Reads available skills and checks requirements.
- Lets you choose node manager: npm or pnpm (bun not recommended).
- Lets you choose node manager: npm, pnpm, or bun.
- Installs optional dependencies (some use Homebrew on macOS).
</Step>
<Step title="Finish">