mirror of
https://github.com/farcasclaudiu/openclaw.git
synced 2026-06-28 17:01:53 +03:00
chore: Run pnpm format:fix.
This commit is contained in:
@@ -12,6 +12,7 @@ OpenClaw runs shell commands through the `exec` tool and keeps long‑running ta
|
||||
## exec tool
|
||||
|
||||
Key parameters:
|
||||
|
||||
- `command` (required)
|
||||
- `yieldMs` (default 10000): auto‑background after this delay
|
||||
- `background` (bool): background immediately
|
||||
@@ -21,6 +22,7 @@ Key parameters:
|
||||
- `workdir`, `env`
|
||||
|
||||
Behavior:
|
||||
|
||||
- Foreground runs return output directly.
|
||||
- When backgrounded (explicit or timeout), the tool returns `status: "running"` + `sessionId` and a short tail.
|
||||
- Output is kept in memory until the session is polled or cleared.
|
||||
@@ -31,20 +33,23 @@ Behavior:
|
||||
When spawning long-running child processes outside the exec/process tools (for example, CLI respawns or gateway helpers), attach the child-process bridge helper so termination signals are forwarded and listeners are detached on exit/error. This avoids orphaned processes on systemd and keeps shutdown behavior consistent across platforms.
|
||||
|
||||
Environment overrides:
|
||||
|
||||
- `PI_BASH_YIELD_MS`: default yield (ms)
|
||||
- `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)
|
||||
|
||||
Config (preferred):
|
||||
|
||||
- `tools.exec.backgroundMs` (default 10000)
|
||||
- `tools.exec.timeoutSec` (default 1800)
|
||||
- `tools.exec.cleanupMs` (default 1800000)
|
||||
- `tools.exec.notifyOnExit` (default true): enqueue a system event + request heartbeat when a backgrounded exec exits.
|
||||
- `tools.exec.notifyOnExit` (default true): enqueue a system event + request heartbeat when a backgrounded exec exits.
|
||||
|
||||
## process tool
|
||||
|
||||
Actions:
|
||||
|
||||
- `list`: running + finished sessions
|
||||
- `poll`: drain new output for a session (also reports exit status)
|
||||
- `log`: read the aggregated output (supports `offset` + `limit`)
|
||||
@@ -54,6 +59,7 @@ Actions:
|
||||
- `remove`: kill if running, otherwise clear if finished
|
||||
|
||||
Notes:
|
||||
|
||||
- Only backgrounded sessions are listed/persisted in memory.
|
||||
- Sessions are lost on process restart (no disk persistence).
|
||||
- Session logs are only saved to chat history if you run `process poll/log` and the tool result is recorded.
|
||||
@@ -64,19 +70,23 @@ Notes:
|
||||
## Examples
|
||||
|
||||
Run a long task and poll later:
|
||||
|
||||
```json
|
||||
{"tool": "exec", "command": "sleep 5 && echo done", "yieldMs": 1000}
|
||||
{ "tool": "exec", "command": "sleep 5 && echo done", "yieldMs": 1000 }
|
||||
```
|
||||
|
||||
```json
|
||||
{"tool": "process", "action": "poll", "sessionId": "<id>"}
|
||||
{ "tool": "process", "action": "poll", "sessionId": "<id>" }
|
||||
```
|
||||
|
||||
Start immediately in background:
|
||||
|
||||
```json
|
||||
{"tool": "exec", "command": "npm run build", "background": true}
|
||||
{ "tool": "exec", "command": "npm run build", "background": true }
|
||||
```
|
||||
|
||||
Send stdin:
|
||||
|
||||
```json
|
||||
{"tool": "process", "action": "write", "sessionId": "<id>", "data": "y\n"}
|
||||
{ "tool": "process", "action": "write", "sessionId": "<id>", "data": "y\n" }
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user