Skip to content

(docs) update sandboxing documentation#25930

Merged
g-samroberts merged 2 commits intomainfrom
sandbox-docs
Apr 27, 2026
Merged

(docs) update sandboxing documentation#25930
g-samroberts merged 2 commits intomainfrom
sandbox-docs

Conversation

@g-samroberts
Copy link
Copy Markdown
Contributor

Update sandbox documentation for Docker container workflows and other details

Summary

This PR expands and reorganizes the docs/cli/sandbox.md documentation to provide clearer, more sequential instructions for users utilizing container-based (Docker/Podman) sandboxing. It addresses common user questions regarding workspace path resolution, custom image configuration (such as Artifact Registry), and nested Docker setups.

Resolves #25929

Changes

  • Reorganized document structure: Moved the "Quickstart" and general configuration sections to the top for a better "Bottom Line Up Front" (BLUF) reading flow. Grouped advanced settings and profile configurations together at the bottom.
  • Expanded Docker/Podman instructions:
    • Added a "How it works" section explicitly clarifying that the local host workspace directory is mounted to the exact same absolute path inside the sandbox container.
    • Added detailed instructions for configuring custom sandbox images (e.g., from Artifact Registry) via settings.json and the GEMINI_SANDBOX_IMAGE environment variable.
    • Clarified the workflow for automatically building local images using .gemini/sandbox.Dockerfile and the BUILD_SANDBOX=1 environment variable.
  • Documented sandbox expansion:
    • Added instructions on using the SANDBOX_MOUNTS environment variable to mount additional files or directories outside the project workspace into the sandbox.
  • Formatting: Ran npm run format to ensure adherence to Markdown and Prettier guidelines.

Validation

  • Manually reviewed the updated markdown for clarity, tone, and accuracy against the sandbox implementation.
  • Verified that npm run format successfully passed.

@g-samroberts g-samroberts requested review from a team as code owners April 24, 2026 17:35
@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the sandboxing documentation for the Gemini CLI. By restructuring the content for better flow and adding detailed technical guidance on container-based workflows, the update aims to reduce user friction and clarify common configuration patterns for advanced sandboxing scenarios.

Highlights

  • Documentation Reorganization: Moved the Quickstart and general configuration sections to the top of the document to improve readability and provide immediate value to users.
  • Expanded Container Documentation: Added comprehensive details on Docker/Podman workflows, including workspace path mounting, custom image configuration via settings or environment variables, and automatic local image building.
  • New Sandbox Features: Documented the use of the SANDBOX_MOUNTS environment variable for mounting external files and provided guidance for running the CLI inside Docker containers.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@g-samroberts g-samroberts requested a review from galz10 April 24, 2026 17:36
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 24, 2026

Size Change: -4 B (0%)

Total Size: 33.7 MB

Filename Size Change
./bundle/chunk-3WDCI7H3.js 0 B -669 kB (removed) 🏆
./bundle/chunk-7LJ7MZ26.js 0 B -49.2 kB (removed) 🏆
./bundle/chunk-DR2HSN3D.js 0 B -2.73 MB (removed) 🏆
./bundle/chunk-LUJE3MUG.js 0 B -3.43 kB (removed) 🏆
./bundle/chunk-VNYZKHLS.js 0 B -14.6 MB (removed) 🏆
./bundle/chunk-ZG6362H3.js 0 B -3.8 kB (removed) 🏆
./bundle/core-BWBZSQGH.js 0 B -47.7 kB (removed) 🏆
./bundle/devtoolsService-YJ4BDJTX.js 0 B -27.8 kB (removed) 🏆
./bundle/gemini-5ZSCXBD5.js 0 B -578 kB (removed) 🏆
./bundle/interactiveCli-JNJKXT56.js 0 B -1.29 MB (removed) 🏆
./bundle/liteRtServerManager-SNQJEPBS.js 0 B -2.08 kB (removed) 🏆
./bundle/oauth2-provider-PMBLGP5E.js 0 B -9.16 kB (removed) 🏆
./bundle/chunk-33HKUJIM.js 14.6 MB +14.6 MB (new file) 🆕
./bundle/chunk-5X45QEWR.js 3.43 kB +3.43 kB (new file) 🆕
./bundle/chunk-D5OQAA52.js 2.73 MB +2.73 MB (new file) 🆕
./bundle/chunk-OS6G6QUR.js 669 kB +669 kB (new file) 🆕
./bundle/chunk-SIHDZHMJ.js 3.8 kB +3.8 kB (new file) 🆕
./bundle/chunk-Y43EZYKE.js 49.2 kB +49.2 kB (new file) 🆕
./bundle/core-3WL2WJXO.js 47.7 kB +47.7 kB (new file) 🆕
./bundle/devtoolsService-55DFF6HJ.js 27.8 kB +27.8 kB (new file) 🆕
./bundle/gemini-WNO2E6XW.js 578 kB +578 kB (new file) 🆕
./bundle/interactiveCli-VGJLIFBK.js 1.29 MB +1.29 MB (new file) 🆕
./bundle/liteRtServerManager-WFF3PCTY.js 2.08 kB +2.08 kB (new file) 🆕
./bundle/oauth2-provider-DFGS7NUC.js 9.16 kB +9.16 kB (new file) 🆕
ℹ️ View Unchanged
Filename Size Change
./bundle/bundled/third_party/index.js 8 MB 0 B
./bundle/chunk-34MYV7JD.js 2.45 kB 0 B
./bundle/chunk-5AUYMPVF.js 858 B 0 B
./bundle/chunk-5PS3AYFU.js 1.18 kB 0 B
./bundle/chunk-664ZODQF.js 124 kB 0 B
./bundle/chunk-DAHVX5MI.js 206 kB 0 B
./bundle/chunk-IUUIT4SU.js 56.5 kB 0 B
./bundle/chunk-MTD736U4.js 1.97 MB 0 B
./bundle/chunk-RJTRUG2J.js 39.8 kB 0 B
./bundle/cleanup-RSDMCKEG.js 0 B -932 B (removed) 🏆
./bundle/devtools-36NN55EP.js 696 kB 0 B
./bundle/dist-T73EYRDX.js 356 B 0 B
./bundle/events-XB7DADIJ.js 418 B 0 B
./bundle/examples/hooks/scripts/on-start.js 188 B 0 B
./bundle/examples/mcp-server/example.js 1.43 kB 0 B
./bundle/gemini.js 4.97 kB 0 B
./bundle/getMachineId-bsd-TXG52NKR.js 1.55 kB 0 B
./bundle/getMachineId-darwin-7OE4DDZ6.js 1.55 kB 0 B
./bundle/getMachineId-linux-SHIFKOOX.js 1.34 kB 0 B
./bundle/getMachineId-unsupported-5U5DOEYY.js 1.06 kB 0 B
./bundle/getMachineId-win-6KLLGOI4.js 1.72 kB 0 B
./bundle/memoryDiscovery-NSOLCG4U.js 980 B 0 B
./bundle/multipart-parser-KPBZEGQU.js 11.7 kB 0 B
./bundle/node_modules/@google/gemini-cli-devtools/dist/client/main.js 222 kB 0 B
./bundle/node_modules/@google/gemini-cli-devtools/dist/src/_client-assets.js 229 kB 0 B
./bundle/node_modules/@google/gemini-cli-devtools/dist/src/index.js 13.4 kB 0 B
./bundle/node_modules/@google/gemini-cli-devtools/dist/src/types.js 132 B 0 B
./bundle/sandbox-macos-permissive-open.sb 890 B 0 B
./bundle/sandbox-macos-permissive-proxied.sb 1.31 kB 0 B
./bundle/sandbox-macos-restrictive-open.sb 3.36 kB 0 B
./bundle/sandbox-macos-restrictive-proxied.sb 3.56 kB 0 B
./bundle/sandbox-macos-strict-open.sb 4.82 kB 0 B
./bundle/sandbox-macos-strict-proxied.sb 5.02 kB 0 B
./bundle/src-QVCVGIUX.js 47 kB 0 B
./bundle/start-HULGT7D3.js 0 B -622 B (removed) 🏆
./bundle/tree-sitter-7U6MW5PS.js 274 kB 0 B
./bundle/tree-sitter-bash-34ZGLXVX.js 1.84 MB 0 B
./bundle/cleanup-DSZC4PQQ.js 932 B +932 B (new file) 🆕
./bundle/start-WNCQ4JXU.js 622 B +622 B (new file) 🆕

compressed-size-action

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the documentation for the Gemini CLI sandbox feature, adding a new quickstart guide, detailed configuration instructions, and advanced usage examples for Docker and file mounting. A correction was identified in the Docker run command example, where double backslashes were incorrectly used for line continuation in a bash context.

Note: Security Review has been skipped due to the limited scope of the PR.

Comment thread docs/cli/sandbox.md Outdated
@gemini-cli gemini-cli Bot added area/extensions Issues related to Gemini CLI extensions capability area/documentation Gemini CLI documentation tasks and issues labels Apr 24, 2026
@g-samroberts g-samroberts added this pull request to the merge queue Apr 27, 2026
@g-samroberts g-samroberts removed this pull request from the merge queue due to a manual request Apr 27, 2026
@g-samroberts g-samroberts added this pull request to the merge queue Apr 27, 2026
Merged via the queue into main with commit 47bca39 Apr 27, 2026
27 checks passed
@g-samroberts g-samroberts deleted the sandbox-docs branch April 27, 2026 22:54
@hverlin
Copy link
Copy Markdown

hverlin commented Apr 28, 2026

I was reading the docs today and I think the SANDBOX_MOUNTS docs are a bit misleading for macOS.

The docs imply SANDBOX_MOUNTS handles sandbox expansion generally, but in the code it only feeds Docker/Podman --volume args. It does nothing for sandbox-exec.

Anothe issue is that we cannot combine sandbox options in the config and gemini -s. I think this is the problematic code:

const sandboxOption = argv.sandbox ?? settings.tools?.sandbox;

If -s is present, it wins over my configuration, so allowedPaths has not effect. If this intentional, I would clarify it in the docs?

{
  "tools": {
    "sandbox": {
      "command": "sandbox-exec",
      "allowedPaths": [...]
    }
  }
}

I can file a separate issue but though it might get lost in the noise.

TirthNaik-99 pushed a commit to TirthNaik-99/gemini-cli that referenced this pull request May 4, 2026
kimjune01 pushed a commit to kimjune01/gemini-cli-claude that referenced this pull request May 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/documentation Gemini CLI documentation tasks and issues area/extensions Issues related to Gemini CLI extensions capability

Projects

None yet

Development

Successfully merging this pull request may close these issues.

GeminiCLI.com Feedback: Container information lacking

3 participants