Skip to content

Commit 0bf674d

Browse files
jeropkunal-10-cloud
authored andcommitted
docs: document planning workflows with Conductor example (google-gemini#21166)
1 parent 6f4b30a commit 0bf674d

File tree

1 file changed

+83
-31
lines changed

1 file changed

+83
-31
lines changed

docs/cli/plan-mode.md

Lines changed: 83 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,7 @@ implementation. With Plan Mode, you can:
1212
> feedback is invaluable as we refine this feature. If you have ideas,
1313
> suggestions, or encounter issues:
1414
>
15-
> - [Open an issue](https://github.com/google-gemini/gemini-cli/issues) on
16-
> GitHub.
15+
> - [Open an issue] on GitHub.
1716
> - Use the **/bug** command within Gemini CLI to file an issue.
1817
1918
## How to enable Plan Mode
@@ -132,10 +131,10 @@ These are the only allowed tools:
132131

133132
### Custom planning with skills
134133

135-
You can use [Agent Skills](./skills.md) to customize how Gemini CLI approaches
136-
planning for specific types of tasks. When a skill is activated during Plan
137-
Mode, its specialized instructions and procedural workflows will guide the
138-
research, design, and planning phases.
134+
You can use [Agent Skills] to customize how Gemini CLI approaches planning for
135+
specific types of tasks. When a skill is activated during Plan Mode, its
136+
specialized instructions and procedural workflows will guide the research,
137+
design, and planning phases.
139138

140139
For example:
141140

@@ -252,10 +251,59 @@ modes = ["plan"]
252251
argsPattern = "\"file_path\":\"[^\"]+[\\\\/]+\\.gemini[\\\\/]+plans[\\\\/]+[\\w-]+\\.md\""
253252
```
254253

254+
## Planning workflows
255+
256+
Plan Mode provides building blocks for structured research and design. These are
257+
implemented as [extensions] using core planning tools like [`enter_plan_mode`],
258+
[`exit_plan_mode`], and [`ask_user`].
259+
260+
### Built-in planning workflow
261+
262+
The built-in planner uses an adaptive workflow to analyze your project, consult
263+
you on trade-offs via [`ask_user`], and draft a plan for your approval.
264+
265+
### Custom planning workflows
266+
267+
You can install or create specialized planners to suit your workflow.
268+
269+
#### Conductor
270+
271+
[Conductor] is designed for spec-driven development. It organizes work into
272+
"tracks" and stores persistent artifacts in your project's `conductor/`
273+
directory:
274+
275+
- **Automate transitions:** Switches to read-only mode via [`enter_plan_mode`].
276+
- **Streamline decisions:** Uses [`ask_user`] for architectural choices.
277+
- **Maintain project context:** Stores artifacts in the project directory using
278+
[custom plan directory and policies](#custom-plan-directory-and-policies).
279+
- **Handoff execution:** Transitions to implementation via [`exit_plan_mode`].
280+
281+
#### Build your own
282+
283+
Since Plan Mode is built on modular building blocks, you can develop your own
284+
custom planning workflow as an [extensions]. By leveraging core tools and
285+
[custom policies](#custom-policies), you can define how Gemini CLI researches
286+
and stores plans for your specific domain.
287+
288+
To build a custom planning workflow, you can use:
289+
290+
- **Tool usage:** Use core tools like [`enter_plan_mode`], [`ask_user`], and
291+
[`exit_plan_mode`] to manage the research and design process.
292+
- **Customization:** Set your own storage locations and policy rules using
293+
[custom plan directories](#custom-plan-directory-and-policies) and
294+
[custom policies](#custom-policies).
295+
296+
> **Note:** Use [Conductor] as a reference when building your own custom
297+
> planning workflow.
298+
299+
By using Plan Mode as its execution environment, your custom methodology can
300+
enforce read-only safety during the design phase while benefiting from
301+
high-reasoning model routing.
302+
255303
## Automatic Model Routing
256304

257-
When using an [**auto model**], Gemini CLI automatically optimizes [**model
258-
routing**] based on the current phase of your task:
305+
When using an [auto model], Gemini CLI automatically optimizes [model routing]
306+
based on the current phase of your task:
259307

260308
1. **Planning Phase:** While in Plan Mode, the CLI routes requests to a
261309
high-reasoning **Pro** model to ensure robust architectural decisions and
@@ -296,28 +344,32 @@ Manual deletion also removes all associated artifacts:
296344
If you use a [custom plans directory](#custom-plan-directory-and-policies),
297345
those files are not automatically deleted and must be managed manually.
298346

299-
[`list_directory`]: /docs/tools/file-system.md#1-list_directory-readfolder
300-
[`read_file`]: /docs/tools/file-system.md#2-read_file-readfile
301-
[`grep_search`]: /docs/tools/file-system.md#5-grep_search-searchtext
302-
[`write_file`]: /docs/tools/file-system.md#3-write_file-writefile
303-
[`glob`]: /docs/tools/file-system.md#4-glob-findfiles
304-
[`google_web_search`]: /docs/tools/web-search.md
305-
[`replace`]: /docs/tools/file-system.md#6-replace-edit
306-
[MCP tools]: /docs/tools/mcp-server.md
307-
[`save_memory`]: /docs/tools/memory.md
308-
[`activate_skill`]: /docs/cli/skills.md
309-
[`codebase_investigator`]: /docs/core/subagents.md#codebase_investigator
310-
[`cli_help`]: /docs/core/subagents.md#cli_help
311-
[subagents]: /docs/core/subagents.md
312-
[custom subagents]: /docs/core/subagents.md#creating-custom-subagents
313-
[policy engine]: /docs/reference/policy-engine.md
314-
[`enter_plan_mode`]: /docs/tools/planning.md#1-enter_plan_mode-enterplanmode
315-
[`exit_plan_mode`]: /docs/tools/planning.md#2-exit_plan_mode-exitplanmode
316-
[`ask_user`]: /docs/tools/ask-user.md
317-
[YOLO mode]: /docs/reference/configuration.md#command-line-arguments
347+
[`list_directory`]: ../tools/file-system.md#1-list_directory-readfolder
348+
[`read_file`]: ../tools/file-system.md#2-read_file-readfile
349+
[`grep_search`]: ../tools/file-system.md#5-grep_search-searchtext
350+
[`write_file`]: ../tools/file-system.md#3-write_file-writefile
351+
[`glob`]: ../tools/file-system.md#4-glob-findfiles
352+
[`google_web_search`]: ../tools/web-search.md
353+
[`replace`]: ../tools/file-system.md#6-replace-edit
354+
[MCP tools]: ../tools/mcp-server.md
355+
[`save_memory`]: ../tools/memory.md
356+
[`activate_skill`]: ./skills.md
357+
[`codebase_investigator`]: ../core/subagents.md#codebase_investigator
358+
[`cli_help`]: ../core/subagents.md#cli_help
359+
[subagents]: ../core/subagents.md
360+
[custom subagents]: ../core/subagents.md#creating-custom-subagents
361+
[policy engine]: ../reference/policy-engine.md
362+
[`enter_plan_mode`]: ../tools/planning.md#1-enter_plan_mode-enterplanmode
363+
[`exit_plan_mode`]: ../tools/planning.md#2-exit_plan_mode-exitplanmode
364+
[`ask_user`]: ../tools/ask-user.md
365+
[YOLO mode]: ../reference/configuration.md#command-line-arguments
318366
[`plan.toml`]:
319367
https://github.com/google-gemini/gemini-cli/blob/main/packages/core/src/policy/policies/plan.toml
320-
[auto model]: /docs/reference/configuration.md#model-settings
321-
[model routing]: /docs/cli/telemetry.md#model-routing
322-
[preferred external editor]: /docs/reference/configuration.md#general
323-
[session retention]: /docs/cli/session-management.md#session-retention
368+
[auto model]: ../reference/configuration.md#model-settings
369+
[model routing]: ./telemetry.md#model-routing
370+
[preferred external editor]: ../reference/configuration.md#general
371+
[session retention]: ./session-management.md#session-retention
372+
[extensions]: ../extensions/index.md
373+
[Conductor]: https://github.com/gemini-cli-extensions/conductor
374+
[open an issue]: https://github.com/google-gemini/gemini-cli/issues
375+
[Agent Skills]: ./skills.md

0 commit comments

Comments
 (0)