Skip to content

docs: document the plan-mode scratchpad - #1023

Merged
edenreich merged 1 commit into
mainfrom
docs/issue-1020-20261020-1428
Oct 20, 2026
Merged

edenreich merged 1 commit into
mainfrom
docs/issue-1020-20261020-1428

Conversation

@inference-gateway-maintainer

Copy link
Copy Markdown
Contributor

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 own docs/plan-mode.md / docs/tools-reference.md.

Changes, all in cli.md:

  • Agent Modes table: Plan is no longer labelled "Read-Only" - it now lists writes and Bash inside the scratchpad, with approval following the standard rules there.
  • ### Plan Mode intro rewritten around the scratchpad model, plus a new #### The scratchpad subsection: the path, the only-writable-location rule, lazy creation, /reset wipe, survival into the executing session, and the plain-error rejection (including ../ traversal and symlinks resolving outside).
  • Two known limits stated: scratchpad writes still go through the normal approval rules, and the pinned working directory applies to baseline commands too (git status in 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: the plan: YAML comment and the default-deny bullet no longer call plan mode read-only and say commands run pinned to the scratchpad, with the go 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

  • The issue's last acceptance criterion asks for links back to the upstream CLI issue and PR. AGENTS.md in this repo forbids tracker numbers or links in doc content, so those were left out - the behavior itself is described instead.
  • One detail in the issue did not match upstream verbatim: the CLI docs frame the "absolute argument" escape as the known Bash limit, while the pinned-cwd effect on baseline commands follows from planModeWorkDir in internal/tools/bash.go. Both are documented.

Validation

bun run lint:md, bun run format:check and bun run build all pass.

Closes #1020

Generated with Claude Code

Co-authored-by: Eden Reich <16985712+edenreich@users.noreply.github.com>
@inference-gateway-releaser

inference-gateway-releaser Bot commented Oct 20, 2026 •

Copy link
Copy Markdown
Contributor

🗑️ Preview environment destroyed.

@edenreich
edenreich merged commit c44f1c9 into main Oct 20, 2026
1 check passed
@edenreich
edenreich deleted the docs/issue-1020-20261020-1428 branch October 20, 2026 14:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DOCS] Document the plan-mode scratchpad in the CLI guide

1 participant