@google/gemini-cli-core 0.30.0-preview.6 → 0.31.0-preview.0

package/dist/docs/cli/cli-reference.md

@@ -26,29 +26,29 @@ and parameters.
 
 ## CLI Options
 
-| Option                           | Alias | Type    | Default   | Description                                                                                                                                                       |
-| -------------------------------- | ----- | ------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `--debug`                        | `-d`  | boolean | `false`   | Run in debug mode with verbose logging                                                                                                                            |
-| `--version`                      | `-v`  | -       | -         | Show CLI version number and exit                                                                                                                                  |
-| `--help`                         | `-h`  | -       | -         | Show help information                                                                                                                                             |
-| `--model`                        | `-m`  | string  | `auto`    | Model to use. See [Model Selection](#model-selection) for available values.                                                                                       |
-| `--prompt`                       | `-p`  | string  | -         | Prompt text. Appended to stdin input if provided. **Deprecated:** Use positional arguments instead.                                                               |
-| `--prompt-interactive`           | `-i`  | string  | -         | Execute prompt and continue in interactive mode                                                                                                                   |
-| `--sandbox`                      | `-s`  | boolean | `false`   | Run in a sandboxed environment for safer execution                                                                                                                |
-| `--approval-mode`                | -     | string  | `default` | Approval mode for tool execution. Choices: `default`, `auto_edit`, `yolo`                                                                                         |
-| `--yolo`                         | `-y`  | boolean | `false`   | **Deprecated.** Auto-approve all actions. Use `--approval-mode=yolo` instead.                                                                                     |
-| `--experimental-acp`             | -     | boolean | -         | Start in ACP (Agent Code Pilot) mode. **Experimental feature.**                                                                                                   |
-| `--experimental-zed-integration` | -     | boolean | -         | Run in Zed editor integration mode. **Experimental feature.**                                                                                                     |
-| `--allowed-mcp-server-names`     | -     | array   | -         | Allowed MCP server names (comma-separated or multiple flags)                                                                                                      |
-| `--allowed-tools`                | -     | array   | -         | **Deprecated.** Use the [Policy Engine](../core/policy-engine.md) instead. Tools that are allowed to run without confirmation (comma-separated or multiple flags) |
-| `--extensions`                   | `-e`  | array   | -         | List of extensions to use. If not provided, all extensions are enabled (comma-separated or multiple flags)                                                        |
-| `--list-extensions`              | `-l`  | boolean | -         | List all available extensions and exit                                                                                                                            |
-| `--resume`                       | `-r`  | string  | -         | Resume a previous session. Use `"latest"` for most recent or index number (e.g. `--resume 5`)                                                                     |
-| `--list-sessions`                | -     | boolean | -         | List available sessions for the current project and exit                                                                                                          |
-| `--delete-session`               | -     | string  | -         | Delete a session by index number (use `--list-sessions` to see available sessions)                                                                                |
-| `--include-directories`          | -     | array   | -         | Additional directories to include in the workspace (comma-separated or multiple flags)                                                                            |
-| `--screen-reader`                | -     | boolean | -         | Enable screen reader mode for accessibility                                                                                                                       |
-| `--output-format`                | `-o`  | string  | `text`    | The format of the CLI output. Choices: `text`, `json`, `stream-json`                                                                                              |
+| Option                           | Alias | Type    | Default   | Description                                                                                                                                                            |
+| -------------------------------- | ----- | ------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `--debug`                        | `-d`  | boolean | `false`   | Run in debug mode with verbose logging                                                                                                                                 |
+| `--version`                      | `-v`  | -       | -         | Show CLI version number and exit                                                                                                                                       |
+| `--help`                         | `-h`  | -       | -         | Show help information                                                                                                                                                  |
+| `--model`                        | `-m`  | string  | `auto`    | Model to use. See [Model Selection](#model-selection) for available values.                                                                                            |
+| `--prompt`                       | `-p`  | string  | -         | Prompt text. Appended to stdin input if provided. **Deprecated:** Use positional arguments instead.                                                                    |
+| `--prompt-interactive`           | `-i`  | string  | -         | Execute prompt and continue in interactive mode                                                                                                                        |
+| `--sandbox`                      | `-s`  | boolean | `false`   | Run in a sandboxed environment for safer execution                                                                                                                     |
+| `--approval-mode`                | -     | string  | `default` | Approval mode for tool execution. Choices: `default`, `auto_edit`, `yolo`                                                                                              |
+| `--yolo`                         | `-y`  | boolean | `false`   | **Deprecated.** Auto-approve all actions. Use `--approval-mode=yolo` instead.                                                                                          |
+| `--experimental-acp`             | -     | boolean | -         | Start in ACP (Agent Code Pilot) mode. **Experimental feature.**                                                                                                        |
+| `--experimental-zed-integration` | -     | boolean | -         | Run in Zed editor integration mode. **Experimental feature.**                                                                                                          |
+| `--allowed-mcp-server-names`     | -     | array   | -         | Allowed MCP server names (comma-separated or multiple flags)                                                                                                           |
+| `--allowed-tools`                | -     | array   | -         | **Deprecated.** Use the [Policy Engine](../reference/policy-engine.md) instead. Tools that are allowed to run without confirmation (comma-separated or multiple flags) |
+| `--extensions`                   | `-e`  | array   | -         | List of extensions to use. If not provided, all extensions are enabled (comma-separated or multiple flags)                                                             |
+| `--list-extensions`              | `-l`  | boolean | -         | List all available extensions and exit                                                                                                                                 |
+| `--resume`                       | `-r`  | string  | -         | Resume a previous session. Use `"latest"` for most recent or index number (e.g. `--resume 5`)                                                                          |
+| `--list-sessions`                | -     | boolean | -         | List available sessions for the current project and exit                                                                                                               |
+| `--delete-session`               | -     | string  | -         | Delete a session by index number (use `--list-sessions` to see available sessions)                                                                                     |
+| `--include-directories`          | -     | array   | -         | Additional directories to include in the workspace (comma-separated or multiple flags)                                                                                 |
+| `--screen-reader`                | -     | boolean | -         | Enable screen reader mode for accessibility                                                                                                                            |
+| `--output-format`                | `-o`  | string  | `text`    | The format of the CLI output. Choices: `text`, `json`, `stream-json`                                                                                                   |
 
 ## Model selection
 

package/dist/docs/cli/enterprise.md

@@ -20,7 +20,7 @@ The most powerful tools for enterprise administration are the system-wide
 settings files. These files allow you to define a baseline configuration
 (`system-defaults.json`) and a set of overrides (`settings.json`) that apply to
 all users on a machine. For a complete overview of configuration options, see
-the [Configuration documentation](../get-started/configuration.md).
+the [Configuration documentation](../reference/configuration.md).
 
 Settings are merged from four files. The precedence order for single-value
 settings (like `theme`) is:
@@ -224,8 +224,8 @@ gemini
 
 You can significantly enhance security by controlling which tools the Gemini
 model can use. This is achieved through the `tools.core` setting and the
-[Policy Engine](../core/policy-engine.md). For a list of available tools, see
-the [Tools documentation](../tools/index.md).
+[Policy Engine](../reference/policy-engine.md). For a list of available tools,
+see the [Tools documentation](../tools/index.md).
 
 ### Allowlisting with `coreTools`
 
@@ -245,8 +245,8 @@ on the approved list.
 
 ### Blocklisting with `excludeTools` (Deprecated)
 
-> **Deprecated:** Use the [Policy Engine](../core/policy-engine.md) for more
-> robust control.
+> **Deprecated:** Use the [Policy Engine](../reference/policy-engine.md) for
+> more robust control.
 
 Alternatively, you can add specific tools that are considered dangerous in your
 environment to a blocklist.
@@ -289,8 +289,8 @@ unintended tool execution.
 ## Managing custom tools (MCP servers)
 
 If your organization uses custom tools via
-[Model-Context Protocol (MCP) servers](../core/tools-api.md), it is crucial to
-understand how server configurations are managed to apply security policies
+[Model-Context Protocol (MCP) servers](../reference/tools-api.md), it is crucial
+to understand how server configurations are managed to apply security policies
 effectively.
 
 ### How MCP server configurations are merged

package/dist/docs/cli/gemini-md.md

@@ -88,7 +88,7 @@ More content here.
 @../shared/style-guide.md
 ```
 
-For more details, see the [Memory Import Processor](../core/memport.md)
+For more details, see the [Memory Import Processor](../reference/memport.md)
 documentation.
 
 ## Customize the context file name

package/dist/docs/cli/model.md

@@ -39,7 +39,7 @@ To enable Gemini 3 Pro and Gemini 3 Flash (if available), enable
 
 You can also use the `--model` flag to specify a particular Gemini model on
 startup. For more details, refer to the
-[configuration documentation](../get-started/configuration.md).
+[configuration documentation](../reference/configuration.md).
 
 Changes to these settings will be applied to all subsequent interactions with
 Gemini CLI.

package/dist/docs/cli/plan-mode.md

@@ -1,50 +1,62 @@
 # Plan Mode (experimental)
 
-Plan Mode is a safe, read-only mode for researching and designing complex
-changes. It prevents modifications while you research, design and plan an
-implementation strategy.
+Plan Mode is a read-only environment for architecting robust solutions before
+implementation. It allows you to:
 
-> **Note: Plan Mode is currently an experimental feature.**
->
-> Experimental features are subject to change. To use Plan Mode, enable it via
-> `/settings` (search for `Plan`) or add the following to your `settings.json`:
->
-> ```json
-> {
->   "experimental": {
->     "plan": true
->   }
-> }
-> ```
->
-> Your feedback is invaluable as we refine this feature. If you have ideas,
+- **Research:** Explore the project in a read-only state to prevent accidental
+  changes.
+- **Design:** Understand problems, evaluate trade-offs, and choose a solution.
+- **Plan:** Align on an execution strategy before any code is modified.
+
+> **Note:** This is a preview feature currently under active development. Your
+> feedback is invaluable as we refine this feature. If you have ideas,
 > suggestions, or encounter issues:
 >
-> - Use the `/bug` command within the CLI to file an issue.
 > - [Open an issue](https://github.com/google-gemini/gemini-cli/issues) on
 >   GitHub.
+> - Use the **/bug** command within Gemini CLI to file an issue.
 
-- [Starting in Plan Mode](#starting-in-plan-mode)
+- [Enabling Plan Mode](#enabling-plan-mode)
 - [How to use Plan Mode](#how-to-use-plan-mode)
   - [Entering Plan Mode](#entering-plan-mode)
-  - [The Planning Workflow](#the-planning-workflow)
+  - [Planning Workflow](#planning-workflow)
   - [Exiting Plan Mode](#exiting-plan-mode)
 - [Tool Restrictions](#tool-restrictions)
   - [Customizing Planning with Skills](#customizing-planning-with-skills)
   - [Customizing Policies](#customizing-policies)
+    - [Example: Allow git commands in Plan Mode](#example-allow-git-commands-in-plan-mode)
+    - [Example: Enable research subagents in Plan Mode](#example-enable-research-subagents-in-plan-mode)
+  - [Custom Plan Directory and Policies](#custom-plan-directory-and-policies)
+- [Automatic Model Routing](#automatic-model-routing)
 
-## Starting in Plan Mode
+## Enabling Plan Mode
 
-You can configure Gemini CLI to start directly in Plan Mode by default:
+To use Plan Mode, enable it via **/settings** (search for **Plan**) or add the
+following to your `settings.json`:
 
-1.  Type `/settings` in the CLI.
-2.  Search for `Default Approval Mode`.
-3.  Set the value to `Plan`.
+```json
+{
+  "experimental": {
+    "plan": true
+  }
+}
+```
 
-Other ways to start in Plan Mode:
+## How to use Plan Mode
 
-- **CLI Flag:** `gemini --approval-mode=plan`
-- **Manual Settings:** Manually update your `settings.json`:
+### Entering Plan Mode
+
+You can configure Gemini CLI to start in Plan Mode by default or enter it
+manually during a session.
+
+- **Configuration:** Configure Gemini CLI to start directly in Plan Mode by
+  default:
+  1.  Type `/settings` in the CLI.
+  2.  Search for **Default Approval Mode**.
+  3.  Set the value to **Plan**.
+
+  Alternatively, use the `gemini --approval-mode=plan` CLI flag or manually
+  update:
 
   ```json
   {
@@ -54,42 +66,44 @@ Other ways to start in Plan Mode:
   }
   ```
 
-## How to use Plan Mode
+- **Keyboard Shortcut:** Press `Shift+Tab` to cycle through approval modes
+  (`Default` -> `Auto-Edit` -> `Plan`).
 
-### Entering Plan Mode
+  > **Note:** Plan Mode is automatically removed from the rotation when Gemini
+  > CLI is actively processing or showing confirmation dialogs.
 
-You can enter Plan Mode in three ways:
+- **Command:** Type `/plan` in the input box.
 
-1.  **Keyboard Shortcut:** Press `Shift+Tab` to cycle through approval modes
-    (`Default` -> `Auto-Edit` -> `Plan`).
+- **Natural Language:** Ask Gemini CLI to "start a plan for...". Gemini CLI then
+  calls the [`enter_plan_mode`] tool to switch modes.
+  > **Note:** This tool is not available when Gemini CLI is in [YOLO mode].
 
-    > **Note:** Plan Mode is automatically removed from the rotation when the
-    > agent is actively processing or showing confirmation dialogs.
+### Planning Workflow
 
-2.  **Command:** Type `/plan` in the input box.
-3.  **Natural Language:** Ask the agent to "start a plan for...". The agent will
-    then call the [`enter_plan_mode`] tool to switch modes.
-
-### The Planning Workflow
-
-1.  **Requirements:** The agent clarifies goals using [`ask_user`].
-2.  **Exploration:** The agent uses read-only tools (like [`read_file`]) to map
-    the codebase and validate assumptions.
-3.  **Design:** The agent proposes alternative approaches with a recommended
-    solution for you to choose from.
-4.  **Planning:** A detailed plan is written to a temporary Markdown file.
-5.  **Review:** You review the plan.
-    - **Approve:** Exit Plan Mode and start implementation (switching to
-      Auto-Edit or Default approval mode).
+1.  **Explore & Analyze:** Analyze requirements and use read-only tools to map
+    the codebase and validate assumptions. For complex tasks, identify at least
+    two viable implementation approaches.
+2.  **Consult:** Present a summary of the identified approaches via [`ask_user`]
+    to obtain a selection. For simple or canonical tasks, this step may be
+    skipped.
+3.  **Draft:** Once an approach is selected, write a detailed implementation
+    plan to the plans directory.
+4.  **Review & Approval:** Use the [`exit_plan_mode`] tool to present the plan
+    and formally request approval.
+    - **Approve:** Exit Plan Mode and start implementation.
     - **Iterate:** Provide feedback to refine the plan.
 
+For more complex or specialized planning tasks, you can
+[customize the planning workflow with skills](#customizing-planning-with-skills).
+
 ### Exiting Plan Mode
 
-To exit Plan Mode:
+To exit Plan Mode, you can:
 
-1. **Keyboard Shortcut:** Press `Shift+Tab` to cycle to the desired mode.
-2. **Tool:** The agent calls the [`exit_plan_mode`] tool to present the
-   finalized plan for your approval.
+- **Keyboard Shortcut:** Press `Shift+Tab` to cycle to the desired mode.
+
+- **Tool:** Gemini CLI calls the [`exit_plan_mode`] tool to present the
+  finalized plan for your approval.
 
 ## Tool Restrictions
 
@@ -102,42 +116,57 @@ These are the only allowed tools:
 - **Interaction:** [`ask_user`]
 - **MCP Tools (Read):** Read-only [MCP tools] (e.g., `github_read_issue`,
   `postgres_read_schema`) are allowed.
-- **Planning (Write):** [`write_file`] and [`replace`] ONLY allowed for `.md`
-  files in the `~/.gemini/tmp/<project>/<session-id>/plans/` directory.
+- **Planning (Write):** [`write_file`] and [`replace`] only allowed for `.md`
+  files in the `~/.gemini/tmp/<project>/<session-id>/plans/` directory or your
+  [custom plans directory](#custom-plan-directory-and-policies).
 - **Skills:** [`activate_skill`] (allows loading specialized instructions and
   resources in a read-only manner)
 
 ### Customizing Planning with Skills
 
-You can leverage [Agent Skills](./skills.md) to customize how Gemini CLI
-approaches planning for specific types of tasks. When a skill is activated
-during Plan Mode, its specialized instructions and procedural workflows will
-guide the research and design phases.
+You can use [Agent Skills](./skills.md) to customize how Gemini CLI approaches
+planning for specific types of tasks. When a skill is activated during Plan
+Mode, its specialized instructions and procedural workflows will guide the
+research, design and planning phases.
 
 For example:
 
 - A **"Database Migration"** skill could ensure the plan includes data safety
   checks and rollback strategies.
-- A **"Security Audit"** skill could prompt the agent to look for specific
+- A **"Security Audit"** skill could prompt Gemini CLI to look for specific
   vulnerabilities during codebase exploration.
-- A **"Frontend Design"** skill could guide the agent to use specific UI
+- A **"Frontend Design"** skill could guide Gemini CLI to use specific UI
   components and accessibility standards in its proposal.
 
-To use a skill in Plan Mode, you can explicitly ask the agent to "use the
-[skill-name] skill to plan..." or the agent may autonomously activate it based
-on the task description.
+To use a skill in Plan Mode, you can explicitly ask Gemini CLI to "use the
+`<skill-name>` skill to plan..." or Gemini CLI may autonomously activate it
+based on the task description.
 
 ### Customizing Policies
 
-Plan Mode is designed to be read-only by default to ensure safety during the
-research phase. However, you may occasionally need to allow specific tools to
-assist in your planning.
+Plan Mode's default tool restrictions are managed by the [policy engine] and
+defined in the built-in [`plan.toml`] file. The built-in policy (Tier 1)
+enforces the read-only state, but you can customize these rules by creating your
+own policies in your `~/.gemini/policies/` directory (Tier 2).
+
+#### Example: Automatically approve read-only MCP tools
+
+By default, read-only MCP tools require user confirmation in Plan Mode. You can
+use `toolAnnotations` and the `mcpName` wildcard to customize this behavior for
+your specific environment.
 
-Because user policies (Tier 2) have a higher base priority than built-in
-policies (Tier 1), you can override Plan Mode's default restrictions by creating
-a rule in your `~/.gemini/policies/` directory.
+`~/.gemini/policies/mcp-read-only.toml`
+
+```toml
+[[rule]]
+mcpName = "*"
+toolAnnotations = { readOnlyHint = true }
+decision = "allow"
+priority = 100
+modes = ["plan"]
+```
 
-#### Example: Allow `git status` and `git diff` in Plan Mode
+#### Example: Allow git commands in Plan Mode
 
 This rule allows you to check the repository status and see changes while in
 Plan Mode.
@@ -153,10 +182,10 @@ priority = 100
 modes = ["plan"]
 ```
 
-#### Example: Enable research sub-agents in Plan Mode
+#### Example: Enable research subagents in Plan Mode
 
-You can enable [experimental research sub-agents] like `codebase_investigator`
-to help gather architecture details during the planning phase.
+You can enable experimental research [subagents] like `codebase_investigator` to
+help gather architecture details during the planning phase.
 
 `~/.gemini/policies/research-subagents.toml`
 
@@ -168,11 +197,77 @@ priority = 100
 modes = ["plan"]
 ```
 
-Tell the agent it can use these tools in your prompt, for example: _"You can
+Tell Gemini CLI it can use these tools in your prompt, for example: _"You can
 check ongoing changes in git."_
 
-For more information on how the policy engine works, see the [Policy Engine
-Guide].
+For more information on how the policy engine works, see the [policy engine]
+docs.
+
+### Custom Plan Directory and Policies
+
+By default, planning artifacts are stored in a managed temporary directory
+outside your project: `~/.gemini/tmp/<project>/<session-id>/plans/`.
+
+You can configure a custom directory for plans in your `settings.json`. For
+example, to store plans in a `.gemini/plans` directory within your project:
+
+```json
+{
+  "general": {
+    "plan": {
+      "directory": ".gemini/plans"
+    }
+  }
+}
+```
+
+To maintain the safety of Plan Mode, user-configured paths for the plans
+directory are restricted to the project root. This ensures that custom planning
+locations defined within a project's workspace cannot be used to escape and
+overwrite sensitive files elsewhere. Any user-configured directory must reside
+within the project boundary.
+
+Using a custom directory requires updating your [policy engine] configurations
+to allow `write_file` and `replace` in that specific location. For example, to
+allow writing to the `.gemini/plans` directory within your project, create a
+policy file at `~/.gemini/policies/plan-custom-directory.toml`:
+
+```toml
+[[rule]]
+toolName = ["write_file", "replace"]
+decision = "allow"
+priority = 100
+modes = ["plan"]
+# Adjust the pattern to match your custom directory.
+# This example matches any .md file in a .gemini/plans directory within the project.
+argsPattern = "\"file_path\":\"[^\"]+[\\\\/]+\\.gemini[\\\\/]+plans[\\\\/]+[\\w-]+\\.md\""
+```
+
+## Automatic Model Routing
+
+When using an [**auto model**], Gemini CLI automatically optimizes [**model
+routing**] based on the current phase of your task:
+
+1.  **Planning Phase:** While in Plan Mode, the CLI routes requests to a
+    high-reasoning **Pro** model to ensure robust architectural decisions and
+    high-quality plans.
+2.  **Implementation Phase:** Once a plan is approved and you exit Plan Mode,
+    the CLI detects the existence of the approved plan and automatically
+    switches to a high-speed **Flash** model. This provides a faster, more
+    responsive experience during the implementation of the plan.
+
+This behavior is enabled by default to provide the best balance of quality and
+performance. You can disable this automatic switching in your settings:
+
+```json
+{
+  "general": {
+    "plan": {
+      "modelRouting": false
+    }
+  }
+}
+```
 
 [`list_directory`]: /docs/tools/file-system.md#1-list_directory-readfolder
 [`read_file`]: /docs/tools/file-system.md#2-read_file-readfile
@@ -183,8 +278,13 @@ Guide].
 [`replace`]: /docs/tools/file-system.md#6-replace-edit
 [MCP tools]: /docs/tools/mcp-server.md
 [`activate_skill`]: /docs/cli/skills.md
-[experimental research sub-agents]: /docs/core/subagents.md
-[Policy Engine Guide]: /docs/core/policy-engine.md
+[subagents]: /docs/core/subagents.md
+[policy engine]: /docs/reference/policy-engine.md
 [`enter_plan_mode`]: /docs/tools/planning.md#1-enter_plan_mode-enterplanmode
 [`exit_plan_mode`]: /docs/tools/planning.md#2-exit_plan_mode-exitplanmode
 [`ask_user`]: /docs/tools/ask-user.md
+[YOLO mode]: /docs/reference/configuration.md#command-line-arguments
+[`plan.toml`]:
+  https://github.com/google-gemini/gemini-cli/blob/main/packages/core/src/policy/policies/plan.toml
+[auto model]: /docs/reference/configuration.md#model-settings
+[model routing]: /docs/cli/telemetry.md#model-routing

package/dist/docs/cli/sandbox.md

@@ -167,6 +167,6 @@ gemini -s -p "run shell command: mount | grep workspace"
 
 ## Related documentation
 
-- [Configuration](../get-started/configuration.md): Full configuration options.
-- [Commands](./commands.md): Available commands.
-- [Troubleshooting](../troubleshooting.md): General troubleshooting.
+- [Configuration](../reference/configuration.md): Full configuration options.
+- [Commands](../reference/commands.md): Available commands.
+- [Troubleshooting](../resources/troubleshooting.md): General troubleshooting.