Skip to content

docs: correct default per-command timeout in README security section #100

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
arronbailiss merged 2 commits into from
Sep 3, 2026
Merged

docs: correct default per-command timeout in README security section #100

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6108327
docs: correct default per-command timeout in README security section
arronbailiss Sep 3, 2026
e5adda5
docs: reframe timeout bullet as adjustable timeouts with 30s default
arronbailiss Sep 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -241,7 +241,7 @@ Out of the box, the shell is an empty sandbox — no files, no network, no crede
- **Prefer `mode: "copy"` over `mode: "direct"` for source code.** Copy-on-create isolates the agent from your live files. Use `direct` only for output directories where the agent needs to persist results.
- **Scope binds narrowly.** Bind `/my/project/src` rather than `/my/project` or `/`. The agent doesn't need your `.git/`, `.env`, or `node_modules/`.
- **Allowlist URLs explicitly.** Don't use `allowed_urls: ["https://"]` — this disables SSRF protection entirely. List the specific API endpoints the agent needs.
- **Set timeouts.** The default has no per-command timeout. Set `timeout` to bound runaway commands (30s is reasonable for most agent loops).
- **Rely on adjustable timeouts.** Commands run under an adjustable per-command timeout, defaulting to 30 seconds, which bounds runaway commands out of the box. Set `timeout` to raise or lower it for your agent loop.
- **Use limits.** Set `max_output` to prevent agents from filling memory with unbounded command output (1MB is a good default).

## Commands
Expand Down