docs: correct default per-command timeout in README security section - #100
Merged
arronbailiss merged 2 commits intoSep 3, 2026
Merged
arronbailiss merged 2 commits into
arronbailiss merged 2 commits into
Conversation
The "Secure Defaults" section claimed the shell has no per-command timeout by default and advised adding one. The source is the opposite: `ShellBuilder::default()` sets `timeout: Some(Duration::from_secs(30))` (src/shell.rs), and the config tests assert this default (`cfg.timeout_secs == Some(30.0)` in tests/config.rs; `cfg.timeout == 30.0`/`30` in the Python and JS config tests). `None` (no timeout) only arises via the custom-kernel embedding path (`Shell::with_kernel`), which bypasses the builder and reports `timeout_secs: None` (tests/config.rs::with_kernel_reports_default_config_snapshot). Rewrite the bullet so it states the real 30s default, that `timeout` adjusts it, and that the no-timeout state applies only to `with_kernel`.
mkmeral
reviewed
Sep 3, 2026
arronbailiss
enabled auto-merge (squash)
September 3, 2026 13:38
mkmeral
approved these changes
Sep 3, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The README "Secure Defaults" section said the shell has no per-command timeout by default and advised adding
one. The source is the opposite.
Fix: the public builder default is a 30-second per-command timeout.
Verified against source:
ShellBuilder::default()setstimeout: Some(Duration::from_secs(30))(src/shell.rs).cfg.timeout_secs == Some(30.0)(tests/config.rs),cfg.timeout == 30.0(
tests/python/test_config.py),cfg.timeout == 30(tests/js/test_config.mjs).None(no timeout) only arises via the custom-kernel embedding pathShell::with_kernel, which bypasses the builder.Docs-only, one line.