docs(plan): update documentation regarding supporting editing of plan files during plan approval (#20452)

Co-authored-by: Jerop Kipruto <jerop@google.com>
This commit is contained in:
Adib234
2026-02-26 19:30:23 -05:00
committed by GitHub
parent 9b7852f11c
commit bc622a443e
3 changed files with 12 additions and 7 deletions
+5
View File
@@ -107,6 +107,10 @@ structure, and consultation level are proportional to the task's complexity:
and formally request approval. and formally request approval.
- **Approve:** Exit Plan Mode and start implementation. - **Approve:** Exit Plan Mode and start implementation.
- **Iterate:** Provide feedback to refine the plan. - **Iterate:** Provide feedback to refine the plan.
- **Refine manually:** Press **Ctrl + X** to open the plan file in your
[preferred external editor]. This allows you to manually refine the plan
steps before approval. The CLI will automatically refresh and show the
updated plan after you save and close the editor.
For more complex or specialized planning tasks, you can For more complex or specialized planning tasks, you can
[customize the planning workflow with skills](#customizing-planning-with-skills). [customize the planning workflow with skills](#customizing-planning-with-skills).
@@ -305,3 +309,4 @@ performance. You can disable this automatic switching in your settings:
https://github.com/google-gemini/gemini-cli/blob/main/packages/core/src/policy/policies/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 [auto model]: /docs/reference/configuration.md#model-settings
[model routing]: /docs/cli/telemetry.md#model-routing [model routing]: /docs/cli/telemetry.md#model-routing
[preferred external editor]: /docs/reference/configuration.md#general
+6 -6
View File
@@ -87,12 +87,12 @@ available combinations.
#### Text Input #### Text Input
| Action | Keys | | Action | Keys |
| ---------------------------------------------- | ----------------------------------------------------------------------------------------- | | ---------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| Submit the current prompt. | `Enter (no Shift, Alt, Ctrl, Cmd)` | | Submit the current prompt. | `Enter (no Shift, Alt, Ctrl, Cmd)` |
| Insert a newline without submitting. | `Ctrl + Enter`<br />`Cmd + Enter`<br />`Alt + Enter`<br />`Shift + Enter`<br />`Ctrl + J` | | Insert a newline without submitting. | `Ctrl + Enter`<br />`Cmd + Enter`<br />`Alt + Enter`<br />`Shift + Enter`<br />`Ctrl + J` |
| Open the current prompt in an external editor. | `Ctrl + X` | | Open the current prompt or the plan in an external editor. | `Ctrl + X` |
| Paste from the clipboard. | `Ctrl + V`<br />`Cmd + V`<br />`Alt + V` | | Paste from the clipboard. | `Ctrl + V`<br />`Cmd + V`<br />`Alt + V` |
#### App Controls #### App Controls
+1 -1
View File
@@ -489,7 +489,7 @@ export const commandDescriptions: Readonly<Record<Command, string>> = {
[Command.SUBMIT]: 'Submit the current prompt.', [Command.SUBMIT]: 'Submit the current prompt.',
[Command.NEWLINE]: 'Insert a newline without submitting.', [Command.NEWLINE]: 'Insert a newline without submitting.',
[Command.OPEN_EXTERNAL_EDITOR]: [Command.OPEN_EXTERNAL_EDITOR]:
'Open the current prompt in an external editor.', 'Open the current prompt or the plan in an external editor.',
[Command.PASTE_CLIPBOARD]: 'Paste from the clipboard.', [Command.PASTE_CLIPBOARD]: 'Paste from the clipboard.',
// App Controls // App Controls