Repository navigation
docs: document the plan-mode scratchpad - #1023
Merged
Merged
Conversation
Co-authored-by: Eden Reich <16985712+edenreich@users.noreply.github.com>
inference-gateway-maintainer
Bot
requested a review
from a team
as a code owner
October 20, 2026 14:32
5 tasks
Contributor
|
🗑️ Preview environment destroyed. |
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
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.
Summary
Documents the plan-mode scratchpad in
cli.md, verified against the CLI implementation (config/projects.go,internal/sandbox/paths.go,internal/sandbox/bash_paths.go,internal/tools/bash.go) and the CLI's owndocs/plan-mode.md/docs/tools-reference.md.Changes, all in
cli.md:### Plan Modeintro rewritten around the scratchpad model, plus a new#### The scratchpadsubsection: the path, the only-writable-location rule, lazy creation,/resetwipe, survival into the executing session, and the plain-error rejection (including../traversal and symlinks resolving outside).git statusin plan mode reports on the scratchpad), with the absolute-argument caveat on allowed-list commands.#### Approving a plan: the scratchpad is left in place for the executing session.##### Per-mode allowed-list: theplan:YAML comment and the default-deny bullet no longer call plan mode read-only and say commands run pinned to the scratchpad, with thego build.*/go test.*opt-in example and a note that creating commands (mkdir,ln -s) pass through the scratchpad gate.### File System Tools: one line that Write, Edit, MultiEdit and Delete run in plan mode only inside the scratchpad.Notes
AGENTS.mdin this repo forbids tracker numbers or links in doc content, so those were left out - the behavior itself is described instead.planModeWorkDirininternal/tools/bash.go. Both are documented.Validation
bun run lint:md,bun run format:checkandbun run buildall pass.Closes #1020
Generated with Claude Code