Files
clawdbot/docs/tools/bash.md
2026-01-07 23:24:12 +01:00

866 B

summary, read_when
summary read_when
Bash tool usage, stdin modes, and TTY support
Using or modifying the bash tool
Debugging stdin or TTY behavior

Bash tool

Run shell commands in the workspace. Supports foreground + background execution via process. If process is disallowed, bash runs synchronously and ignores yieldMs/background.

Parameters

  • command (required)
  • yieldMs (default 10000): auto-background after delay
  • background (bool): background immediately
  • timeout (seconds, default 1800): kill on expiry
  • elevated (bool): run on host if elevated mode is enabled/allowed
  • Need a real TTY? Use the tmux skill.

Examples

Foreground:

{"tool":"bash","command":"ls -la"}

Background + poll:

{"tool":"bash","command":"npm run build","yieldMs":1000}
{"tool":"process","action":"poll","sessionId":"<id>"}