Vendor OpenClaw source as Adolf fork baseline
Some checks failed
ClawSweeper Dispatch / dispatch (push) Has been cancelled
CodeQL / Security High (actions) (push) Has been cancelled
CodeQL / Security High (channel-runtime-boundary) (push) Has been cancelled
CodeQL / Security High (core-auth-secrets) (push) Has been cancelled
CodeQL / Security High (mcp-process-tool-boundary) (push) Has been cancelled
CodeQL / Security High (network-ssrf-boundary) (push) Has been cancelled
CodeQL / Security High (plugin-trust-boundary) (push) Has been cancelled
CodeQL / Security High (process-exec-boundary) (push) Has been cancelled
Docs Sync Publish Repo / sync-publish-repo (push) Has been cancelled
Docs / docs (push) Has been cancelled
OpenClaw Stable Main Closeout / Resolve stable release closeout inputs (push) Has been cancelled
OpenClaw Stable Main Closeout / Verify stable main closeout (push) Has been cancelled
Workflow Sanity / no-tabs (push) Has been cancelled
Workflow Sanity / actionlint (push) Has been cancelled
Workflow Sanity / generated-doc-baselines (push) Has been cancelled
CI / runner-admission (push) Has been cancelled
CI / preflight (push) Has been cancelled
CI / security-fast (push) Has been cancelled
CI / pnpm-store-warmup (push) Has been cancelled
CI / build-artifacts (push) Has been cancelled
CI / native-i18n (push) Has been cancelled
CI / ${{ matrix.check_name }} (push) Has been cancelled
CI / ${{ matrix.checkName }} (push) Has been cancelled
CI / checks-node-compat-node22 (push) Has been cancelled
CI / check-bundled-channel-config-metadata (push) Has been cancelled
CI / check-dependencies (push) Has been cancelled
CI / check-guards (push) Has been cancelled
CI / check-lint (push) Has been cancelled
CI / check-prod-types (push) Has been cancelled
CI / check-shrinkwrap (push) Has been cancelled
CI / check-test-types (push) Has been cancelled
CI / check-additional-boundaries-a (push) Has been cancelled
CI / check-additional-boundaries-bcd (push) Has been cancelled
CI / check-additional-extension-bundled (push) Has been cancelled
CI / check-additional-extension-channels (push) Has been cancelled
CI / check-additional-extension-package-boundary (push) Has been cancelled
CI / check-additional-runtime-topology-architecture (push) Has been cancelled
CI / check-session-accessor-boundary (push) Has been cancelled
CI / check-session-transcript-reader-boundary (push) Has been cancelled
CI / check-docs (push) Has been cancelled
CI / skills-python (push) Has been cancelled
CI / macos-swift (push) Has been cancelled
CI / ios-build (push) Has been cancelled
CI / ci-timings-summary (push) Has been cancelled
Native App Locale Refresh / Refresh native fa (push) Has been cancelled
Native App Locale Refresh / Refresh native fr (push) Has been cancelled
Native App Locale Refresh / Refresh native hi (push) Has been cancelled
Native App Locale Refresh / Refresh native id (push) Has been cancelled
Native App Locale Refresh / Refresh native it (push) Has been cancelled
Native App Locale Refresh / Refresh native ja-JP (push) Has been cancelled
Control UI Locale Refresh / plan (push) Has been cancelled
Control UI Locale Refresh / Refresh ${{ matrix.locale }} (push) Has been cancelled
Control UI Locale Refresh / Commit control UI locale refresh (push) Has been cancelled
Live Media Runner Image / Build live media runner image (push) Has been cancelled
Native App Locale Refresh / Refresh native ar (push) Has been cancelled
Native App Locale Refresh / Refresh native de (push) Has been cancelled
Native App Locale Refresh / Refresh native es (push) Has been cancelled
Native App Locale Refresh / Refresh native ko (push) Has been cancelled
Native App Locale Refresh / Refresh native nl (push) Has been cancelled
Native App Locale Refresh / Refresh native pl (push) Has been cancelled
Native App Locale Refresh / Refresh native pt-BR (push) Has been cancelled
Native App Locale Refresh / Refresh native ru (push) Has been cancelled
Native App Locale Refresh / Refresh native sv (push) Has been cancelled
Native App Locale Refresh / Refresh native th (push) Has been cancelled
Native App Locale Refresh / Refresh native tr (push) Has been cancelled
Native App Locale Refresh / Refresh native uk (push) Has been cancelled
Native App Locale Refresh / Refresh native vi (push) Has been cancelled
Native App Locale Refresh / Refresh native zh-CN (push) Has been cancelled
Native App Locale Refresh / Refresh native zh-TW (push) Has been cancelled
Native App Locale Refresh / Commit native locale refresh (push) Has been cancelled
Plugin Init Scaffold Validation / Validate provider scaffold (push) Has been cancelled
Plugin NPM Release / preview_plugins_npm (push) Has been cancelled
Plugin NPM Release / Validate release publish approval (push) Has been cancelled
Plugin NPM Release / preview_plugin_pack (push) Has been cancelled
Plugin NPM Release / publish_plugins_npm (push) Has been cancelled
Sandbox Common Smoke / sandbox-common-smoke (push) Has been cancelled
Website Installer Sync / static (push) Has been cancelled
Website Installer Sync / linux-docker (push) Has been cancelled
Website Installer Sync / macos-installer (push) Has been cancelled
Website Installer Sync / windows-installer (push) Has been cancelled
Website Installer Sync / sync-website (push) Has been cancelled
Some checks failed
ClawSweeper Dispatch / dispatch (push) Has been cancelled
CodeQL / Security High (actions) (push) Has been cancelled
CodeQL / Security High (channel-runtime-boundary) (push) Has been cancelled
CodeQL / Security High (core-auth-secrets) (push) Has been cancelled
CodeQL / Security High (mcp-process-tool-boundary) (push) Has been cancelled
CodeQL / Security High (network-ssrf-boundary) (push) Has been cancelled
CodeQL / Security High (plugin-trust-boundary) (push) Has been cancelled
CodeQL / Security High (process-exec-boundary) (push) Has been cancelled
Docs Sync Publish Repo / sync-publish-repo (push) Has been cancelled
Docs / docs (push) Has been cancelled
OpenClaw Stable Main Closeout / Resolve stable release closeout inputs (push) Has been cancelled
OpenClaw Stable Main Closeout / Verify stable main closeout (push) Has been cancelled
Workflow Sanity / no-tabs (push) Has been cancelled
Workflow Sanity / actionlint (push) Has been cancelled
Workflow Sanity / generated-doc-baselines (push) Has been cancelled
CI / runner-admission (push) Has been cancelled
CI / preflight (push) Has been cancelled
CI / security-fast (push) Has been cancelled
CI / pnpm-store-warmup (push) Has been cancelled
CI / build-artifacts (push) Has been cancelled
CI / native-i18n (push) Has been cancelled
CI / ${{ matrix.check_name }} (push) Has been cancelled
CI / ${{ matrix.checkName }} (push) Has been cancelled
CI / checks-node-compat-node22 (push) Has been cancelled
CI / check-bundled-channel-config-metadata (push) Has been cancelled
CI / check-dependencies (push) Has been cancelled
CI / check-guards (push) Has been cancelled
CI / check-lint (push) Has been cancelled
CI / check-prod-types (push) Has been cancelled
CI / check-shrinkwrap (push) Has been cancelled
CI / check-test-types (push) Has been cancelled
CI / check-additional-boundaries-a (push) Has been cancelled
CI / check-additional-boundaries-bcd (push) Has been cancelled
CI / check-additional-extension-bundled (push) Has been cancelled
CI / check-additional-extension-channels (push) Has been cancelled
CI / check-additional-extension-package-boundary (push) Has been cancelled
CI / check-additional-runtime-topology-architecture (push) Has been cancelled
CI / check-session-accessor-boundary (push) Has been cancelled
CI / check-session-transcript-reader-boundary (push) Has been cancelled
CI / check-docs (push) Has been cancelled
CI / skills-python (push) Has been cancelled
CI / macos-swift (push) Has been cancelled
CI / ios-build (push) Has been cancelled
CI / ci-timings-summary (push) Has been cancelled
Native App Locale Refresh / Refresh native fa (push) Has been cancelled
Native App Locale Refresh / Refresh native fr (push) Has been cancelled
Native App Locale Refresh / Refresh native hi (push) Has been cancelled
Native App Locale Refresh / Refresh native id (push) Has been cancelled
Native App Locale Refresh / Refresh native it (push) Has been cancelled
Native App Locale Refresh / Refresh native ja-JP (push) Has been cancelled
Control UI Locale Refresh / plan (push) Has been cancelled
Control UI Locale Refresh / Refresh ${{ matrix.locale }} (push) Has been cancelled
Control UI Locale Refresh / Commit control UI locale refresh (push) Has been cancelled
Live Media Runner Image / Build live media runner image (push) Has been cancelled
Native App Locale Refresh / Refresh native ar (push) Has been cancelled
Native App Locale Refresh / Refresh native de (push) Has been cancelled
Native App Locale Refresh / Refresh native es (push) Has been cancelled
Native App Locale Refresh / Refresh native ko (push) Has been cancelled
Native App Locale Refresh / Refresh native nl (push) Has been cancelled
Native App Locale Refresh / Refresh native pl (push) Has been cancelled
Native App Locale Refresh / Refresh native pt-BR (push) Has been cancelled
Native App Locale Refresh / Refresh native ru (push) Has been cancelled
Native App Locale Refresh / Refresh native sv (push) Has been cancelled
Native App Locale Refresh / Refresh native th (push) Has been cancelled
Native App Locale Refresh / Refresh native tr (push) Has been cancelled
Native App Locale Refresh / Refresh native uk (push) Has been cancelled
Native App Locale Refresh / Refresh native vi (push) Has been cancelled
Native App Locale Refresh / Refresh native zh-CN (push) Has been cancelled
Native App Locale Refresh / Refresh native zh-TW (push) Has been cancelled
Native App Locale Refresh / Commit native locale refresh (push) Has been cancelled
Plugin Init Scaffold Validation / Validate provider scaffold (push) Has been cancelled
Plugin NPM Release / preview_plugins_npm (push) Has been cancelled
Plugin NPM Release / Validate release publish approval (push) Has been cancelled
Plugin NPM Release / preview_plugin_pack (push) Has been cancelled
Plugin NPM Release / publish_plugins_npm (push) Has been cancelled
Sandbox Common Smoke / sandbox-common-smoke (push) Has been cancelled
Website Installer Sync / static (push) Has been cancelled
Website Installer Sync / linux-docker (push) Has been cancelled
Website Installer Sync / macos-installer (push) Has been cancelled
Website Installer Sync / windows-installer (push) Has been cancelled
Website Installer Sync / sync-website (push) Has been cancelled
Adolf is a fork/vendored clone of github.com/openclaw/openclaw (v2026.6.11), free to diverge. Tree copied sans upstream .git; upstream remote added for future syncs. Node pinned to 24 (.nvmrc); engines already require >=22.19. Preserves docs/ARCHITECTURE.md. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01LeqyaxJF2nbRXJtae2kNB2
This commit is contained in:
120
docs/platforms/mac/bundled-gateway.md
Normal file
120
docs/platforms/mac/bundled-gateway.md
Normal file
@@ -0,0 +1,120 @@
|
||||
---
|
||||
summary: "Gateway runtime on macOS (external launchd service)"
|
||||
read_when:
|
||||
- Packaging OpenClaw.app
|
||||
- Debugging the macOS gateway launchd service
|
||||
- Installing the gateway CLI for macOS
|
||||
title: "Gateway on macOS"
|
||||
---
|
||||
|
||||
OpenClaw.app does not bundle Node/Bun or the Gateway runtime. The macOS app
|
||||
expects an **external** `openclaw` CLI install, does not spawn the Gateway as
|
||||
a child process, and manages a per-user launchd service to keep the Gateway
|
||||
running (or attaches to an already-running local Gateway).
|
||||
|
||||
## Automatic setup
|
||||
|
||||
On a fresh Mac, choose **This Mac** during onboarding. The app runs its
|
||||
signed, bundled installer script before the Gateway wizard: it installs a
|
||||
user-space Node runtime and the matching `openclaw` CLI under `~/.openclaw`,
|
||||
then installs and starts the per-user launchd service. This path needs no
|
||||
Terminal, Homebrew, or administrator access.
|
||||
|
||||
The app bundles the installer script only, not the Node or Gateway payload;
|
||||
setup needs an internet connection to download the runtime and matching
|
||||
OpenClaw package.
|
||||
|
||||
## Manual recovery
|
||||
|
||||
Node 24 is recommended for a manual install; Node 22.19+ also works. Install
|
||||
`openclaw` globally:
|
||||
|
||||
```bash
|
||||
npm install -g openclaw@<version>
|
||||
```
|
||||
|
||||
Use **Retry setup** after a failed automatic setup. If that still fails,
|
||||
install the CLI manually with the command above, then choose **Check again**
|
||||
in onboarding.
|
||||
|
||||
## Launchd (Gateway as LaunchAgent)
|
||||
|
||||
Label: `ai.openclaw.gateway` (default profile), or `ai.openclaw.<profile>`
|
||||
for a named profile.
|
||||
|
||||
Plist location (per-user): `~/Library/LaunchAgents/ai.openclaw.gateway.plist`
|
||||
(or `ai.openclaw.<profile>.plist`).
|
||||
|
||||
The macOS app owns LaunchAgent install/update for the default profile in
|
||||
Local mode. The CLI can also install it directly: `openclaw gateway install`
|
||||
(named profiles are selected via the `OPENCLAW_PROFILE` env var).
|
||||
|
||||
Behavior:
|
||||
|
||||
- "OpenClaw Active" enables/disables the LaunchAgent.
|
||||
- Quitting the app does **not** stop the Gateway (launchd keeps it alive).
|
||||
- If a Gateway is already running on the configured port, the app attaches to
|
||||
it instead of starting a new one.
|
||||
|
||||
Logging:
|
||||
|
||||
- launchd stdout: `~/Library/Logs/openclaw/gateway.log` (profiles use
|
||||
`gateway-<profile>.log`)
|
||||
- launchd stderr: suppressed
|
||||
|
||||
## Version compatibility
|
||||
|
||||
The macOS app checks the Gateway version against its own version. Onboarding
|
||||
automatically runs managed setup when an existing CLI is missing or
|
||||
incompatible. Use **Retry setup** to repeat installation, or **Check again**
|
||||
after repairing an external CLI.
|
||||
|
||||
## State directory on macOS
|
||||
|
||||
Keep OpenClaw state on a local, non-synced disk. Avoid iCloud Drive and other
|
||||
cloud-synced folders; sync latency and file locks can affect sessions,
|
||||
credentials, and Gateway state.
|
||||
|
||||
Set `OPENCLAW_STATE_DIR` to a local path only when you need an override.
|
||||
`openclaw doctor` warns about common cloud-synced state paths and recommends
|
||||
moving back to local storage. See
|
||||
[environment variables](/help/environment#path-related-env-vars) and
|
||||
[Doctor](/gateway/doctor).
|
||||
|
||||
## Debug app connectivity
|
||||
|
||||
Use the macOS debug CLI from a source checkout to exercise the same Gateway
|
||||
WebSocket handshake and discovery logic the app uses:
|
||||
|
||||
```bash
|
||||
cd apps/macos
|
||||
swift run openclaw-mac connect --json
|
||||
swift run openclaw-mac discover --timeout 3000 --json
|
||||
```
|
||||
|
||||
`connect` accepts `--url`, `--token`, `--timeout`, `--probe`, and `--json`
|
||||
(plus client-identity overrides; run with `--help` for the full list).
|
||||
`discover` accepts `--timeout`, `--json`, and `--include-local`. Compare
|
||||
discovery output with `openclaw gateway discover --json` when you need to
|
||||
separate CLI discovery from app-side connection issues.
|
||||
|
||||
## Smoke check
|
||||
|
||||
```bash
|
||||
openclaw --version
|
||||
|
||||
OPENCLAW_SKIP_CHANNELS=1 \
|
||||
OPENCLAW_SKIP_CANVAS_HOST=1 \
|
||||
openclaw gateway --port 18999 --bind loopback
|
||||
```
|
||||
|
||||
Then:
|
||||
|
||||
```bash
|
||||
openclaw gateway call health --url ws://127.0.0.1:18999 --timeout 3000
|
||||
```
|
||||
|
||||
## Related
|
||||
|
||||
- [macOS app](/platforms/macos)
|
||||
- [Gateway runbook](/gateway)
|
||||
116
docs/platforms/mac/canvas.md
Normal file
116
docs/platforms/mac/canvas.md
Normal file
@@ -0,0 +1,116 @@
|
||||
---
|
||||
summary: "Agent-controlled Canvas panel embedded via WKWebView + custom URL scheme"
|
||||
read_when:
|
||||
- Implementing the macOS Canvas panel
|
||||
- Adding agent controls for visual workspace
|
||||
- Debugging WKWebView canvas loads
|
||||
title: "Canvas"
|
||||
---
|
||||
|
||||
The macOS app embeds an agent-controlled **Canvas panel** using `WKWebView`, a
|
||||
lightweight visual workspace for HTML/CSS/JS, A2UI, and small interactive UI
|
||||
surfaces.
|
||||
|
||||
## Where Canvas lives
|
||||
|
||||
Canvas state is stored under Application Support:
|
||||
|
||||
- `~/Library/Application Support/OpenClaw/canvas/<session>/...`
|
||||
|
||||
The Canvas panel serves those files via a custom URL scheme,
|
||||
`openclaw-canvas://<session>/<path>`:
|
||||
|
||||
- `openclaw-canvas://main/` -> `<canvasRoot>/main/index.html`
|
||||
- `openclaw-canvas://main/assets/app.css` -> `<canvasRoot>/main/assets/app.css`
|
||||
- `openclaw-canvas://main/widgets/todo/` -> `<canvasRoot>/main/widgets/todo/index.html`
|
||||
|
||||
If no `index.html` exists at the root, the app shows a built-in scaffold page.
|
||||
|
||||
## Panel behavior
|
||||
|
||||
- Borderless, resizable panel anchored near the menu bar (or mouse cursor).
|
||||
- Remembers size/position per session.
|
||||
- Auto-reloads when local canvas files change.
|
||||
- Only one Canvas panel is visible at a time (session switches as needed).
|
||||
|
||||
Canvas can be disabled from Settings -> **Allow Canvas**. When disabled,
|
||||
canvas node commands return `CANVAS_DISABLED`.
|
||||
|
||||
## Agent API surface
|
||||
|
||||
Canvas is exposed via the Gateway WebSocket, so the agent can show/hide the
|
||||
panel, navigate to a path or URL, evaluate JavaScript, and capture a
|
||||
snapshot image:
|
||||
|
||||
```bash
|
||||
openclaw nodes canvas present --node <id>
|
||||
openclaw nodes canvas navigate --node <id> --url "/"
|
||||
openclaw nodes canvas eval --node <id> --js "document.title"
|
||||
openclaw nodes canvas snapshot --node <id>
|
||||
```
|
||||
|
||||
`canvas.navigate` accepts local canvas paths, `http(s)` URLs, and `file://`
|
||||
URLs. Passing `"/"` shows the local scaffold or `index.html`.
|
||||
|
||||
## A2UI in Canvas
|
||||
|
||||
A2UI is hosted by the Gateway canvas host and rendered inside the Canvas
|
||||
panel. When the Gateway advertises a Canvas host, the macOS app auto-navigates
|
||||
to the A2UI host page on first open.
|
||||
|
||||
Default A2UI host URL: `http://<gateway-host>:18789/__openclaw__/a2ui/`
|
||||
|
||||
### A2UI commands (v0.8)
|
||||
|
||||
Canvas accepts A2UI v0.8 server-to-client messages: `beginRendering`,
|
||||
`surfaceUpdate`, `dataModelUpdate`, `deleteSurface`. `createSurface` (v0.9) is
|
||||
not supported yet.
|
||||
|
||||
```bash
|
||||
cat > /tmp/a2ui-v0.8.jsonl <<'EOFA2'
|
||||
{"surfaceUpdate":{"surfaceId":"main","components":[{"id":"root","component":{"Column":{"children":{"explicitList":["title","content"]}}}},{"id":"title","component":{"Text":{"text":{"literalString":"Canvas (A2UI v0.8)"},"usageHint":"h1"}}},{"id":"content","component":{"Text":{"text":{"literalString":"If you can read this, A2UI push works."},"usageHint":"body"}}}]}}
|
||||
{"beginRendering":{"surfaceId":"main","root":"root"}}
|
||||
EOFA2
|
||||
|
||||
openclaw nodes canvas a2ui push --jsonl /tmp/a2ui-v0.8.jsonl --node <id>
|
||||
```
|
||||
|
||||
Quick smoke test:
|
||||
|
||||
```bash
|
||||
openclaw nodes canvas a2ui push --node <id> --text "Hello from A2UI"
|
||||
```
|
||||
|
||||
## Triggering agent runs from Canvas
|
||||
|
||||
Canvas can trigger new agent runs via `openclaw://agent?...` deep links:
|
||||
|
||||
```js
|
||||
window.location.href = "openclaw://agent?message=Review%20this%20design";
|
||||
```
|
||||
|
||||
Supported query parameters:
|
||||
|
||||
| Parameter | Meaning |
|
||||
| -------------------------- | ----------------------------------------------------- |
|
||||
| `message` | Prefilled agent prompt. |
|
||||
| `sessionKey` | Stable session identifier. |
|
||||
| `thinking` | Optional thinking profile. |
|
||||
| `deliver`, `to`, `channel` | Delivery target. |
|
||||
| `timeoutSeconds` | Optional run timeout. |
|
||||
| `key` | App-generated safety token for trusted local callers. |
|
||||
|
||||
The app prompts for confirmation unless a valid key is provided. Unkeyed
|
||||
links show the message and URL before approval, and ignore delivery routing
|
||||
fields; keyed links use the normal Gateway run path.
|
||||
|
||||
## Security notes
|
||||
|
||||
- Canvas scheme blocks directory traversal; files must live under the session root.
|
||||
- Local Canvas content uses a custom scheme (no loopback server required).
|
||||
- External `http(s)` URLs are allowed only when explicitly navigated.
|
||||
|
||||
## Related
|
||||
|
||||
- [macOS app](/platforms/macos)
|
||||
- [WebChat](/web/webchat)
|
||||
72
docs/platforms/mac/child-process.md
Normal file
72
docs/platforms/mac/child-process.md
Normal file
@@ -0,0 +1,72 @@
|
||||
---
|
||||
summary: "Gateway lifecycle on macOS (launchd)"
|
||||
read_when:
|
||||
- Integrating the mac app with the gateway lifecycle
|
||||
title: "Gateway lifecycle on macOS"
|
||||
---
|
||||
|
||||
The macOS app manages the Gateway via **launchd** by default and does not
|
||||
spawn the Gateway as a child process. It first tries to attach to an
|
||||
already-running Gateway on the configured port; if none is reachable, it
|
||||
enables the launchd service via the external `openclaw` CLI (no embedded
|
||||
runtime). This gives reliable auto-start at login and restart on crashes.
|
||||
|
||||
Child-process mode (Gateway spawned directly by the app) is **not in use**
|
||||
today. If you need tighter coupling to the UI, run the Gateway manually in a
|
||||
terminal.
|
||||
|
||||
## Default behavior (launchd)
|
||||
|
||||
- The app installs a per-user LaunchAgent labeled `ai.openclaw.gateway` (or
|
||||
`ai.openclaw.<profile>` when using `--profile`/`OPENCLAW_PROFILE`).
|
||||
- When Local mode is enabled, the app ensures the LaunchAgent is loaded and
|
||||
starts the Gateway if needed.
|
||||
- Logs are written to the launchd gateway log path (visible in Debug Settings).
|
||||
|
||||
Common commands:
|
||||
|
||||
```bash
|
||||
launchctl kickstart -k gui/$UID/ai.openclaw.gateway
|
||||
launchctl bootout gui/$UID/ai.openclaw.gateway
|
||||
```
|
||||
|
||||
Replace the label with `ai.openclaw.<profile>` when running a named profile.
|
||||
|
||||
## Unsigned dev builds
|
||||
|
||||
`scripts/restart-mac.sh --no-sign` is for fast local builds without signing
|
||||
keys. To stop launchd from pointing at an unsigned relay binary, it writes
|
||||
`~/.openclaw/disable-launchagent`.
|
||||
|
||||
Signed runs of `scripts/restart-mac.sh` clear this override if the marker is
|
||||
present. To reset manually:
|
||||
|
||||
```bash
|
||||
rm ~/.openclaw/disable-launchagent
|
||||
```
|
||||
|
||||
## Attach-only mode
|
||||
|
||||
To force the macOS app to never install or manage launchd, launch it with
|
||||
`--attach-only` (or `--no-launchd`). This sets
|
||||
`~/.openclaw/disable-launchagent`, so the app only attaches to an already
|
||||
running Gateway. Toggle the same behavior in Debug Settings.
|
||||
|
||||
## Remote mode
|
||||
|
||||
Remote mode never starts a local Gateway. The app uses an SSH tunnel to the
|
||||
remote host and connects over that tunnel.
|
||||
|
||||
## Why we prefer launchd
|
||||
|
||||
- Auto-start at login.
|
||||
- Built-in restart/KeepAlive semantics.
|
||||
- Predictable logs and supervision.
|
||||
|
||||
If a true child-process mode is ever needed again, it should be documented as
|
||||
a separate, explicit dev-only mode.
|
||||
|
||||
## Related
|
||||
|
||||
- [macOS app](/platforms/macos)
|
||||
- [Gateway runbook](/gateway)
|
||||
106
docs/platforms/mac/dev-setup.md
Normal file
106
docs/platforms/mac/dev-setup.md
Normal file
@@ -0,0 +1,106 @@
|
||||
---
|
||||
summary: "Setup guide for developers working on the OpenClaw macOS app"
|
||||
read_when:
|
||||
- Setting up the macOS development environment
|
||||
title: "macOS dev setup"
|
||||
---
|
||||
|
||||
# macOS developer setup
|
||||
|
||||
Build and run the OpenClaw macOS application from source.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- **Xcode 26.2+** (Swift 6.2 toolchain), on the latest macOS available in
|
||||
Software Update.
|
||||
- **Node.js 24 & pnpm** for the gateway, CLI, and packaging scripts. Node
|
||||
22.19+ also works.
|
||||
|
||||
## 1. Install dependencies
|
||||
|
||||
```bash
|
||||
pnpm install
|
||||
```
|
||||
|
||||
## 2. Build and package the app
|
||||
|
||||
```bash
|
||||
./scripts/package-mac-app.sh
|
||||
```
|
||||
|
||||
Outputs `dist/OpenClaw.app`. Without an Apple Developer ID certificate, the
|
||||
script falls back to ad-hoc signing.
|
||||
|
||||
For dev run modes, signing flags, and Team ID troubleshooting, see
|
||||
[apps/macos/README.md](https://github.com/openclaw/openclaw/blob/main/apps/macos/README.md).
|
||||
Fast dev loop from repo root: `scripts/restart-mac.sh` (add `--no-sign` for
|
||||
ad-hoc signing; TCC permissions do not stick with `--no-sign`).
|
||||
|
||||
<Note>
|
||||
Ad-hoc signed apps may trigger security prompts. If the app crashes
|
||||
immediately with "Abort trap 6", see [Troubleshooting](#troubleshooting).
|
||||
</Note>
|
||||
|
||||
## 3. Install the CLI and Gateway
|
||||
|
||||
The packaged app embeds the canonical `scripts/install-cli.sh` installer. On a
|
||||
fresh profile, choose **This Mac** during onboarding; the app installs the
|
||||
matching user-space CLI and runtime before starting the Gateway wizard.
|
||||
|
||||
For manual development recovery, install the matching CLI yourself:
|
||||
|
||||
```bash
|
||||
npm install -g openclaw@<version>
|
||||
```
|
||||
|
||||
`pnpm add -g openclaw@<version>` and `bun add -g openclaw@<version>` also
|
||||
work. Node remains the recommended runtime for the Gateway itself.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Build fails: toolchain or SDK mismatch
|
||||
|
||||
The macOS app build expects the latest macOS SDK and the Swift 6.2 toolchain
|
||||
(Xcode 26.2+).
|
||||
|
||||
```bash
|
||||
xcodebuild -version
|
||||
xcrun swift --version
|
||||
```
|
||||
|
||||
If versions don't match, update macOS/Xcode and re-run the build.
|
||||
|
||||
### App crashes on permission grant
|
||||
|
||||
If the app crashes when you try to allow **Speech Recognition** or
|
||||
**Microphone** access, it may be a corrupted TCC cache or signature mismatch.
|
||||
|
||||
1. Reset TCC permissions for the debug bundle id:
|
||||
|
||||
```bash
|
||||
tccutil reset All ai.openclaw.mac.debug
|
||||
```
|
||||
|
||||
2. If that fails, temporarily change `BUNDLE_ID` in
|
||||
[`scripts/package-mac-app.sh`](https://github.com/openclaw/openclaw/blob/main/scripts/package-mac-app.sh)
|
||||
to force a clean slate from macOS.
|
||||
|
||||
### Gateway "Starting..." indefinitely
|
||||
|
||||
Check whether a zombie process holds the port:
|
||||
|
||||
```bash
|
||||
openclaw gateway status
|
||||
openclaw gateway stop
|
||||
|
||||
# If you're not using a LaunchAgent (dev mode / manual runs), find the listener:
|
||||
lsof -nP -iTCP:18789 -sTCP:LISTEN
|
||||
```
|
||||
|
||||
If a manual run holds the port, stop it (Ctrl+C), or kill the PID found above
|
||||
as a last resort.
|
||||
|
||||
## Related
|
||||
|
||||
- [macOS app](/platforms/macos)
|
||||
- [Install overview](/install)
|
||||
48
docs/platforms/mac/health.md
Normal file
48
docs/platforms/mac/health.md
Normal file
@@ -0,0 +1,48 @@
|
||||
---
|
||||
summary: "How the macOS app reports gateway/channel health states"
|
||||
read_when:
|
||||
- Debugging mac app health indicators
|
||||
title: "Health checks (macOS)"
|
||||
---
|
||||
|
||||
# Health checks on macOS
|
||||
|
||||
How to read the linked-channel health state from the menu bar app.
|
||||
|
||||
## Menu bar
|
||||
|
||||
Status dot:
|
||||
|
||||
- Green: linked + probe healthy.
|
||||
- Orange: linked but a channel probe reports degraded/not connected.
|
||||
- Red: not linked yet.
|
||||
|
||||
The secondary line reads "linked · auth 12m" or shows the failure reason.
|
||||
"Run Health Check Now" in the menu triggers an on-demand probe.
|
||||
|
||||
## Settings
|
||||
|
||||
- General tab shows a Health card: status dot, summary line (link state +
|
||||
auth age), and an optional failure detail line, with **Retry now** and
|
||||
**Open logs** buttons.
|
||||
- **Channels tab** surfaces per-channel status and controls (login QR,
|
||||
logout, probe, last disconnect/error) for WhatsApp and Telegram.
|
||||
|
||||
## How the probe works
|
||||
|
||||
The app calls the Gateway's `health` RPC over its existing WebSocket
|
||||
connection (not a CLI shell-out) every ~60s and on demand. The RPC loads
|
||||
creds and reports status without sending messages. The app caches the last
|
||||
good snapshot and the last error separately so the UI loads instantly and
|
||||
does not flicker while offline.
|
||||
|
||||
## When in doubt
|
||||
|
||||
Use the CLI flow in [Gateway health](/gateway/health) (`openclaw status`,
|
||||
`openclaw status --deep`, `openclaw health --json`) and tail
|
||||
`/tmp/openclaw/openclaw-*.log`, filtering for `web-heartbeat` / `web-reconnect`.
|
||||
|
||||
## Related
|
||||
|
||||
- [Gateway health](/gateway/health)
|
||||
- [macOS app](/platforms/macos)
|
||||
44
docs/platforms/mac/icon.md
Normal file
44
docs/platforms/mac/icon.md
Normal file
@@ -0,0 +1,44 @@
|
||||
---
|
||||
summary: "Menu bar icon states and animations for OpenClaw on macOS"
|
||||
read_when:
|
||||
- Changing menu bar icon behavior
|
||||
title: "Menu bar icon"
|
||||
---
|
||||
|
||||
# Menu Bar Icon States
|
||||
|
||||
Scope: macOS app (`apps/macos`). Rendering: `CritterIconRenderer.makeIcon(...)`. Animation/state wiring: `CritterStatusLabel` + `CritterStatusLabel+Behavior.swift`.
|
||||
|
||||
## States
|
||||
|
||||
| State | Trigger | Visual |
|
||||
| --------------------- | ----------------------------------------- | --------------------------------------------------------------------------------------------------- |
|
||||
| Idle | Default | Normal blink/wiggle animation |
|
||||
| Paused | `isPaused=true` | Status item uses `appearsDisabled`; no motion |
|
||||
| Voice wake (big ears) | Wake word heard | Ears scale to `1.9x` with `earHoles=true` (circular holes for readability); drops after silence |
|
||||
| Working | `isWorking=true` or an active `IconState` | Faster leg wiggle (`legWiggle` up to `1.0`) plus a small horizontal offset; additive to idle wiggle |
|
||||
|
||||
A tool-activity badge (SF Symbol puck, e.g. `chevron.left.slash.chevron.right` for exec) can render on top of the same critter icon when a session has an active job or tool. That badge comes from `IconState`/`ActivityKind`; see [Menu bar](/platforms/mac/menu-bar) for the full state model.
|
||||
|
||||
## Voice wake ears
|
||||
|
||||
- Trigger: `AppStateStore.shared.triggerVoiceEars(ttl: nil)`, called from the voice-wake capture pipeline (`VoiceWakeRuntime`) and from voice-wake debug/test tooling (`VoiceWakeTester`, `VoiceWakeOverlayController`).
|
||||
- Stop: `stopVoiceEars()`, called when capture finalizes.
|
||||
- Silence window before finalizing: `2.0s` normally, `5.0s` if only the trigger word was heard and no further speech followed (`VoiceWakeRuntime.silenceWindow` / `triggerOnlySilenceWindow`).
|
||||
- While boosted, idle blink/wiggle/leg/ear timers are suspended (`earBoostActive` gates the animation task in `CritterStatusLabel+Behavior`).
|
||||
|
||||
## Shapes and sizes
|
||||
|
||||
- Canvas: 18x18pt template image, rendered into a 36x36px bitmap backing store (2x) so the icon stays crisp on Retina.
|
||||
- Ear scale defaults to `1.0`; voice boost sets `earScale=1.9` and `earHoles=true` without changing the overall frame.
|
||||
- Leg scurry uses `legWiggle` up to `1.0` with a small horizontal jiggle.
|
||||
|
||||
## Behavioral notes
|
||||
|
||||
- No external CLI/broker toggle for ears or working state; both are driven internally by app signals (`AppState.setWorking`, `AppState.triggerVoiceEars`) to avoid accidental flapping.
|
||||
- Keep any new TTL short (well under 10s) so the icon returns to baseline quickly if a job hangs.
|
||||
|
||||
## Related
|
||||
|
||||
- [Menu bar](/platforms/mac/menu-bar)
|
||||
- [macOS app](/platforms/macos)
|
||||
59
docs/platforms/mac/logging.md
Normal file
59
docs/platforms/mac/logging.md
Normal file
@@ -0,0 +1,59 @@
|
||||
---
|
||||
summary: "OpenClaw logging: rolling diagnostics file log + unified log privacy flags"
|
||||
read_when:
|
||||
- Capturing macOS logs or investigating private data logging
|
||||
- Debugging voice wake/session lifecycle issues
|
||||
title: "macOS logging"
|
||||
---
|
||||
|
||||
# Logging (macOS)
|
||||
|
||||
## Rolling diagnostics file log (Debug pane)
|
||||
|
||||
The macOS app logs through swift-log (unified logging by default) and can also write a rotating local file log for durable capture (`DiagnosticsFileLog`).
|
||||
|
||||
- Enable: **Debug pane -> Logs -> App logging -> "Write rolling diagnostics log (JSONL)"** (off by default).
|
||||
- Verbosity: **Debug pane -> Logs -> App logging -> Verbosity** picker.
|
||||
- Location: `~/Library/Logs/OpenClaw/diagnostics.jsonl`.
|
||||
- Rotation: rotates at 5 MB; up to 5 backups suffixed `.1`...`.5` (oldest dropped).
|
||||
- Clear: **Debug pane -> Logs -> App logging -> "Clear"** deletes the active file and all backups.
|
||||
|
||||
Treat the file as sensitive; do not share it without review.
|
||||
|
||||
## Unified logging private data on macOS
|
||||
|
||||
Unified logging redacts most payloads unless a subsystem opts into `privacy -off`. This is controlled by a plist in `/Library/Preferences/Logging/Subsystems/` keyed by subsystem name. Only new log entries pick up the flag, so enable it before reproducing an issue. Background: [macOS logging privacy shenanigans](https://steipete.me/posts/2025/logging-privacy-shenanigans).
|
||||
|
||||
## Enable for OpenClaw (`ai.openclaw`)
|
||||
|
||||
Write the plist to a temp file first, then install it atomically as root:
|
||||
|
||||
```bash
|
||||
cat <<'EOF' >/tmp/ai.openclaw.plist
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
||||
<plist version="1.0">
|
||||
<dict>
|
||||
<key>DEFAULT-OPTIONS</key>
|
||||
<dict>
|
||||
<key>Enable-Private-Data</key>
|
||||
<true/>
|
||||
</dict>
|
||||
</dict>
|
||||
</plist>
|
||||
EOF
|
||||
sudo install -m 644 -o root -g wheel /tmp/ai.openclaw.plist /Library/Preferences/Logging/Subsystems/ai.openclaw.plist
|
||||
```
|
||||
|
||||
No reboot required; logd picks up the file quickly, but only new log lines include private payloads. View the richer output with `./scripts/clawlog.sh --category WebChat --last 5m` (`--last`/`-l` sets the time range, default `5m`; `--category`/`-c` filters by category).
|
||||
|
||||
## Disable after debugging
|
||||
|
||||
- Remove the override: `sudo rm /Library/Preferences/Logging/Subsystems/ai.openclaw.plist`.
|
||||
- Optionally run `sudo log config --reload` to force logd to drop the override immediately.
|
||||
- This surface can include phone numbers and message bodies; keep the plist in place only while actively needed.
|
||||
|
||||
## Related
|
||||
|
||||
- [macOS app](/platforms/macos)
|
||||
- [Gateway logging](/gateway/logging)
|
||||
92
docs/platforms/mac/menu-bar.md
Normal file
92
docs/platforms/mac/menu-bar.md
Normal file
@@ -0,0 +1,92 @@
|
||||
---
|
||||
summary: "Menu bar status logic and what is surfaced to users"
|
||||
read_when:
|
||||
- Tweaking mac menu UI or status logic
|
||||
title: "Menu bar"
|
||||
---
|
||||
|
||||
## What is shown
|
||||
|
||||
- The current agent work state renders in the menu bar icon and in the first status row of the menu.
|
||||
- Health status is hidden while work is active; it returns once all sessions are idle.
|
||||
- A root "Context" item opens a submenu with recent sessions instead of expanding them in the root menu.
|
||||
- A "Nodes" block in the root menu lists paired **devices** only (from `node.list`), not client/presence entries.
|
||||
- A root "Usage" section appears below Context when provider usage snapshots are available, followed by cost details when available.
|
||||
|
||||
## State model
|
||||
|
||||
- Source: `WorkActivityStore` (`apps/macos/Sources/OpenClaw/WorkActivityStore.swift`).
|
||||
- Events arrive as `ControlAgentEvent` with a `runId`; the handler (`ControlChannel.routeWorkActivity`) reads `sessionKey` from the event payload and defaults to `"main"` if absent.
|
||||
- Priority: the main session (`sessionKey == "main"` by default) always wins. If main is active, its state shows immediately. If main is idle, the most recently active non-main session shows instead. The store does not flip mid-activity; it only switches when the current session goes idle or main becomes active.
|
||||
- Activity kinds:
|
||||
- `job`: high-level command execution (`state: started|streaming|done|error|...`).
|
||||
- `tool`: `phase: start|result` with `name`, optional `meta`/`args`.
|
||||
|
||||
## IconState enum (Swift)
|
||||
|
||||
- `idle`
|
||||
- `workingMain(ActivityKind)`
|
||||
- `workingOther(ActivityKind)`
|
||||
- `overridden(ActivityKind)` (debug override)
|
||||
|
||||
### ActivityKind -> badge symbol
|
||||
|
||||
`ActivityKind` wraps a `ToolKind` (`bash`, `read`, `write`, `edit`, `attach`, `other`) or a bare `job`. Each maps to an SF Symbol badge drawn over the critter icon (`IconState.badgeSymbolName`):
|
||||
|
||||
| Kind | Symbol |
|
||||
| --------------- | ---------------------------------- |
|
||||
| `bash` | `chevron.left.slash.chevron.right` |
|
||||
| `read` | `doc` |
|
||||
| `write` | `pencil` |
|
||||
| `edit` | `pencil.tip` |
|
||||
| `attach` | `paperclip` |
|
||||
| `other` / `job` | `gearshape.fill` |
|
||||
|
||||
### Visual mapping
|
||||
|
||||
- `idle`: normal critter, no badge.
|
||||
- `workingMain`: badge with symbol, full tint (`.primary` prominence), leg "working" animation.
|
||||
- `workingOther`: badge with symbol, muted tint (`.secondary` prominence), no scurry.
|
||||
- `overridden`: uses the chosen symbol/tint regardless of real activity.
|
||||
|
||||
## Context submenu
|
||||
|
||||
- The root menu shows one "Context" row with a session count/status; it opens a submenu (`MenuSessionsInjector`).
|
||||
- The submenu header shows the active session count for the last 24 hours.
|
||||
- Each session row keeps its token bar, age, preview, thinking/verbose toggle, reset, compact, and delete actions.
|
||||
- Loading, disconnected, and session-load error messages render inside the Context submenu.
|
||||
- Usage and cost sections stay root-level below Context so they remain glanceable without opening the submenu.
|
||||
|
||||
## Status row text (menu)
|
||||
|
||||
- While work is active: `<Session role> · <activity label>` (`"\(roleLabel) · \(activity.label)"` in `MenuContentView`), where role label is `Main` or `Other`.
|
||||
- When idle: falls back to the health summary.
|
||||
|
||||
## Event ingestion
|
||||
|
||||
- Source: control-channel `agent` events, routed by `ControlChannel.routeWorkActivity(from:)`.
|
||||
- Parsed fields:
|
||||
- `stream: "job"` with `data.state` for start/stop.
|
||||
- `stream: "tool"` with `data.phase`, `data.name`, optional `data.meta`/`data.args`.
|
||||
- Tool labels come from `ToolDisplayRegistry.resolve(name:args:meta:)`; unresolved names fall back to the raw tool name.
|
||||
|
||||
## Debug override
|
||||
|
||||
- Settings > Debug > "Icon override" picker:
|
||||
- `System (auto)` (default)
|
||||
- `Working: main` / `Working: other` (per tool kind: bash, read, write, edit, other)
|
||||
- `Idle`
|
||||
- Stored under `UserDefaults` key `openclaw.iconOverride`; mapped to `IconState.overridden`.
|
||||
|
||||
## Testing checklist
|
||||
|
||||
- Trigger main session job: icon switches immediately and status row shows the main label.
|
||||
- Trigger non-main session job while main is idle: icon/status shows the non-main session; stays stable until it finishes.
|
||||
- Start main while another session is active: icon flips to main instantly.
|
||||
- Rapid tool bursts: badge does not flicker (2s grace window before clearing a finished tool, `WorkActivityStore.toolResultGrace`).
|
||||
- Health row reappears once all sessions are idle.
|
||||
|
||||
## Related
|
||||
|
||||
- [macOS app](/platforms/macos)
|
||||
- [Menu bar icon](/platforms/mac/icon)
|
||||
68
docs/platforms/mac/peekaboo.md
Normal file
68
docs/platforms/mac/peekaboo.md
Normal file
@@ -0,0 +1,68 @@
|
||||
---
|
||||
summary: "PeekabooBridge integration for macOS UI automation"
|
||||
read_when:
|
||||
- Hosting PeekabooBridge in OpenClaw.app
|
||||
- Integrating Peekaboo via Swift Package Manager
|
||||
- Changing PeekabooBridge protocol/paths
|
||||
- Deciding between PeekabooBridge, Codex Computer Use, and cua-driver MCP
|
||||
title: "Peekaboo bridge"
|
||||
---
|
||||
|
||||
OpenClaw can host **PeekabooBridge** as a local, permission-aware UI automation broker (`PeekabooBridgeHostCoordinator`, backed by the `steipete/Peekaboo` Swift package). This lets the `peekaboo` CLI drive UI automation while reusing the macOS app's TCC permissions.
|
||||
|
||||
## What this is (and is not)
|
||||
|
||||
- **Host**: OpenClaw.app can act as a PeekabooBridge host.
|
||||
- **Client**: the `peekaboo` CLI (there is no separate `openclaw ui ...` surface).
|
||||
- **UI**: visual overlays stay in Peekaboo.app; OpenClaw is a thin broker host.
|
||||
|
||||
## Relationship to other desktop-control paths
|
||||
|
||||
OpenClaw has three desktop-control paths that intentionally stay separate:
|
||||
|
||||
- **PeekabooBridge host**: OpenClaw.app hosts the local PeekabooBridge socket. The `peekaboo` CLI is the client and uses OpenClaw.app's macOS permissions for screenshots, clicks, menus, dialogs, Dock actions, and window management.
|
||||
- **Codex Computer Use**: the bundled `codex` plugin checks and can install Codex's `computer-use` MCP plugin (`extensions/codex/src/app-server/computer-use.ts`), then lets Codex own native desktop-control tool calls during Codex-mode turns. OpenClaw does not proxy those actions through PeekabooBridge.
|
||||
- **Direct `cua-driver` MCP**: OpenClaw can register TryCua's upstream `cua-driver mcp` server as a normal MCP server, giving agents the CUA driver's own schemas and pid/window/element-index workflow without routing through the Codex marketplace or the PeekabooBridge socket.
|
||||
|
||||
Use Peekaboo for the broad macOS automation surface via OpenClaw.app's permission-aware bridge host. Use Codex Computer Use when a Codex-mode agent should rely on Codex's native plugin. Use direct `cua-driver mcp` to expose the CUA driver to any OpenClaw-managed runtime as a normal MCP server.
|
||||
|
||||
## Enable the bridge
|
||||
|
||||
In the macOS app: **Settings -> Enable Peekaboo Bridge**.
|
||||
|
||||
When enabled, OpenClaw starts a local UNIX socket server at `~/Library/Application Support/OpenClaw/<socket-name>`. If disabled, the host stops and `peekaboo` falls back to other available hosts. The coordinator also maintains legacy socket symlinks (`clawdbot`, `clawdis`, `moltbot` under Application Support) pointing at the current socket for older `peekaboo` installs.
|
||||
|
||||
## Client discovery order
|
||||
|
||||
Peekaboo clients typically try hosts in this order:
|
||||
|
||||
1. Peekaboo.app (full UX)
|
||||
2. Claude.app (if installed)
|
||||
3. OpenClaw.app (thin broker)
|
||||
|
||||
Use `peekaboo bridge status --verbose` to see which host is active and which socket path is in use. Override with:
|
||||
|
||||
```bash
|
||||
export PEEKABOO_BRIDGE_SOCKET=/path/to/bridge.sock
|
||||
```
|
||||
|
||||
## Security and permissions
|
||||
|
||||
- The bridge validates **caller code signatures**; an allowlist of TeamIDs is enforced (Peekaboo host TeamID plus the running app's own TeamID).
|
||||
- Prefer the signed bridge/app identity over a generic `node` runtime for Accessibility. Granting Accessibility to `node` lets any package launched by that Node executable inherit GUI automation access; see [macOS permissions](/platforms/mac/permissions#accessibility-grants-for-node-and-cli-runtimes).
|
||||
- Requests time out after 10 seconds (`requestTimeoutSec: 10`).
|
||||
- If required permissions are missing, the bridge returns a clear error message rather than launching System Settings.
|
||||
|
||||
## Snapshot behavior (automation)
|
||||
|
||||
Snapshots are stored in memory with a 10-minute validity window and a cap of 50 snapshots (`InMemorySnapshotManager`); artifacts are not deleted on cleanup. If you need longer retention, re-capture from the client.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
- If `peekaboo` reports "bridge client is not authorized", ensure the client is properly signed or run the host with `PEEKABOO_ALLOW_UNSIGNED_SOCKET_CLIENTS=1` in **debug** mode only.
|
||||
- If no hosts are found, open one of the host apps (Peekaboo.app or OpenClaw.app) and confirm permissions are granted.
|
||||
|
||||
## Related
|
||||
|
||||
- [macOS app](/platforms/macos)
|
||||
- [macOS permissions](/platforms/mac/permissions)
|
||||
59
docs/platforms/mac/permissions.md
Normal file
59
docs/platforms/mac/permissions.md
Normal file
@@ -0,0 +1,59 @@
|
||||
---
|
||||
summary: "macOS permission persistence (TCC) and signing requirements"
|
||||
read_when:
|
||||
- Debugging missing or stuck macOS permission prompts
|
||||
- Deciding whether to grant Accessibility to node or a CLI runtime
|
||||
- Packaging or signing the macOS app
|
||||
- Changing bundle IDs or app install paths
|
||||
title: "macOS permissions"
|
||||
---
|
||||
|
||||
macOS permission grants are fragile. TCC associates a permission grant with the app's code signature, bundle identifier, and on-disk path. If any of those change, macOS treats the app as new and may drop or hide prompts.
|
||||
|
||||
## Requirements for stable permissions
|
||||
|
||||
- Same path: run the app from a fixed location (for OpenClaw, `dist/OpenClaw.app`).
|
||||
- Same bundle identifier: OpenClaw's bundle ID is `ai.openclaw.mac`; changing it creates a new permission identity.
|
||||
- Signed app: unsigned or ad-hoc signed builds do not persist permissions.
|
||||
- Consistent signature: use a real Apple Development or Developer ID certificate so the signature stays stable across rebuilds.
|
||||
|
||||
Ad-hoc signatures generate a new identity every build. macOS forgets previous grants, and prompts can disappear entirely until the stale entries are cleared.
|
||||
|
||||
## Accessibility grants for Node and CLI runtimes
|
||||
|
||||
Prefer granting Accessibility to OpenClaw.app, Peekaboo.app, or another signed helper with its own bundle identifier instead of a generic `node` binary.
|
||||
|
||||
macOS TCC grants Accessibility to the code identity of the process it sees. If a Homebrew, nvm, pnpm, or npm workflow causes a shared `node` executable to receive Accessibility, any JavaScript package launched through that same executable may inherit GUI automation privileges.
|
||||
|
||||
Treat a `node` entry in System Settings as broad permission for that Node runtime, not as permission for one npm package. Avoid granting Accessibility to `node` unless you trust every script and package launched through that exact Node install.
|
||||
|
||||
If you accidentally granted Accessibility to `node`, remove that entry from System Settings -> Privacy & Security -> Accessibility. Then grant the signed app or helper that should own UI automation.
|
||||
|
||||
## Recovery checklist when prompts disappear
|
||||
|
||||
1. Quit the app.
|
||||
2. Remove the app entry in System Settings -> Privacy & Security.
|
||||
3. Relaunch the app from the same path and re-grant permissions.
|
||||
4. If the prompt still does not appear, reset TCC entries with `tccutil` and try again.
|
||||
5. Some permissions only reappear after a full macOS restart.
|
||||
|
||||
Example resets (using OpenClaw's bundle ID, `ai.openclaw.mac`):
|
||||
|
||||
```bash
|
||||
sudo tccutil reset Accessibility ai.openclaw.mac
|
||||
sudo tccutil reset ScreenCapture ai.openclaw.mac
|
||||
sudo tccutil reset AppleEvents
|
||||
```
|
||||
|
||||
## Files and folders permissions (Desktop/Documents/Downloads)
|
||||
|
||||
macOS may also gate Desktop, Documents, and Downloads for terminal/background processes. If file reads or directory listings hang, grant access to the same process context that performs file operations (for example Terminal/iTerm, LaunchAgent-launched app, or SSH process).
|
||||
|
||||
Workaround: move files into the OpenClaw workspace (`~/.openclaw/workspace`) if you want to avoid per-folder grants.
|
||||
|
||||
If you are testing permissions, always sign with a real certificate. Ad-hoc builds are only acceptable for quick local runs where permissions do not matter.
|
||||
|
||||
## Related
|
||||
|
||||
- [macOS app](/platforms/macos)
|
||||
- [macOS signing](/platforms/mac/signing)
|
||||
117
docs/platforms/mac/remote.md
Normal file
117
docs/platforms/mac/remote.md
Normal file
@@ -0,0 +1,117 @@
|
||||
---
|
||||
summary: "macOS app flow for controlling a remote OpenClaw gateway"
|
||||
read_when:
|
||||
- Setting up or debugging remote mac control
|
||||
title: "Remote control"
|
||||
---
|
||||
|
||||
This flow lets the macOS app act as a full remote control for an OpenClaw gateway running on another host (desktop/server). The app connects directly to trusted LAN/Tailnet gateway URLs, or manages an SSH tunnel when the remote gateway is loopback-only. Health checks, Voice Wake forwarding, and Web Chat reuse the same remote configuration from _Settings -> General_.
|
||||
|
||||
## Modes
|
||||
|
||||
- **Local (this Mac)**: everything runs on the laptop; no SSH involved.
|
||||
- **Remote over SSH (default)**: OpenClaw commands run on the remote host. The app opens an SSH connection with `-o BatchMode`, your chosen identity/key, and a local port-forward.
|
||||
- **Remote direct (ws/wss)**: no SSH tunnel; the app connects to the gateway URL directly (LAN, Tailscale, Tailscale Serve, or a public HTTPS reverse proxy).
|
||||
|
||||
## Remote transports
|
||||
|
||||
- **SSH tunnel** (default): uses `ssh -N -L ...` to forward the gateway port to localhost. The gateway sees the node's IP as `127.0.0.1` because the tunnel is loopback.
|
||||
- **Direct (ws/wss)**: connects straight to the gateway URL. The gateway sees the real client IP.
|
||||
|
||||
The app disables SSH connection multiplexing and post-authentication backgrounding for its own SSH processes so it can monitor and restart the exact process, even if the selected alias enables `ControlMaster` or `ForkAfterAuthentication`.
|
||||
|
||||
SSH host-key verification is strict by default because gateway credentials travel through this tunnel. To opt into a managed SSH alias's own trust behavior, set `--ssh-host-key-policy openssh` via `openclaw-mac configure-remote`, or set `gateway.remote.sshHostKeyPolicy` to `"openssh"` directly. Review the alias and any matching `Host *` or system configuration before opting in. Changing the SSH target (in the app or via `configure-remote`) resets the policy back to `strict` unless you explicitly opt in again for the new target.
|
||||
|
||||
In SSH tunnel mode, discovered LAN/tailnet hostnames save as `gateway.remote.sshTarget`. The app keeps `gateway.remote.url` on the local tunnel endpoint (for example `ws://127.0.0.1:18789`) so CLI, Web Chat, and the local node-host service all use the same loopback transport. When discovery returns both raw Tailnet IPs and stable hostnames, the app prefers Tailscale MagicDNS or LAN names so connections survive address changes better. If the local tunnel port differs from the remote gateway port, set `gateway.remote.remotePort` to the port on the remote host.
|
||||
|
||||
Browser automation in remote mode is owned by the CLI node host, not the native macOS app node. The app starts the installed node host service when possible; to enable browser control from that Mac, install/start it with `openclaw node install ...` and `openclaw node start` (or run `openclaw node run ...` in the foreground), then target that browser-capable node.
|
||||
|
||||
## Prereqs on the remote host
|
||||
|
||||
1. Install Node + pnpm and build/install the OpenClaw CLI (`pnpm install && pnpm build && pnpm link --global`).
|
||||
2. Ensure `openclaw` is on PATH for non-interactive shells (symlink into `/usr/local/bin` or `/opt/homebrew/bin` if needed).
|
||||
3. For SSH transport: set up key-based SSH auth. Tailscale IPs are recommended for stable reachability off-LAN.
|
||||
|
||||
## macOS app setup
|
||||
|
||||
To preconfigure the app without the welcome flow, over SSH:
|
||||
|
||||
```bash
|
||||
openclaw-mac configure-remote \
|
||||
--ssh-target user@gateway-host \
|
||||
--local-port 18789 \
|
||||
--remote-port 18789 \
|
||||
--token "$OPENCLAW_GATEWAY_TOKEN"
|
||||
```
|
||||
|
||||
Or for a gateway already reachable on a trusted LAN or Tailnet, skip SSH entirely:
|
||||
|
||||
```bash
|
||||
openclaw-mac configure-remote \
|
||||
--direct-url ws://192.168.0.202:18789 \
|
||||
--token "$OPENCLAW_GATEWAY_TOKEN"
|
||||
```
|
||||
|
||||
Both forms write `~/.openclaw/openclaw.json`, mark onboarding complete, and let the app own the selected transport on next start. `--local-port`/`--remote-port` default to `18789`. Other flags: `--password`, `--identity <path>`, `--ssh-host-key-policy <strict|openssh>`, `--project-root <path>`, `--cli-path <path>`, `--json`. Run `openclaw-mac configure-remote --help` for the full reference.
|
||||
|
||||
To configure from the UI instead:
|
||||
|
||||
1. Open _Settings -> General_.
|
||||
2. Under **OpenClaw runs**, pick **Remote** and set:
|
||||
- **Transport**: **SSH tunnel** or **Direct (ws/wss)**.
|
||||
- **SSH target**: `user@host` (optional `:port`). If the gateway is on the same LAN and advertises Bonjour, pick it from the discovered list to auto-fill this field.
|
||||
- **Gateway URL** (Direct only): `wss://gateway.example.ts.net` (or `ws://...` for local/LAN).
|
||||
- **Identity file** (advanced): path to your key.
|
||||
- **Project root** (advanced): remote checkout path used for commands.
|
||||
- **CLI path** (advanced): optional path to a runnable `openclaw` entrypoint/binary (auto-filled when advertised).
|
||||
3. Hit **Test remote**. Success means the remote `openclaw status --json` ran correctly. Failures usually mean PATH/CLI issues; exit 127 means the CLI was not found remotely.
|
||||
4. Health checks and Web Chat now run through the selected transport automatically.
|
||||
|
||||
## Web Chat
|
||||
|
||||
- **SSH tunnel**: connects to the gateway over the forwarded WebSocket control port (default 18789).
|
||||
- **Direct (ws/wss)**: connects straight to the configured gateway URL.
|
||||
- There is no separate Web Chat HTTP server.
|
||||
|
||||
## Permissions
|
||||
|
||||
- The remote host needs the same TCC approvals as local (Automation, Accessibility, Screen Recording, Microphone, Speech Recognition, Notifications). Run onboarding on that machine once to grant them.
|
||||
- Nodes advertise their permission state via `node.list` / `node.describe` so agents know what is available.
|
||||
|
||||
## Security notes
|
||||
|
||||
- Prefer loopback binds on the remote host and connect via SSH, Tailscale Serve, or a trusted Tailnet/LAN direct URL.
|
||||
- SSH tunneling requires an already-trusted host key by default. Trust the host key first (add it to the configured known-hosts file), or explicitly set `gateway.remote.sshHostKeyPolicy: "openssh"` for a managed alias whose OpenSSH trust policy you accept.
|
||||
- If you bind the Gateway to a non-loopback interface, require valid Gateway auth: token, password, or an identity-aware reverse proxy with `gateway.auth.mode: "trusted-proxy"`.
|
||||
- See [Security](/gateway/security) and [Tailscale](/gateway/tailscale).
|
||||
|
||||
## WhatsApp login flow (remote)
|
||||
|
||||
- Run `openclaw channels login --channel whatsapp --verbose` **on the remote host**. Scan the QR with WhatsApp on your phone.
|
||||
- Re-run login on that host if auth expires. The health check surfaces link problems.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
| Symptom | Cause / fix |
|
||||
| ------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `exit 127` / not found | `openclaw` is not on PATH for non-login shells. Add it to `/etc/paths`, your shell rc, or symlink into `/usr/local/bin`/`/opt/homebrew/bin`. |
|
||||
| Health probe failed | Check SSH reachability, PATH, and that Baileys (WhatsApp) is logged in (`openclaw status --json`). |
|
||||
| Web Chat stuck | Confirm the gateway is running on the remote host and the forwarded port matches the gateway WS port; the UI requires a healthy WS connection. |
|
||||
| Node IP shows `127.0.0.1` | Expected with the SSH tunnel. Switch **Transport** to **Direct (ws/wss)** if you want the gateway to see the real client IP. |
|
||||
| Dashboard works but Mac capabilities are offline | The operator/control connection is healthy, but the companion node connection is not connected or is missing its command surface. Open the menu bar device section and check whether the Mac is `paired · disconnected`. For `wss://*.ts.net` Tailscale Serve endpoints, the app detects stale legacy TLS leaf pins after certificate rotation, clears the stale pin once macOS trusts the new certificate, and retries automatically. If the certificate is not system-trusted or the host is not a Tailscale Serve name, set `gateway.remote.tlsFingerprint` to the expected certificate fingerprint, review the certificate, or switch to **Remote over SSH**. |
|
||||
| Voice Wake | Trigger phrases forward automatically in remote mode; no separate forwarder is needed. |
|
||||
|
||||
## Notification sounds
|
||||
|
||||
Pick sounds per notification from scripts with `openclaw nodes notify`, for example:
|
||||
|
||||
```bash
|
||||
openclaw nodes notify --node <id> --title "Ping" --body "Remote gateway ready" --sound Glass
|
||||
```
|
||||
|
||||
There is no global default-sound toggle in the app; callers choose a sound (or none) per request.
|
||||
|
||||
## Related
|
||||
|
||||
- [macOS app](/platforms/macos)
|
||||
- [Remote access](/gateway/remote)
|
||||
42
docs/platforms/mac/signing.md
Normal file
42
docs/platforms/mac/signing.md
Normal file
@@ -0,0 +1,42 @@
|
||||
---
|
||||
summary: "Signing steps for macOS debug builds generated by packaging scripts"
|
||||
read_when:
|
||||
- Building or signing mac debug builds
|
||||
title: "macOS signing"
|
||||
---
|
||||
|
||||
# mac signing (debug builds)
|
||||
|
||||
[`scripts/package-mac-app.sh`](https://github.com/openclaw/openclaw/blob/main/scripts/package-mac-app.sh) builds and packages the app to a fixed path (`dist/OpenClaw.app`), then calls [`scripts/codesign-mac-app.sh`](https://github.com/openclaw/openclaw/blob/main/scripts/codesign-mac-app.sh) to sign it. TCC permissions are tied to the bundle ID and code signature; keeping both stable (and the app at a fixed path) across rebuilds keeps macOS from forgetting TCC grants (notifications, accessibility, screen recording, mic, speech).
|
||||
|
||||
- Debug bundle identifier defaults to `ai.openclaw.mac.debug` (override with `BUNDLE_ID=...`).
|
||||
- Node: `>=22.19.0 <23` or `>=23.11.0` (repo `package.json` `engines`). The packager also builds the Control UI (`pnpm ui:build`).
|
||||
- Requires a real signing identity by default; the codesign script exits with an error if none is found and `ALLOW_ADHOC_SIGNING` is not set. Ad-hoc signing (`SIGN_IDENTITY="-"`) is explicit opt-in and does not persist TCC permissions across rebuilds. See [macOS permissions](/platforms/mac/permissions).
|
||||
- Reads `SIGN_IDENTITY` from the environment (e.g. `export SIGN_IDENTITY="Apple Development: Your Name (TEAMID)"`, or a Developer ID Application cert). Without it, `codesign-mac-app.sh` auto-selects an identity in this order: Developer ID Application, Apple Distribution, Apple Development, then the first valid codesigning identity found.
|
||||
- `CODESIGN_TIMESTAMP=auto` (default) enables trusted timestamps only for Developer ID Application signatures. Set `on`/`off` to force either way.
|
||||
- Stamps Info.plist with `OpenClawBuildTimestamp` (ISO8601 UTC) and `OpenClawGitCommit` (short hash, `unknown` if unavailable) so the About tab can show build, git, and debug/release channel.
|
||||
- Runs a Team ID audit after signing and fails if any Mach-O inside the bundle has a different Team ID. Set `SKIP_TEAM_ID_CHECK=1` to bypass.
|
||||
|
||||
## Usage
|
||||
|
||||
```bash
|
||||
# from repo root
|
||||
scripts/package-mac-app.sh # auto-selects identity; errors if none found
|
||||
SIGN_IDENTITY="Developer ID Application: Your Name" scripts/package-mac-app.sh # real cert
|
||||
ALLOW_ADHOC_SIGNING=1 scripts/package-mac-app.sh # ad-hoc (permissions will not stick)
|
||||
SIGN_IDENTITY="-" scripts/package-mac-app.sh # explicit ad-hoc (same caveat)
|
||||
DISABLE_LIBRARY_VALIDATION=1 scripts/package-mac-app.sh # dev-only Sparkle Team ID mismatch workaround
|
||||
```
|
||||
|
||||
### Ad-hoc signing note
|
||||
|
||||
`SIGN_IDENTITY="-"` disables the Hardened Runtime (`--options runtime`) to prevent crashes when the app loads embedded frameworks (like Sparkle) that do not share the same Team ID. Ad-hoc signatures also break TCC permission persistence; see [macOS permissions](/platforms/mac/permissions) for recovery steps.
|
||||
|
||||
## Build metadata for About
|
||||
|
||||
The About tab reads `OpenClawBuildTimestamp` and `OpenClawGitCommit` from Info.plist to show version, build date, git commit, and whether the build is DEBUG (via `#if DEBUG`). Re-run the packager after code changes to refresh these values.
|
||||
|
||||
## Related
|
||||
|
||||
- [macOS app](/platforms/macos)
|
||||
- [macOS permissions](/platforms/mac/permissions)
|
||||
37
docs/platforms/mac/skills.md
Normal file
37
docs/platforms/mac/skills.md
Normal file
@@ -0,0 +1,37 @@
|
||||
---
|
||||
summary: "macOS Skills settings UI and gateway-backed status"
|
||||
read_when:
|
||||
- Updating the macOS Skills settings UI
|
||||
- Changing skills gating or install behavior
|
||||
title: "Skills (macOS)"
|
||||
---
|
||||
|
||||
The macOS app surfaces OpenClaw skills via the gateway; it does not parse skills locally.
|
||||
|
||||
## Data source
|
||||
|
||||
- `skills.status` (gateway) returns all skills plus eligibility and missing requirements, including allowlist blocks for bundled skills.
|
||||
- Requirements come from `metadata.openclaw.requires` in each `SKILL.md`.
|
||||
|
||||
## Install actions
|
||||
|
||||
- `metadata.openclaw.install` defines install options (brew/node/go/uv/download).
|
||||
- The app calls `skills.install` to run installers on the gateway host.
|
||||
- Operator-owned `security.installPolicy` (`enabled`, `targets`, `exec`) can block gateway-backed skill installs before installer metadata runs. Built-in dangerous-code scanning (used for plugin installs) is not wired into the skill install flow.
|
||||
- If every install option is `download`, the gateway surfaces all download choices.
|
||||
- Otherwise the gateway picks one preferred installer using current install preferences (`skills.install.preferBrew`, `skills.install.nodeManager`) and host binaries: Homebrew first when `preferBrew` is enabled and `brew` is present, then `uv`, then the configured node manager, then Homebrew again if available (even without `preferBrew`), then `go`, then `download`.
|
||||
- Node install labels reflect the configured node manager, including `yarn`.
|
||||
|
||||
## Env/API keys
|
||||
|
||||
- The app stores keys in `~/.openclaw/openclaw.json` under `skills.entries.<skillKey>`.
|
||||
- `skills.update` patches `enabled`, `apiKey`, and `env`.
|
||||
|
||||
## Remote mode
|
||||
|
||||
- Install and config updates happen on the gateway host, not the local Mac.
|
||||
|
||||
## Related
|
||||
|
||||
- [Skills](/tools/skills)
|
||||
- [macOS app](/platforms/macos)
|
||||
55
docs/platforms/mac/voice-overlay.md
Normal file
55
docs/platforms/mac/voice-overlay.md
Normal file
@@ -0,0 +1,55 @@
|
||||
---
|
||||
summary: "Voice overlay lifecycle when wake-word and push-to-talk overlap"
|
||||
read_when:
|
||||
- Adjusting voice overlay behavior
|
||||
title: "Voice overlay"
|
||||
---
|
||||
|
||||
# Voice Overlay Lifecycle (macOS)
|
||||
|
||||
Audience: macOS app contributors. Goal: keep the voice overlay predictable when wake-word and push-to-talk overlap.
|
||||
|
||||
## Behavior
|
||||
|
||||
- If the overlay is already visible from wake-word and the user presses the hotkey, the hotkey session adopts the existing text instead of resetting it. The overlay stays up while the hotkey is held. On release: send if there is trimmed text, otherwise dismiss.
|
||||
- Wake-word alone still auto-sends on silence; push-to-talk sends immediately on release.
|
||||
|
||||
## Implementation
|
||||
|
||||
- `VoiceSessionCoordinator` (`apps/macos/Sources/OpenClaw/VoiceSessionCoordinator.swift`) is the single owner of the active voice session. It is a `@MainActor @Observable` singleton, not an actor. API: `startSession`, `updatePartial`, `finalize`, `sendNow`, `dismiss`, `updateLevel`, `snapshot`. Each session carries a `UUID` token; calls with a stale or mismatched token are dropped.
|
||||
- `VoiceWakeOverlayController` (`VoiceWakeOverlayController+Session.swift`) renders the overlay and forwards user actions (`requestSend`, `dismiss`) back through the coordinator via the session token. It never owns the session state itself.
|
||||
- Push-to-talk (`VoicePushToTalk.begin()`) adopts any visible overlay text as `adoptedPrefix` (via `VoiceSessionCoordinator.shared.snapshot()`) so pressing the hotkey while the wake overlay is up keeps the text and appends new speech. On release, it waits up to 1.5s for a final transcript before falling back to the current text.
|
||||
- On `dismiss`, the overlay calls `VoiceSessionCoordinator.overlayDidDismiss`, which triggers `VoiceWakeRuntime.refresh(state:)` so manual X-dismiss, empty-text dismiss, and post-send dismiss all resume wake-word listening.
|
||||
- Unified send path: if trimmed text is empty, dismiss; otherwise `sendNow` plays the send chime once, forwards via `VoiceWakeForwarder`, then dismisses.
|
||||
|
||||
## Logging
|
||||
|
||||
Voice subsystem is `ai.openclaw`; each component logs under its own category:
|
||||
|
||||
| Category | Component |
|
||||
| ----------------------- | ----------------------------------------------- |
|
||||
| `voicewake.coordinator` | `VoiceSessionCoordinator` |
|
||||
| `voicewake.overlay` | `VoiceWakeOverlayController`/`VoiceWakeOverlay` |
|
||||
| `voicewake.ptt` | Push-to-talk hotkey and capture |
|
||||
| `voicewake.runtime` | Wake-word runtime |
|
||||
| `voicewake.chime` | Chime playback |
|
||||
| `voicewake.sync` | Global settings sync |
|
||||
| `voicewake.forward` | Transcript forwarding |
|
||||
| `voicewake.meter` | Mic level monitor |
|
||||
|
||||
## Debugging checklist
|
||||
|
||||
- Stream logs while reproducing a sticky overlay:
|
||||
|
||||
```bash
|
||||
sudo log stream --predicate 'subsystem == "ai.openclaw" AND category CONTAINS "voicewake"' --level info --style compact
|
||||
```
|
||||
|
||||
- Verify only one active session token; stale callbacks are dropped by the coordinator.
|
||||
- Confirm push-to-talk release always calls `end()` with the active token; if text is empty, expect a dismiss without chime or send.
|
||||
|
||||
## Related
|
||||
|
||||
- [macOS app](/platforms/macos)
|
||||
- [Voice wake (macOS)](/platforms/mac/voicewake)
|
||||
- [Talk mode](/nodes/talk)
|
||||
69
docs/platforms/mac/voicewake.md
Normal file
69
docs/platforms/mac/voicewake.md
Normal file
@@ -0,0 +1,69 @@
|
||||
---
|
||||
summary: "Voice wake and push-to-talk modes plus routing details in the mac app"
|
||||
read_when:
|
||||
- Working on voice wake or PTT pathways
|
||||
title: "Voice wake (macOS)"
|
||||
---
|
||||
|
||||
# Voice Wake & Push-to-Talk
|
||||
|
||||
## Requirements
|
||||
|
||||
Voice Wake and push-to-talk require macOS 26 or newer. On older macOS the controls are hidden from the Voice settings page, which shows the macOS 26 requirement instead.
|
||||
|
||||
## Modes
|
||||
|
||||
- **Wake-word mode** (default): an always-on Speech recognizer waits for trigger tokens (`swabbleTriggerWords`). On match it starts capture, shows the overlay with partial text, and auto-sends after silence.
|
||||
- **Push-to-talk (hold Right Option)**: hold the right Option key to capture immediately, no trigger needed. The overlay appears while held; releasing finalizes and forwards after a short delay so you can edit the text.
|
||||
|
||||
## Runtime behavior (wake-word)
|
||||
|
||||
- The recognizer lives in `VoiceWakeRuntime`.
|
||||
- Trigger fires only when there is a meaningful pause between the wake word and the next word (`triggerPauseWindow` = 0.55s). The overlay/chime can start on the pause even before the command begins.
|
||||
- Silence windows: 2.0s (`silenceWindow`) when speech is flowing, 5.0s (`triggerOnlySilenceWindow`) if only the trigger was heard.
|
||||
- Hard stop: 120s (`captureHardStop`) to prevent runaway sessions.
|
||||
- Debounce between sessions: 350ms (`debounceAfterSend`) after a send.
|
||||
- The overlay is driven via `VoiceWakeOverlayController`, with committed/volatile text coloring.
|
||||
- After send, the recognizer restarts cleanly to listen for the next trigger.
|
||||
|
||||
## Lifecycle invariants
|
||||
|
||||
- If Voice Wake is enabled and permissions are granted, the wake-word recognizer stays listening, except during an active push-to-talk capture.
|
||||
- Overlay dismissal, including manual dismiss via the X button, always resumes the recognizer: `VoiceSessionCoordinator.overlayDidDismiss` calls `VoiceWakeRuntime.refresh(state:)` on every dismiss path. See [Voice overlay](/platforms/mac/voice-overlay) for the session/token model.
|
||||
|
||||
## Push-to-talk specifics
|
||||
|
||||
- Hotkey detection uses a global `.flagsChanged` monitor for right Option (`keyCode 61` + `.option`). It only observes events, never swallows them.
|
||||
- Capture lives in `VoicePushToTalk`: starts Speech immediately, streams partials to the overlay, and calls `VoiceWakeForwarder` on release.
|
||||
- Starting push-to-talk pauses the wake-word runtime to avoid dueling audio taps; it restarts automatically after release.
|
||||
- Permissions: requires Microphone + Speech; receiving key events needs Accessibility/Input Monitoring approval.
|
||||
- External keyboards: some do not expose right Option as expected. Offer a fallback shortcut if users report misses.
|
||||
|
||||
## User-facing settings
|
||||
|
||||
- **Voice Wake** toggle: enables the wake-word runtime.
|
||||
- **Hold Right Option to talk**: enables the push-to-talk monitor.
|
||||
- Language and mic pickers, a live level meter, a trigger-word table, and a tester (local-only, never forwards).
|
||||
- The mic picker preserves the last selection if a device disconnects, shows a disconnected hint, and temporarily falls back to the system default until it returns.
|
||||
- **Sounds**: chimes on trigger detect and on send, defaulting to the macOS "Glass" system sound. Pick any `NSSound`-loadable file (e.g. MP3/WAV/AIFF) per event, or choose **No Sound**.
|
||||
|
||||
## Forwarding behavior
|
||||
|
||||
- On forward, `VoiceWakeForwarder.selectedSessionOptions` picks the active WebChat session key if one is set, otherwise the gateway's main session key.
|
||||
- It looks up that session via `sessions.list` and derives the delivery channel and target from the session's delivery context (falling back to its last channel/target, then to a parsed session key), defaulting to WebChat if nothing resolves.
|
||||
- If delivery fails, the error is logged (`voicewake.forward` category) and the run is still visible via WebChat/session logs.
|
||||
|
||||
## Forwarding payload
|
||||
|
||||
- `VoiceWakeForwarder.prefixedTranscript(_:)` prepends a machine-hint line (resolved host name, falling back to "this Mac") before the transcript, shared between wake-word and push-to-talk paths.
|
||||
|
||||
## Quick verification
|
||||
|
||||
- Toggle push-to-talk on, hold Right Option, speak, release: overlay should show partials then send.
|
||||
- While holding, the menu-bar ears should stay enlarged (`triggerVoiceEars(ttl: nil)`); they drop after release.
|
||||
|
||||
## Related
|
||||
|
||||
- [Voice wake](/nodes/voicewake)
|
||||
- [Voice overlay](/platforms/mac/voice-overlay)
|
||||
- [macOS app](/platforms/macos)
|
||||
44
docs/platforms/mac/webchat.md
Normal file
44
docs/platforms/mac/webchat.md
Normal file
@@ -0,0 +1,44 @@
|
||||
---
|
||||
summary: "How the mac app embeds the gateway WebChat and how to debug it"
|
||||
read_when:
|
||||
- Debugging mac WebChat view or loopback port
|
||||
title: "WebChat (macOS)"
|
||||
---
|
||||
|
||||
The macOS menu bar app embeds the WebChat UI as a native SwiftUI view. It connects to the Gateway and defaults to the primary session for the selected agent (`main`, or `global` when `session.scope` is `global`), with a session switcher for other sessions.
|
||||
|
||||
- **Local mode**: connects directly to the local Gateway WebSocket.
|
||||
- **Remote mode**: forwards the Gateway control port over SSH and uses that tunnel as the data plane.
|
||||
|
||||
## Launch and debugging
|
||||
|
||||
- Manual: Lobster menu -> "Open Chat".
|
||||
- Auto-open for testing:
|
||||
|
||||
```bash
|
||||
dist/OpenClaw.app/Contents/MacOS/OpenClaw --chat
|
||||
```
|
||||
|
||||
(`--webchat` is accepted as a legacy alias.)
|
||||
|
||||
- Logs: `./scripts/clawlog.sh` (subsystem `ai.openclaw`, category `WebChatSwiftUI`).
|
||||
|
||||
## How it is wired
|
||||
|
||||
- Data plane: Gateway WS methods `chat.history`, `chat.send`, `chat.abort`, `chat.inject`, and events `chat`, `agent`, `presence`, `tick`, `health`.
|
||||
- `chat.history` returns a display-normalized transcript: inline directive tags are stripped from visible text, plain-text tool-call XML payloads (`<tool_call>`, `<function_call>`, `<tool_calls>`, `<function_calls>`, including truncated blocks) and leaked model control tokens are stripped, pure silent-token assistant rows such as exact `NO_REPLY`/`no_reply` are omitted, and oversized rows can be replaced with a truncated placeholder.
|
||||
- Session: defaults to the primary session as above; the UI can switch between sessions.
|
||||
- Onboarding uses a dedicated session to keep first-run setup separate.
|
||||
|
||||
## Security surface
|
||||
|
||||
- Remote mode forwards only the Gateway WebSocket control port over SSH.
|
||||
|
||||
## Known limitations
|
||||
|
||||
- The UI is optimized for chat sessions, not a full browser sandbox.
|
||||
|
||||
## Related
|
||||
|
||||
- [WebChat](/web/webchat)
|
||||
- [macOS app](/platforms/macos)
|
||||
65
docs/platforms/mac/xpc.md
Normal file
65
docs/platforms/mac/xpc.md
Normal file
@@ -0,0 +1,65 @@
|
||||
---
|
||||
summary: "macOS IPC architecture for OpenClaw app, gateway node transport, and PeekabooBridge"
|
||||
read_when:
|
||||
- Editing IPC contracts or menu bar app IPC
|
||||
title: "macOS IPC"
|
||||
---
|
||||
|
||||
# OpenClaw macOS IPC architecture
|
||||
|
||||
A local Unix socket connects the node host service to the macOS app for exec approvals and `system.run`. An `openclaw-mac` debug CLI (`apps/macos/Sources/OpenClawMacCLI`) exists for discovery/connect checks; agent actions still flow through the Gateway WebSocket and `node.invoke`. UI automation uses PeekabooBridge.
|
||||
|
||||
## Goals
|
||||
|
||||
- Single GUI app instance that owns all TCC-facing work (notifications, screen recording, mic, speech, AppleScript).
|
||||
- A small surface for automation: Gateway + node commands, plus PeekabooBridge for UI automation.
|
||||
- Predictable permissions: always the same signed bundle ID, launched by launchd, so TCC grants stick.
|
||||
|
||||
## How it works
|
||||
|
||||
### Gateway + node transport
|
||||
|
||||
- The app runs the Gateway (local mode) and connects to it as a node.
|
||||
- Agent actions are performed via `node.invoke` (e.g. `system.run`, `system.notify`, `canvas.*`).
|
||||
- Node commands include `canvas.*`, `camera.snap`, `camera.clip`, `screen.snapshot`, `screen.record`, `system.run`, and `system.notify`.
|
||||
- The node reports a `permissions` map so agents can see whether screen, camera, microphone, speech, automation, or accessibility access is available.
|
||||
|
||||
### Node service + app IPC
|
||||
|
||||
- A headless node host service connects to the Gateway WebSocket.
|
||||
- `system.run` requests are forwarded to the macOS app over a local Unix socket (`ExecApprovalsSocket.swift`).
|
||||
- The app performs the exec in UI context, prompts if needed, and returns output.
|
||||
|
||||
Diagram (SCI):
|
||||
|
||||
```text
|
||||
Agent -> Gateway -> Node Service (WS)
|
||||
| IPC (UDS + token + HMAC + TTL)
|
||||
v
|
||||
Mac App (UI + TCC + system.run)
|
||||
```
|
||||
|
||||
### PeekabooBridge (UI automation)
|
||||
|
||||
- UI automation uses a separate UNIX socket (`~/Library/Application Support/OpenClaw/<socket>`) and the PeekabooBridge JSON protocol.
|
||||
- Host preference order (client-side): Peekaboo.app -> Claude.app -> OpenClaw.app -> local execution.
|
||||
- Security: bridge hosts require an allowlisted TeamID (the bundled `PeekabooBridgeHostCoordinator` allowlists a fixed team plus the app's own signing team); a DEBUG-only same-UID escape hatch is guarded by `PEEKABOO_ALLOW_UNSIGNED_SOCKET_CLIENTS=1` (Peekaboo convention).
|
||||
- See: [PeekabooBridge usage](/platforms/mac/peekaboo) for details.
|
||||
|
||||
## Operational flows
|
||||
|
||||
- Restart/rebuild: `scripts/restart-mac.sh` kills existing instances, rebuilds via Swift, repackages, and relaunches. It auto-detects an available signing identity and falls back to `--no-sign` if none is found; pass `--sign` to require signing (fails if no key is available) or `--no-sign` to force the unsigned path. `SIGN_IDENTITY` set in the environment is unset on the signed path, so `scripts/codesign-mac-app.sh`'s own identity auto-detection picks the cert.
|
||||
- Single instance: the app checks `NSWorkspace.runningApplications` for a duplicate bundle ID and exits if more than one instance is found (`isDuplicateInstance()` in `MenuBar.swift`).
|
||||
|
||||
## Hardening notes
|
||||
|
||||
- Prefer requiring a TeamID match for all privileged surfaces.
|
||||
- PeekabooBridge: `PEEKABOO_ALLOW_UNSIGNED_SOCKET_CLIENTS=1` (DEBUG-only) may allow same-UID callers for local development.
|
||||
- All communication remains local-only; no network sockets are exposed.
|
||||
- TCC prompts originate only from the GUI app bundle; keep the signed bundle ID stable across rebuilds.
|
||||
- Exec approvals socket hardening: file mode `0600`, shared token, peer-UID check (`getpeereid`), HMAC-SHA256 challenge/response, and a short TTL on requests.
|
||||
|
||||
## Related
|
||||
|
||||
- [macOS app](/platforms/macos)
|
||||
- [macOS IPC flow (Exec approvals)](/tools/exec-approvals-advanced#macos-ipc-flow)
|
||||
Reference in New Issue
Block a user