# Plan Mode (experimental) Plan Mode is a read-only environment for architecting robust solutions before implementation. With Plan Mode, you can: - **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: > > - [Open an issue] on GitHub. > - Use the **/bug** command within Gemini CLI to file an issue. ## How to enable Plan Mode Enable Plan Mode in **Settings** or by editing your configuration file. - **Settings:** Use the `/settings` command and set **Plan** to `true`. - **Configuration:** Add the following to your `settings.json`: ```json { "experimental": { "plan": true } } ``` ## How to enter Plan Mode Plan Mode integrates seamlessly into your workflow, letting you switch between planning and execution as needed. You can either configure Gemini CLI to start in Plan Mode by default or enter Plan Mode manually during a session. ### Launch in Plan Mode To start Gemini CLI directly in Plan Mode by default: 1. Use the `/settings` command. 2. Set **Default Approval Mode** to `Plan`. To launch Gemini CLI in Plan Mode once: 1. Use `gemini --approval-mode=plan` when launching Gemini CLI. ### Enter Plan Mode manually To start Plan Mode while using Gemini CLI: - **Keyboard shortcut:** Press `Shift+Tab` to cycle through approval modes (`Default` -> `Auto-Edit` -> `Plan`). > **Note:** Plan Mode is automatically removed from the rotation when Gemini > CLI is actively processing or showing confirmation dialogs. - **Command:** Type `/plan` in the input box. - **Natural Language:** Ask Gemini CLI to "start a plan for...". Gemini CLI calls the [`enter_plan_mode`](../tools/planning.md#1-enter_plan_mode-enterplanmode) tool to switch modes. > **Note:** This tool is not available when Gemini CLI is in > [YOLO mode](../reference/configuration.md#command-line-arguments). ## How to use Plan Mode Plan Mode lets you collaborate with Gemini CLI to design a solution before Gemini CLI takes action. 1. **Provide a goal:** Start by describing what you want to achieve. Gemini CLI will then enter Plan Mode (if it's not already) to research the task. 2. **Review research and provide input:** As Gemini CLI analyzes your codebase, it may ask you questions or present different implementation options using [`ask_user`](../tools/ask-user.md). Provide your preferences to help guide the design. 3. **Review the plan:** Once Gemini CLI has a proposed strategy, it creates a detailed implementation plan as a Markdown file in your plans directory. You can open and read this file to understand the proposed changes. 4. **Approve or iterate:** Gemini CLI will present the finalized plan for your approval. - **Approve:** If you're satisfied with the plan, approve it to start the implementation immediately: **Yes, automatically accept edits** or **Yes, manually accept edits**. - **Iterate:** If the plan needs adjustments, provide feedback. Gemini CLI will refine the strategy and update the plan. - **Cancel:** You can cancel your plan with `Esc`. For more complex or specialized planning tasks, you can [customize the planning workflow with skills](#custom-planning-with-skills). ## How to exit Plan Mode You can exit Plan Mode at any time, whether you have finalized a plan or want to switch back to another mode. - **Approve a plan:** When Gemini CLI presents a finalized plan, approving it automatically exits Plan Mode and starts the implementation. - **Keyboard shortcut:** Press `Shift+Tab` to cycle to the desired mode. - **Natural language:** Ask Gemini CLI to "exit plan mode" or "stop planning." ## Customization and best practices Plan Mode is secure by default, but you can adapt it to fit your specific workflows. You can customize how Gemini CLI plans by using skills, adjusting safety policies, or changing where plans are stored. ## Commands - **`/plan copy`**: Copy the currently approved plan to your clipboard. ## Tool Restrictions Plan Mode enforces strict safety policies to prevent accidental changes. These are the only allowed tools: - **FileSystem (Read):** [`read_file`](../tools/file-system.md#2-read_file-readfile), [`list_directory`](../tools/file-system.md#1-list_directory-readfolder), [`glob`](../tools/file-system.md#4-glob-findfiles) - **Search:** [`grep_search`](../tools/file-system.md#5-grep_search-searchtext), [`google_web_search`](../tools/web-search.md) - **Research Subagents:** [`codebase_investigator`](../core/subagents.md#codebase-investigator), [`cli_help`](../core/subagents.md#cli-help-agent) - **Interaction:** [`ask_user`](../tools/ask-user.md) - **MCP tools (Read):** Read-only [MCP tools](../tools/mcp-server.md) (for example, `github_read_issue`, `postgres_read_schema`) are allowed. - **Planning (Write):** [`write_file`](../tools/file-system.md#3-write_file-writefile) and [`replace`](../tools/file-system.md#6-replace-edit) only allowed for `.md` files in the `~/.gemini/tmp///plans/` directory or your [custom plans directory](#custom-plan-directory-and-policies). - **Memory:** [`save_memory`](../tools/memory.md) - **Skills:** [`activate_skill`](../cli/skills.md) (allows loading specialized instructions and resources in a read-only manner) ### Custom planning with skills You can use [Agent Skills](../cli/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 Gemini CLI to look for specific vulnerabilities during codebase exploration. - 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 Gemini CLI to "use the `` skill to plan..." or Gemini CLI may autonomously activate it based on the task description. ### Custom policies Plan Mode's default tool restrictions are managed by the [policy engine](../reference/policy-engine.md) 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. `~/.gemini/policies/mcp-read-only.toml` ```toml [[rule]] mcpName = "*" toolAnnotations = { readOnlyHint = true } decision = "allow" priority = 100 modes = ["plan"] ``` For more information on how the policy engine works, see the [policy engine](../reference/policy-engine.md) docs. #### Example: Allow git commands in Plan Mode This rule lets you check the repository status and see changes while in Plan Mode. `~/.gemini/policies/git-research.toml` ```toml [[rule]] toolName = "run_shell_command" commandPrefix = ["git status", "git diff"] decision = "allow" priority = 100 modes = ["plan"] ``` #### Example: Enable custom subagents in Plan Mode Built-in research [subagents](../core/subagents.md) like [`codebase_investigator`](../core/subagents.md#codebase-investigator) and [`cli_help`](../core/subagents.md#cli-help-agent) are enabled by default in Plan Mode. You can enable additional [custom subagents](../core/subagents.md#creating-custom-subagents) by adding a rule to your policy. `~/.gemini/policies/research-subagents.toml` ```toml [[rule]] toolName = "my_custom_subagent" decision = "allow" priority = 100 modes = ["plan"] ``` Tell Gemini CLI it can use these tools in your prompt, for example: _"You can check ongoing changes in git."_ ### Custom plan directory and policies By default, planning artifacts are stored in a managed temporary directory outside your project: `~/.gemini/tmp///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](../reference/policy-engine.md) 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\"" ``` ## Planning workflows Plan Mode provides building blocks for structured research and design. These are implemented as [extensions](../extensions/index.md) using core planning tools like [`enter_plan_mode`](../tools/planning.md#1-enter_plan_mode-enterplanmode), [`exit_plan_mode`](../tools/planning.md#2-exit_plan_mode-exitplanmode), and [`ask_user`](../tools/ask-user.md). ### Built-in planning workflow The built-in planner uses an adaptive workflow to analyze your project, consult you on trade-offs via [`ask_user`](../tools/ask-user.md), and draft a plan for your approval. ### Custom planning workflows You can install or create specialized planners to suit your workflow. #### Conductor [Conductor] is designed for spec-driven development. It organizes work into "tracks" and stores persistent artifacts in your project's `conductor/` directory: - **Automate transitions:** Switches to read-only mode via [`enter_plan_mode`](../tools/planning.md#1-enter_plan_mode-enterplanmode). - **Streamline decisions:** Uses [`ask_user`](../tools/ask-user.md) for architectural choices. - **Maintain project context:** Stores artifacts in the project directory using [custom plan directory and policies](#custom-plan-directory-and-policies). - **Handoff execution:** Transitions to implementation via [`exit_plan_mode`](../tools/planning.md#2-exit_plan_mode-exitplanmode). #### Build your own Since Plan Mode is built on modular building blocks, you can develop your own custom planning workflow as an [extensions](../extensions/index.md). By leveraging core tools and [custom policies](#custom-policies), you can define how Gemini CLI researches and stores plans for your specific domain. To build a custom planning workflow, you can use: - **Tool usage:** Use core tools like [`enter_plan_mode`](../tools/planning.md#1-enter_plan_mode-enterplanmode), [`ask_user`](../tools/ask-user.md), and [`exit_plan_mode`](../tools/planning.md#2-exit_plan_mode-exitplanmode) to manage the research and design process. - **Customization:** Set your own storage locations and policy rules using [custom plan directories](#custom-plan-directory-and-policies) and [custom policies](#custom-policies). > **Note:** Use [Conductor] as a reference when building your own custom > planning workflow. By using Plan Mode as its execution environment, your custom methodology can enforce read-only safety during the design phase while benefiting from high-reasoning model routing. ## Automatic Model Routing When using an [auto model](../reference/configuration.md#model), Gemini CLI automatically optimizes [model routing](../cli/telemetry.md#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 } } } ``` ## Cleanup By default, Gemini CLI automatically cleans up old session data, including all associated plan files and task trackers. - **Default behavior:** Sessions (and their plans) are retained for **30 days**. - **Configuration:** You can customize this behavior via the `/settings` command (search for **Session Retention**) or in your `settings.json` file. See [session retention](../cli/session-management.md#session-retention) for more details. Manual deletion also removes all associated artifacts: - **Command Line:** Use `gemini --delete-session `. - **Session Browser:** Press `/resume`, navigate to a session, and press `x`. If you use a [custom plans directory](#custom-plan-directory-and-policies), those files are not automatically deleted and must be managed manually. [`plan.toml`]: https://github.com/google-gemini/gemini-cli/blob/main/packages/core/src/policy/policies/plan.toml [Conductor]: https://github.com/gemini-cli-extensions/conductor [open an issue]: https://github.com/google-gemini/gemini-cli/issues