7bbd09047b
* docs: simplify macOS app docs * docs: preserve macOS app detail links * docs: address macOS review feedback
5.1 KiB
summary, read_when, title
| summary | read_when | title | |||
|---|---|---|---|---|---|
| Install and use the OpenClaw macOS menu bar app |
|
macOS app |
The macOS app is the OpenClaw menu bar companion. Use it when you want a
native tray UI, macOS permission prompts, notifications, WebChat, voice input,
Canvas, or Mac-hosted node tools such as system.run.
If you only need the CLI and Gateway, start with Getting started.
Download
Download macOS app builds from the OpenClaw GitHub releases. When a release includes macOS app assets, look for:
OpenClaw-<version>.dmg(preferred)OpenClaw-<version>.zip
Some releases only include CLI, evidence, or Windows assets. If the newest release has no macOS app asset, use the newest release that does, or build the app from source with macOS dev setup.
First run
- Install and launch OpenClaw.app.
- Complete the macOS permission checklist.
- Pick Local or Remote mode.
- Install the
openclawCLI if the app asks for it. - Open WebChat from the menu bar and send a test message.
For the CLI/Gateway setup path, use Getting started. For permission recovery, use macOS permissions.
Choose a Gateway mode
| Mode | Use it when | Detail page |
|---|---|---|
| Local | This Mac should run the Gateway and keep it alive with launchd. | Gateway on macOS |
| Remote | Another host runs the Gateway and this Mac should control it over SSH, LAN, or Tailnet. | Remote control |
Local mode requires an installed openclaw CLI. The app can install it, or you
can follow Gateway on macOS.
What the app owns
- Menu bar status, notifications, health, and WebChat.
- macOS permission prompts for screen, microphone, speech, automation, and accessibility.
- Local node tools such as Canvas, camera/screen capture, notifications, and
system.run. - Exec approval prompts for Mac-hosted commands.
- Remote-mode SSH tunnels or direct Gateway connections.
The app does not replace the OpenClaw Gateway or general CLI docs. Core Gateway configuration, providers, plugins, channels, tools, and security live in their own docs.
macOS detail pages
| Task | Read |
|---|---|
| Install or debug the CLI/Gateway service | Gateway on macOS |
| Keep state out of cloud-synced folders | Gateway on macOS |
| Debug app discovery and connectivity | Gateway on macOS |
| Understand launchd behavior | Gateway lifecycle |
| Fix permissions or signing/TCC issues | macOS permissions |
| Connect to a remote Gateway | Remote control |
| Read menu bar status and health checks | Menu bar, Health checks |
| Use the embedded chat UI | WebChat |
| Use voice wake or push-to-talk | Voice wake |
| Use Canvas and Canvas deep links | Canvas |
| Host PeekabooBridge for UI automation | Peekaboo bridge |
| Configure command approvals | Exec approvals, advanced details |
| Inspect Mac node commands and app IPC | macOS IPC |
| Capture logs | macOS logging |
| Build from source | macOS dev setup |