mirror of
https://github.com/openclaw/openclaw.git
synced 2026-05-06 06:20:43 +00:00
docs: full-page sentence-case sweep across 6 pages
- platforms/oracle: Cost Comparison (2026), Still Recommended, Verify Security Posture - install/exe-dev: Automated Install with Shelley, Remote Access - platforms/mac/dev-setup: Build Fails: Toolchain or SDK Mismatch, App Crashes on Permission Grant - reference/AGENTS.default: What OpenClaw Does, Core Skills, Usage Notes - install/docker: Containerized Gateway, Agent Sandbox - ci: Package Acceptance, Job Overview, Local Equivalents
This commit is contained in:
@@ -29,7 +29,7 @@ optional Telegram lane reuses the
|
||||
`package-under-test` artifact in the `NPM Telegram Beta E2E` workflow, with the
|
||||
published npm spec path kept for standalone dispatches.
|
||||
|
||||
## Package Acceptance
|
||||
## Package acceptance
|
||||
|
||||
Use `Package Acceptance` when the question is "does this installable OpenClaw
|
||||
package work as a product?" It is different from normal CI: normal CI validates
|
||||
@@ -206,7 +206,7 @@ gh workflow run duplicate-after-merge.yml \
|
||||
-f apply=true
|
||||
```
|
||||
|
||||
## Job Overview
|
||||
## Job overview
|
||||
|
||||
| Job | Purpose | When it runs |
|
||||
| -------------------------------- | -------------------------------------------------------------------------------------------- | ---------------------------------- |
|
||||
@@ -284,7 +284,7 @@ The automatic CI concurrency key is versioned (`CI-v7-*`) so a GitHub-side zombi
|
||||
| `blacksmith-6vcpu-macos-latest` | `macos-node` on `openclaw/openclaw`; forks fall back to `macos-latest` |
|
||||
| `blacksmith-12vcpu-macos-latest` | `macos-swift` on `openclaw/openclaw`; forks fall back to `macos-latest` |
|
||||
|
||||
## Local Equivalents
|
||||
## Local equivalents
|
||||
|
||||
```bash
|
||||
pnpm changed:lanes # inspect the local changed-lane classifier for origin/main...HEAD
|
||||
|
||||
@@ -23,7 +23,7 @@ Docker is **optional**. Use it only if you want a containerized gateway or to va
|
||||
[Security hardening for network exposure](/gateway/security),
|
||||
especially Docker `DOCKER-USER` firewall policy.
|
||||
|
||||
## Containerized Gateway
|
||||
## Containerized gateway
|
||||
|
||||
<Steps>
|
||||
<Step title="Build the image">
|
||||
@@ -372,7 +372,7 @@ See [Hetzner (Docker VPS)](/install/hetzner) and
|
||||
[Docker VM Runtime](/install/docker-vm-runtime) for shared VM deployment steps
|
||||
including binary baking, persistence, and updates.
|
||||
|
||||
## Agent Sandbox
|
||||
## Agent sandbox
|
||||
|
||||
When `agents.defaults.sandbox` is enabled with the Docker backend, the gateway
|
||||
runs agent tool execution (shell, file read/write, etc.) inside isolated Docker
|
||||
|
||||
@@ -23,7 +23,7 @@ This page assumes exe.dev's default **exeuntu** image. If you picked a different
|
||||
- exe.dev account
|
||||
- `ssh exe.dev` access to [exe.dev](https://exe.dev) virtual machines (optional)
|
||||
|
||||
## Automated Install with Shelley
|
||||
## Automated install with Shelley
|
||||
|
||||
Shelley, [exe.dev](https://exe.dev)'s agent, can install OpenClaw instantly with our
|
||||
prompt. The prompt used is as below:
|
||||
@@ -113,7 +113,7 @@ with `openclaw config get gateway.auth.token` (or generate one with `openclaw do
|
||||
If you changed the gateway to password auth, use `gateway.auth.password` / `OPENCLAW_GATEWAY_PASSWORD` instead.
|
||||
Approve devices with `openclaw devices list` and `openclaw devices approve <requestId>`. When in doubt, use Shelley from your browser!
|
||||
|
||||
## Remote Access
|
||||
## Remote access
|
||||
|
||||
Remote access is handled by [exe.dev](https://exe.dev)'s authentication. By
|
||||
default, HTTP traffic from port 8000 is forwarded to `https://<vm-name>.exe.xyz`
|
||||
|
||||
@@ -60,7 +60,7 @@ For the Gateway runtime, Node remains the recommended path.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Build Fails: Toolchain or SDK Mismatch
|
||||
### Build fails: toolchain or SDK mismatch
|
||||
|
||||
The macOS app build expects the latest macOS SDK and Swift 6.2 toolchain.
|
||||
|
||||
@@ -78,7 +78,7 @@ xcrun swift --version
|
||||
|
||||
If versions don’t match, update macOS/Xcode and re-run the build.
|
||||
|
||||
### App Crashes on Permission Grant
|
||||
### App crashes on permission grant
|
||||
|
||||
If the app crashes when you try to allow **Speech Recognition** or **Microphone** access, it may be due to a corrupted TCC cache or signature mismatch.
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ Oracle’s free tier can be a great fit for OpenClaw (especially if you already
|
||||
- ARM architecture (most things work, but some binaries may be x86-only)
|
||||
- Capacity and signup can be finicky
|
||||
|
||||
## Cost Comparison (2026)
|
||||
## Cost comparison (2026)
|
||||
|
||||
| Provider | Plan | Specs | Price/mo | Notes |
|
||||
| ------------ | --------------- | ---------------------- | -------- | --------------------- |
|
||||
@@ -193,14 +193,14 @@ This setup often removes the _need_ for extra host-based firewall rules purely t
|
||||
| SSH key-only auth | No | Tailscale authenticates via your tailnet |
|
||||
| IPv6 hardening | Usually not | Depends on your VCN/subnet settings; verify what’s actually assigned/exposed |
|
||||
|
||||
### Still Recommended
|
||||
### Still recommended
|
||||
|
||||
- **Credential permissions:** `chmod 700 ~/.openclaw`
|
||||
- **Security audit:** `openclaw security audit`
|
||||
- **System updates:** `sudo apt update && sudo apt upgrade` regularly
|
||||
- **Monitor Tailscale:** Review devices in [Tailscale admin console](https://login.tailscale.com/admin)
|
||||
|
||||
### Verify Security Posture
|
||||
### Verify security posture
|
||||
|
||||
```bash
|
||||
# Confirm no public ports listening
|
||||
|
||||
@@ -89,13 +89,13 @@ git commit -m "Add Clawd workspace"
|
||||
# Optional: add a private remote + push
|
||||
```
|
||||
|
||||
## What OpenClaw Does
|
||||
## What OpenClaw does
|
||||
|
||||
- Runs WhatsApp gateway + Pi coding agent so the assistant can read/write chats, fetch context, and run skills via the host Mac.
|
||||
- macOS app manages permissions (screen recording, notifications, microphone) and exposes the `openclaw` CLI via its bundled binary.
|
||||
- Direct chats collapse into the agent's `main` session by default; groups stay isolated as `agent:<agentId>:<channel>:group:<id>` (rooms/channels: `agent:<agentId>:<channel>:channel:<id>`); heartbeats keep background tasks alive.
|
||||
|
||||
## Core Skills (enable in Settings → Skills)
|
||||
## Core skills (enable in Settings → Skills)
|
||||
|
||||
- **mcporter** — Tool server runtime/CLI for managing external skill backends.
|
||||
- **Peekaboo** — Fast macOS screenshots with optional AI vision analysis.
|
||||
@@ -115,7 +115,7 @@ git commit -m "Add Clawd workspace"
|
||||
- **Gemini CLI** — Google Gemini models from the terminal for fast Q&A.
|
||||
- **agent-tools** — Utility toolkit for automations and helper scripts.
|
||||
|
||||
## Usage Notes
|
||||
## Usage notes
|
||||
|
||||
- Prefer the `openclaw` CLI for scripting; mac app handles permissions.
|
||||
- Run installs from the Skills tab; it hides the button if a binary is already present.
|
||||
|
||||
Reference in New Issue
Block a user