docs: typography hygiene + dup H1 across 5 pages (cli/gateway/help) · openclaw/openclaw@e85fd2a
vincentkoc
·
2026-05-06
·
via Recent Commits to openclaw:main
| Original file line number | Diff line number | Diff line change |
|---|
@@ -118,7 +118,7 @@ Permission model (client debug mode):
|
118 | 118 | - `read` auto-approval is scoped to the current working directory (`--cwd` when set). |
119 | 119 | - ACP only auto-approves narrow readonly classes: scoped `read` calls under the active cwd plus readonly search tools (`search`, `web_search`, `memory_search`). Unknown/non-core tools, out-of-scope reads, exec-capable tools, control-plane tools, mutating tools, and interactive flows always require explicit prompt approval. |
120 | 120 | - Server-provided `toolCall.kind` is treated as untrusted metadata (not an authorization source). |
121 | | -- This ACP bridge policy is separate from ACPX harness permissions. If you run OpenClaw through the `acpx` backend, `plugins.entries.acpx.config.permissionMode=approve-all` is the break-glass “yolo” switch for that harness session. |
| 121 | +- This ACP bridge policy is separate from ACPX harness permissions. If you run OpenClaw through the `acpx` backend, `plugins.entries.acpx.config.permissionMode=approve-all` is the break-glass "yolo" switch for that harness session. |
122 | 122 | |
123 | 123 | ## How to use this |
124 | 124 | |
@@ -218,7 +218,7 @@ pull contextual information from an OpenClaw agent without scraping a terminal.
|
218 | 218 | |
219 | 219 | ## Zed editor setup |
220 | 220 | |
221 | | -Add a custom ACP agent in `~/.config/zed/settings.json` (or use Zed’s Settings UI): |
| 221 | +Add a custom ACP agent in `~/.config/zed/settings.json` (or use Zed's Settings UI): |
222 | 222 | |
223 | 223 | ```json |
224 | 224 | { |
@@ -256,7 +256,7 @@ To target a specific Gateway or agent:
|
256 | 256 | } |
257 | 257 | ``` |
258 | 258 | |
259 | | -In Zed, open the Agent panel and select “OpenClaw ACP” to start a thread. |
| 259 | +In Zed, open the Agent panel and select "OpenClaw ACP" to start a thread. |
260 | 260 | |
261 | 261 | ## Session mapping |
262 | 262 | |
|
| Original file line number | Diff line number | Diff line change |
|---|
@@ -2,12 +2,10 @@
|
2 | 2 | summary: "CLI reference for `openclaw status` (diagnostics, probes, usage snapshots)" |
3 | 3 | read_when: |
4 | 4 | - You want a quick diagnosis of channel health + recent session recipients |
5 | | - - You want a pasteable “all” status for debugging |
6 | | -title: "Status" |
| 5 | + - You want a pasteable "all" status for debugging |
| 6 | +title: "openclaw status" |
7 | 7 | --- |
8 | 8 | |
9 | | -# `openclaw status` |
10 | | - |
11 | 9 | Diagnostics for channels + sessions. |
12 | 10 | |
13 | 11 | ```bash |
@@ -34,8 +32,8 @@ Notes:
|
34 | 32 | - Overview includes update channel + git SHA (for source checkouts). |
35 | 33 | - Update info surfaces in the Overview; if an update is available, status prints a hint to run `openclaw update` (see [Updating](/install/updating)). |
36 | 34 | - Read-only status surfaces (`status`, `status --json`, `status --all`) resolve supported SecretRefs for their targeted config paths when possible. |
37 | | -- If a supported channel SecretRef is configured but unavailable in the current command path, status stays read-only and reports degraded output instead of crashing. Human output shows warnings such as “configured token unavailable in this command path”, and JSON output includes `secretDiagnostics`. |
38 | | -- When command-local SecretRef resolution succeeds, status prefers the resolved snapshot and clears transient “secret unavailable” channel markers from the final output. |
| 35 | +- If a supported channel SecretRef is configured but unavailable in the current command path, status stays read-only and reports degraded output instead of crashing. Human output shows warnings such as "configured token unavailable in this command path", and JSON output includes `secretDiagnostics`. |
| 36 | +- When command-local SecretRef resolution succeeds, status prefers the resolved snapshot and clears transient "secret unavailable" channel markers from the final output. |
39 | 37 | - `status --all` includes a Secrets overview row and a diagnosis section that summarizes secret diagnostics (truncated for readability) without stopping report generation. |
40 | 38 | |
41 | 39 | ## Related |
|
| Original file line number | Diff line number | Diff line change |
|---|
@@ -6,16 +6,14 @@ read_when:
|
6 | 6 | title: "Background exec and process tool" |
7 | 7 | --- |
8 | 8 | |
9 | | -# Background Exec + Process Tool |
10 | | - |
11 | | -OpenClaw runs shell commands through the `exec` tool and keeps long‑running tasks in memory. The `process` tool manages those background sessions. |
| 9 | +OpenClaw runs shell commands through the `exec` tool and keeps long-running tasks in memory. The `process` tool manages those background sessions. |
12 | 10 | |
13 | 11 | ## exec tool |
14 | 12 | |
15 | 13 | Key parameters: |
16 | 14 | |
17 | 15 | - `command` (required) |
18 | | -- `yieldMs` (default 10000): auto‑background after this delay |
| 16 | +- `yieldMs` (default 10000): auto-background after this delay |
19 | 17 | - `background` (bool): background immediately |
20 | 18 | - `timeout` (seconds, default `tools.exec.timeoutSec`): kill the process after this timeout; set `timeout: 0` only to disable the exec process timeout for that call |
21 | 19 | - `elevated` (bool): run outside the sandbox if elevated mode is enabled/allowed (`gateway` by default, or `node` when the exec target is `node`) |
@@ -45,7 +43,7 @@ When spawning long-running child processes outside the exec/process tools (for e
|
45 | 43 | Environment overrides: |
46 | 44 | |
47 | 45 | - `PI_BASH_YIELD_MS`: default yield (ms) |
48 | | -- `PI_BASH_MAX_OUTPUT_CHARS`: in‑memory output cap (chars) |
| 46 | +- `PI_BASH_MAX_OUTPUT_CHARS`: in-memory output cap (chars) |
49 | 47 | - `OPENCLAW_BASH_PENDING_MAX_OUTPUT_CHARS`: pending stdout/stderr cap per stream (chars) |
50 | 48 | - `PI_BASH_JOB_TTL_MS`: TTL for finished sessions (ms, bounded to 1m–3h) |
51 | 49 | |
|
| Original file line number | Diff line number | Diff line change |
|---|
@@ -17,7 +17,7 @@ rate-limited, or temporarily misbehaving. This is intentionally conservative:
|
17 | 17 | - **Images can be passed through** if the CLI accepts image paths. |
18 | 18 | |
19 | 19 | This is designed as a **safety net** rather than a primary path. Use it when you |
20 | | -want “always works” text responses without relying on external APIs. |
| 20 | +want "always works" text responses without relying on external APIs. |
21 | 21 | |
22 | 22 | If you want a full harness runtime with ACP session controls, background tasks, |
23 | 23 | thread/conversation binding, and persistent external coding sessions, use |
@@ -49,7 +49,7 @@ command path:
|
49 | 49 | } |
50 | 50 | ``` |
51 | 51 | |
52 | | -That’s it. No keys, no extra auth config needed beyond the CLI itself. |
| 52 | +That's it. No keys, no extra auth config needed beyond the CLI itself. |
53 | 53 | |
54 | 54 | If you use a bundled CLI backend as the **primary message provider** on a |
55 | 55 | gateway host, OpenClaw now auto-loads the owning bundled plugin when your config |
@@ -397,7 +397,7 @@ children and Streamable HTTP/SSE streams do not outlive the run.
|
397 | 397 | `bundleMcp: true`. |
398 | 398 | - **Streaming is backend-specific.** Some backends stream JSONL; others buffer |
399 | 399 | until exit. |
400 | | -- **Structured outputs** depend on the CLI’s JSON format. |
| 400 | +- **Structured outputs** depend on the CLI's JSON format. |
401 | 401 | - **Codex CLI sessions** resume via text output (no JSONL), which is less |
402 | 402 | structured than the initial `--json` run. OpenClaw sessions still work |
403 | 403 | normally. |
|
| Original file line number | Diff line number | Diff line change |
|---|
@@ -203,7 +203,7 @@ pnpm gateway:dev
|
203 | 203 | OPENCLAW_PROFILE=dev openclaw tui |
204 | 204 | ``` |
205 | 205 | |
206 | | -If you don’t have a global install yet, run the CLI via `pnpm openclaw ...`. |
| 206 | +If you don't have a global install yet, run the CLI via `pnpm openclaw ...`. |
207 | 207 | |
208 | 208 | What this does: |
209 | 209 | |
@@ -219,7 +219,7 @@ What this does:
|
219 | 219 | - Sets `agent.skipBootstrap=true` (no BOOTSTRAP.md). |
220 | 220 | - Seeds the workspace files if missing: |
221 | 221 | `AGENTS.md`, `SOUL.md`, `TOOLS.md`, `IDENTITY.md`, `USER.md`, `HEARTBEAT.md`. |
222 | | -- Default identity: **C3‑PO** (protocol droid). |
| 222 | +- Default identity: **C3-PO** (protocol droid). |
223 | 223 | - Skips channel providers in dev mode (`OPENCLAW_SKIP_CHANNELS=1`). |
224 | 224 | |
225 | 225 | Reset flow (fresh start): |
@@ -297,7 +297,7 @@ Default file:
|
297 | 297 | |
298 | 298 | `~/.pi-mono/logs/raw-openai-completions.jsonl` |
299 | 299 | |
300 | | -> Note: this is only emitted by processes using pi-mono’s |
| 300 | +> Note: this is only emitted by processes using pi-mono's |
301 | 301 | > `openai-completions` provider. |
302 | 302 | |
303 | 303 | ## Safety notes |
|
此内容由惯性聚合(RSS阅读器)自动聚合整理,仅供阅读参考。 原文来自 — 版权归原作者所有。