vultr/openclaw
1
0
Fork 0
mirror of https://github.com/openclaw/openclaw.git synced 2026-05-06 12:30:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: typography hygiene + dup H1 across 5 pages (cli/gateway/help)

Browse Source
This commit is contained in:
Vincent Koc
2026-05-05 22:34:25 -07:00
parent 6febffb6fe
commit e85fd2abcd
5 changed files with 16 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/gateway/background-process.md
View File

@@ -6,16 +6,14 @@ read_when:
title: "Background exec and process tool"
---
# Background Exec + Process Tool
OpenClaw runs shell commands through the `exec` tool and keeps long‑running tasks in memory. The `process` tool manages those background sessions.
OpenClaw runs shell commands through the `exec` tool and keeps long-running tasks in memory. The `process` tool manages those background sessions.
## exec tool
Key parameters:
- `command` (required)
- `yieldMs` (default 10000): auto‑background after this delay
- `yieldMs` (default 10000): auto-background after this delay
- `background` (bool): background immediately
- `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
- `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
Environment overrides:
- `PI_BASH_YIELD_MS`: default yield (ms)
- `PI_BASH_MAX_OUTPUT_CHARS`: in‑memory output cap (chars)
- `PI_BASH_MAX_OUTPUT_CHARS`: in-memory output cap (chars)
- `OPENCLAW_BASH_PENDING_MAX_OUTPUT_CHARS`: pending stdout/stderr cap per stream (chars)
- `PI_BASH_JOB_TTL_MS`: TTL for finished sessions (ms, bounded to 1m–3h)

6
docs/gateway/cli-backends.md
View File

@@ -17,7 +17,7 @@ rate-limited, or temporarily misbehaving. This is intentionally conservative:
- **Images can be passed through** if the CLI accepts image paths.
This is designed as a **safety net** rather than a primary path. Use it when you
want “always works” text responses without relying on external APIs.
want "always works" text responses without relying on external APIs.
If you want a full harness runtime with ACP session controls, background tasks,
thread/conversation binding, and persistent external coding sessions, use
@@ -49,7 +49,7 @@ command path:
}
```
That’s it. No keys, no extra auth config needed beyond the CLI itself.
That's it. No keys, no extra auth config needed beyond the CLI itself.
If you use a bundled CLI backend as the **primary message provider** on a
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.
`bundleMcp: true`.
- **Streaming is backend-specific.** Some backends stream JSONL; others buffer
until exit.
- **Structured outputs** depend on the CLI’s JSON format.
- **Structured outputs** depend on the CLI's JSON format.
- **Codex CLI sessions** resume via text output (no JSONL), which is less
structured than the initial `--json` run. OpenClaw sessions still work
normally.