Skip to content

docs: document the experimental sandbox feature - #11697

Merged
marius-kilocode merged 2 commits into
mainfrom
docs/sandbox-documentation
Jun 26, 2026
Merged

docs: document the experimental sandbox feature#11697
marius-kilocode merged 2 commits into
mainfrom
docs/sandbox-documentation

Conversation

@marius-kilocode

Copy link
Copy Markdown
Collaborator

The experimental sandbox (experimental.sandbox + experimental.sandbox_restrict_network) confines agent shell commands and file-tool writes to the project and Kilo state directories, with optional outbound network blocking. It has shipped without user-facing documentation: the Settings page's Experimental section omits it entirely, and there is no page describing enablement, behavior, or platform support.

This adds a dedicated Sandboxing page under Getting Started -> Settings and wires it into the Experimental Features section and the docs nav.

What the new page covers:

  • Enablement — both config keys with defaults, plus the VS Code Settings webview path (Experimental -> Sandbox, and the Sandboxing tab's Restrict Network Access switch).
  • Behavior — the writable roots (project/worktree + Kilo state dirs), that reads are not confined, that .git writes are always denied, and the network restriction scope (model-originated shell commands + first-party HTTP tools blocked; provider/model inference traffic and local MCP servers/plugin hooks not covered).
  • Per-session toggle — VS Code prompt-input button, TUI /sandbox slash command and palette command, the ◆ Sandbox on indicator, and that the toggle is ephemeral and reports a reason when the backend is unavailable.
  • Platform support — macOS seatbelt, Linux Bubblewrap (with KILO_BWRAP_PATH override and bundled-binary verification), and the Windows-not-supported caveat.
  • Limitations — Windows unsupported, local MCP/plugin network exemption, reads not confined, writable handles routed through a sandboxed worker, additive-not-replacement relationship with the permission system.

The Settings index Experimental list gets a Sandbox bullet linking to the new page, and the experimental JSON example is extended with both keys so users see the config shape inline.

Comment thread packages/kilo-docs/pages/getting-started/settings/index.md Outdated
@kilo-code-bot

kilo-code-bot Bot commented Jun 25, 2026

Copy link
Copy Markdown
Contributor

Code Review Summary

Status: No Issues Found | Recommendation: Merge

Files Reviewed (1 files)
  • packages/kilo-docs/pages/getting-started/settings/index.md
Previous Review Summary (commit 78d6243)

Current summary above is authoritative. Previous snapshots are kept for context only.

Previous review (commit 78d6243)

Status: 1 Issues Found | Recommendation: Address before merge

Overview

Severity Count
CRITICAL 0
WARNING 0
SUGGESTION 1

Fix these issues in Kilo Cloud

Issue Details (click to expand)

SUGGESTION

File Line Issue
packages/kilo-docs/pages/getting-started/settings/index.md 239 The example now contradicts the surrounding "not exposed in the UI" wording.
Files Reviewed (3 files)
  • packages/kilo-docs/lib/nav/getting-started.ts - 0 issues
  • packages/kilo-docs/pages/getting-started/settings/index.md - 1 issue
  • packages/kilo-docs/pages/getting-started/settings/sandboxing.md - 0 issues

Reviewed by gpt-5.4-20260305 · Input: 41.1K · Output: 4.3K · Cached: 206.9K

Review guidance: REVIEW.md from base branch main

@vercel

vercel Bot commented Jun 25, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs (docs-staging) Ready Ready Preview, Comment Jun 25, 2026 2:56pm

Request Review

@marius-kilocode
marius-kilocode merged commit d98bb46 into main Jun 26, 2026
27 checks passed
@marius-kilocode
marius-kilocode deleted the docs/sandbox-documentation branch June 26, 2026 11:53
t7tran pushed a commit to t7tran/kilocode that referenced this pull request Aug 14, 2026
…ation

docs: document the experimental sandbox feature
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.

2 participants