@thacio/auditaria 0.30.13 → 0.30.14
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/bundle/docs/CONTRIBUTING.md +6 -7
- package/bundle/docs/changelogs/index.md +2 -1
- package/bundle/docs/changelogs/preview.md +2 -2
- package/bundle/docs/cli/cli-reference.md +23 -23
- package/bundle/docs/cli/enterprise.md +7 -7
- package/bundle/docs/cli/gemini-md.md +1 -1
- package/bundle/docs/cli/model.md +5 -6
- package/bundle/docs/cli/plan-mode.md +129 -74
- package/bundle/docs/cli/sandbox.md +3 -3
- package/bundle/docs/cli/settings.md +31 -30
- package/bundle/docs/cli/telemetry.md +1 -1
- package/bundle/docs/cli/themes.md +3 -3
- package/bundle/docs/cli/trusted-folders.md +31 -0
- package/bundle/docs/cli/tutorials/memory-management.md +2 -2
- package/bundle/docs/cli/tutorials/session-management.md +1 -1
- package/bundle/docs/core/index.md +7 -7
- package/bundle/docs/core/subagents.md +1 -1
- package/bundle/docs/extensions/reference.md +1 -1
- package/bundle/docs/get-started/authentication.md +4 -4
- package/bundle/docs/get-started/gemini-3.md +17 -3
- package/bundle/docs/get-started/index.md +1 -1
- package/bundle/docs/hooks/best-practices.md +1 -1
- package/bundle/docs/index.md +20 -47
- package/bundle/docs/redirects.json +19 -0
- package/bundle/docs/{cli → reference}/commands.md +6 -4
- package/bundle/docs/{get-started → reference}/configuration.md +21 -7
- package/bundle/docs/{core → reference}/policy-engine.md +17 -13
- package/bundle/docs/{faq.md → resources/faq.md} +1 -1
- package/bundle/docs/{tos-privacy.md → resources/tos-privacy.md} +3 -3
- package/bundle/docs/{troubleshooting.md → resources/troubleshooting.md} +8 -8
- package/bundle/docs/{cli → resources}/uninstall.md +2 -3
- package/bundle/docs/sidebar.json +221 -167
- package/bundle/docs/tools/index.md +2 -2
- package/bundle/docs/tools/internal-docs.md +5 -5
- package/bundle/docs/tools/planning.md +2 -0
- package/bundle/docs/tools/shell.md +3 -3
- package/bundle/gemini.js +141045 -124937
- package/bundle/node_modules/@browserbasehq/stagehand/dist/index.js +3590 -1090
- package/bundle/policies/plan.toml +19 -10
- package/bundle/policies/read-only.toml +11 -10
- package/bundle/policies/write.toml +11 -10
- package/bundle/policies/yolo.toml +11 -10
- package/package.json +4 -2
- /package/bundle/docs/{cli → reference}/keyboard-shortcuts.md +0 -0
- /package/bundle/docs/{core → reference}/memport.md +0 -0
- /package/bundle/docs/{core → reference}/tools-api.md +0 -0
- /package/bundle/docs/{quota-and-pricing.md → resources/quota-and-pricing.md} +0 -0
|
@@ -224,18 +224,17 @@ To skip building the sandbox container, you can use `npm run build` instead.
|
|
|
224
224
|
|
|
225
225
|
### Running the CLI
|
|
226
226
|
|
|
227
|
-
To start the Auditaria from the source code (after building), run the
|
|
228
|
-
|
|
227
|
+
To start the Auditaria from the source code (after building), run the following
|
|
228
|
+
command from the root directory:
|
|
229
229
|
|
|
230
230
|
```bash
|
|
231
231
|
npm start
|
|
232
232
|
```
|
|
233
233
|
|
|
234
|
-
If you'd like to run the source build outside of the auditaria folder, you
|
|
235
|
-
|
|
234
|
+
If you'd like to run the source build outside of the auditaria folder, you can
|
|
235
|
+
utilize `npm link path/to/auditaria/packages/cli` (see:
|
|
236
236
|
[docs](https://docs.npmjs.com/cli/v9/commands/npm-link)) or
|
|
237
|
-
`alias auditaria="node path/to/auditaria/packages/cli"` to run with
|
|
238
|
-
`auditaria`
|
|
237
|
+
`alias auditaria="node path/to/auditaria/packages/cli"` to run with `auditaria`
|
|
239
238
|
|
|
240
239
|
### Running tests
|
|
241
240
|
|
|
@@ -547,7 +546,7 @@ Before submitting your documentation pull request, please:
|
|
|
547
546
|
|
|
548
547
|
If you have questions about contributing documentation:
|
|
549
548
|
|
|
550
|
-
- Check our [FAQ](/docs/faq.md).
|
|
549
|
+
- Check our [FAQ](/docs/resources/faq.md).
|
|
551
550
|
- Review existing documentation for examples.
|
|
552
551
|
- Open [an issue](https://github.com/google-gemini/gemini-cli/issues) to discuss
|
|
553
552
|
your proposed changes.
|
|
@@ -295,7 +295,8 @@ on GitHub.
|
|
|
295
295
|
- **Experimental permission improvements:** We are now experimenting with a new
|
|
296
296
|
policy engine in Gemini CLI. This allows users and administrators to create
|
|
297
297
|
fine-grained policy for tool calls. Currently behind a flag. See
|
|
298
|
-
[policy engine documentation](../
|
|
298
|
+
[policy engine documentation](../reference/policy-engine.md) for more
|
|
299
|
+
information.
|
|
299
300
|
- Blog:
|
|
300
301
|
[https://allen.hutchison.org/2025/11/26/the-guardrails-of-autonomy/](https://allen.hutchison.org/2025/11/26/the-guardrails-of-autonomy/)
|
|
301
302
|
- **Gemini 3 support for paid:** Gemini 3 support has been rolled out to all API
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Preview release: v0.30.0-preview.
|
|
1
|
+
# Preview release: v0.30.0-preview.3
|
|
2
2
|
|
|
3
3
|
Released: February 19, 2026
|
|
4
4
|
|
|
@@ -311,4 +311,4 @@ npm install -g @google/gemini-cli@preview
|
|
|
311
311
|
[#19008](https://github.com/google-gemini/gemini-cli/pull/19008)
|
|
312
312
|
|
|
313
313
|
**Full changelog**:
|
|
314
|
-
https://github.com/google-gemini/gemini-cli/compare/v0.29.0-preview.5...v0.30.0-preview.
|
|
314
|
+
https://github.com/google-gemini/gemini-cli/compare/v0.29.0-preview.5...v0.30.0-preview.3
|
|
@@ -26,29 +26,29 @@ and parameters.
|
|
|
26
26
|
|
|
27
27
|
## CLI Options
|
|
28
28
|
|
|
29
|
-
| Option | Alias | Type | Default | Description
|
|
30
|
-
| -------------------------------- | ----- | ------- | --------- |
|
|
31
|
-
| `--debug` | `-d` | boolean | `false` | Run in debug mode with verbose logging
|
|
32
|
-
| `--version` | `-v` | - | - | Show CLI version number and exit
|
|
33
|
-
| `--help` | `-h` | - | - | Show help information
|
|
34
|
-
| `--model` | `-m` | string | `auto` | Model to use. See [Model Selection](#model-selection) for available values.
|
|
35
|
-
| `--prompt` | `-p` | string | - | Prompt text. Appended to stdin input if provided. **Deprecated:** Use positional arguments instead.
|
|
36
|
-
| `--prompt-interactive` | `-i` | string | - | Execute prompt and continue in interactive mode
|
|
37
|
-
| `--sandbox` | `-s` | boolean | `false` | Run in a sandboxed environment for safer execution
|
|
38
|
-
| `--approval-mode` | - | string | `default` | Approval mode for tool execution. Choices: `default`, `auto_edit`, `yolo`
|
|
39
|
-
| `--yolo` | `-y` | boolean | `false` | **Deprecated.** Auto-approve all actions. Use `--approval-mode=yolo` instead.
|
|
40
|
-
| `--experimental-acp` | - | boolean | - | Start in ACP (Agent Code Pilot) mode. **Experimental feature.**
|
|
41
|
-
| `--experimental-zed-integration` | - | boolean | - | Run in Zed editor integration mode. **Experimental feature.**
|
|
42
|
-
| `--allowed-mcp-server-names` | - | array | - | Allowed MCP server names (comma-separated or multiple flags)
|
|
43
|
-
| `--allowed-tools` | - | array | - | **Deprecated.** Use the [Policy Engine](../
|
|
44
|
-
| `--extensions` | `-e` | array | - | List of extensions to use. If not provided, all extensions are enabled (comma-separated or multiple flags)
|
|
45
|
-
| `--list-extensions` | `-l` | boolean | - | List all available extensions and exit
|
|
46
|
-
| `--resume` | `-r` | string | - | Resume a previous session. Use `"latest"` for most recent or index number (e.g. `--resume 5`)
|
|
47
|
-
| `--list-sessions` | - | boolean | - | List available sessions for the current project and exit
|
|
48
|
-
| `--delete-session` | - | string | - | Delete a session by index number (use `--list-sessions` to see available sessions)
|
|
49
|
-
| `--include-directories` | - | array | - | Additional directories to include in the workspace (comma-separated or multiple flags)
|
|
50
|
-
| `--screen-reader` | - | boolean | - | Enable screen reader mode for accessibility
|
|
51
|
-
| `--output-format` | `-o` | string | `text` | The format of the CLI output. Choices: `text`, `json`, `stream-json`
|
|
29
|
+
| Option | Alias | Type | Default | Description |
|
|
30
|
+
| -------------------------------- | ----- | ------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
31
|
+
| `--debug` | `-d` | boolean | `false` | Run in debug mode with verbose logging |
|
|
32
|
+
| `--version` | `-v` | - | - | Show CLI version number and exit |
|
|
33
|
+
| `--help` | `-h` | - | - | Show help information |
|
|
34
|
+
| `--model` | `-m` | string | `auto` | Model to use. See [Model Selection](#model-selection) for available values. |
|
|
35
|
+
| `--prompt` | `-p` | string | - | Prompt text. Appended to stdin input if provided. **Deprecated:** Use positional arguments instead. |
|
|
36
|
+
| `--prompt-interactive` | `-i` | string | - | Execute prompt and continue in interactive mode |
|
|
37
|
+
| `--sandbox` | `-s` | boolean | `false` | Run in a sandboxed environment for safer execution |
|
|
38
|
+
| `--approval-mode` | - | string | `default` | Approval mode for tool execution. Choices: `default`, `auto_edit`, `yolo` |
|
|
39
|
+
| `--yolo` | `-y` | boolean | `false` | **Deprecated.** Auto-approve all actions. Use `--approval-mode=yolo` instead. |
|
|
40
|
+
| `--experimental-acp` | - | boolean | - | Start in ACP (Agent Code Pilot) mode. **Experimental feature.** |
|
|
41
|
+
| `--experimental-zed-integration` | - | boolean | - | Run in Zed editor integration mode. **Experimental feature.** |
|
|
42
|
+
| `--allowed-mcp-server-names` | - | array | - | Allowed MCP server names (comma-separated or multiple flags) |
|
|
43
|
+
| `--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) |
|
|
44
|
+
| `--extensions` | `-e` | array | - | List of extensions to use. If not provided, all extensions are enabled (comma-separated or multiple flags) |
|
|
45
|
+
| `--list-extensions` | `-l` | boolean | - | List all available extensions and exit |
|
|
46
|
+
| `--resume` | `-r` | string | - | Resume a previous session. Use `"latest"` for most recent or index number (e.g. `--resume 5`) |
|
|
47
|
+
| `--list-sessions` | - | boolean | - | List available sessions for the current project and exit |
|
|
48
|
+
| `--delete-session` | - | string | - | Delete a session by index number (use `--list-sessions` to see available sessions) |
|
|
49
|
+
| `--include-directories` | - | array | - | Additional directories to include in the workspace (comma-separated or multiple flags) |
|
|
50
|
+
| `--screen-reader` | - | boolean | - | Enable screen reader mode for accessibility |
|
|
51
|
+
| `--output-format` | `-o` | string | `text` | The format of the CLI output. Choices: `text`, `json`, `stream-json` |
|
|
52
52
|
|
|
53
53
|
## Model selection
|
|
54
54
|
|
|
@@ -20,7 +20,7 @@ The most powerful tools for enterprise administration are the system-wide
|
|
|
20
20
|
settings files. These files allow you to define a baseline configuration
|
|
21
21
|
(`system-defaults.json`) and a set of overrides (`settings.json`) that apply to
|
|
22
22
|
all users on a machine. For a complete overview of configuration options, see
|
|
23
|
-
the [Configuration documentation](
|
|
23
|
+
the [Configuration documentation](../reference/configuration.md).
|
|
24
24
|
|
|
25
25
|
Settings are merged from four files. The precedence order for single-value
|
|
26
26
|
settings (like `theme`) is:
|
|
@@ -224,8 +224,8 @@ gemini
|
|
|
224
224
|
|
|
225
225
|
You can significantly enhance security by controlling which tools the Auditaria
|
|
226
226
|
model can use. This is achieved through the `tools.core` setting and the
|
|
227
|
-
[Policy Engine](../
|
|
228
|
-
the [Tools documentation](../tools/index.md).
|
|
227
|
+
[Policy Engine](../reference/policy-engine.md). For a list of available tools,
|
|
228
|
+
see the [Tools documentation](../tools/index.md).
|
|
229
229
|
|
|
230
230
|
### Allowlisting with `coreTools`
|
|
231
231
|
|
|
@@ -245,8 +245,8 @@ on the approved list.
|
|
|
245
245
|
|
|
246
246
|
### Blocklisting with `excludeTools` (Deprecated)
|
|
247
247
|
|
|
248
|
-
> **Deprecated:** Use the [Policy Engine](../
|
|
249
|
-
> robust control.
|
|
248
|
+
> **Deprecated:** Use the [Policy Engine](../reference/policy-engine.md) for
|
|
249
|
+
> more robust control.
|
|
250
250
|
|
|
251
251
|
Alternatively, you can add specific tools that are considered dangerous in your
|
|
252
252
|
environment to a blocklist.
|
|
@@ -289,8 +289,8 @@ unintended tool execution.
|
|
|
289
289
|
## Managing custom tools (MCP servers)
|
|
290
290
|
|
|
291
291
|
If your organization uses custom tools via
|
|
292
|
-
[Model-Context Protocol (MCP) servers](../
|
|
293
|
-
understand how server configurations are managed to apply security policies
|
|
292
|
+
[Model-Context Protocol (MCP) servers](../reference/tools-api.md), it is crucial
|
|
293
|
+
to understand how server configurations are managed to apply security policies
|
|
294
294
|
effectively.
|
|
295
295
|
|
|
296
296
|
### How MCP server configurations are merged
|
|
@@ -88,7 +88,7 @@ More content here.
|
|
|
88
88
|
@../shared/style-guide.md
|
|
89
89
|
```
|
|
90
90
|
|
|
91
|
-
For more details, see the [Memory Import Processor](../
|
|
91
|
+
For more details, see the [Memory Import Processor](../reference/memport.md)
|
|
92
92
|
documentation.
|
|
93
93
|
|
|
94
94
|
## Customize the context file name
|
package/bundle/docs/cli/model.md
CHANGED
|
@@ -1,10 +1,9 @@
|
|
|
1
1
|
# Auditaria model selection (`/model` command)
|
|
2
2
|
|
|
3
|
-
Select your Auditaria model. The `/model` command lets you configure the
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
tasks.
|
|
3
|
+
Select your Auditaria model. The `/model` command lets you configure the model
|
|
4
|
+
used by Auditaria, giving you more control over your results. Use **Pro** models
|
|
5
|
+
for complex tasks and reasoning, **Flash** models for high speed results, or the
|
|
6
|
+
(recommended) **Auto** setting to choose the best model for your tasks.
|
|
8
7
|
|
|
9
8
|
> **Note:** The `/model` command (and the `--model` flag) does not override the
|
|
10
9
|
> model used by sub-agents. Consequently, even when using the `/model` flag you
|
|
@@ -40,7 +39,7 @@ To enable Gemini 3 Pro and Gemini 3 Flash (if available), enable
|
|
|
40
39
|
|
|
41
40
|
You can also use the `--model` flag to specify a particular Gemini model on
|
|
42
41
|
startup. For more details, refer to the
|
|
43
|
-
[configuration documentation](../
|
|
42
|
+
[configuration documentation](../reference/configuration.md).
|
|
44
43
|
|
|
45
44
|
Changes to these settings will be applied to all subsequent interactions with
|
|
46
45
|
Auditaria.
|
|
@@ -1,50 +1,61 @@
|
|
|
1
1
|
# Plan Mode (experimental)
|
|
2
2
|
|
|
3
|
-
Plan Mode is a
|
|
4
|
-
|
|
5
|
-
implementation strategy.
|
|
3
|
+
Plan Mode is a read-only environment for architecting robust solutions before
|
|
4
|
+
implementation. It allows you to:
|
|
6
5
|
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
>
|
|
13
|
-
>
|
|
14
|
-
> "experimental": {
|
|
15
|
-
> "plan": true
|
|
16
|
-
> }
|
|
17
|
-
> }
|
|
18
|
-
> ```
|
|
19
|
-
>
|
|
20
|
-
> Your feedback is invaluable as we refine this feature. If you have ideas,
|
|
6
|
+
- **Research:** Explore the project in a read-only state to prevent accidental
|
|
7
|
+
changes.
|
|
8
|
+
- **Design:** Understand problems, evaluate trade-offs, and choose a solution.
|
|
9
|
+
- **Plan:** Align on an execution strategy before any code is modified.
|
|
10
|
+
|
|
11
|
+
> **Note:** This is a preview feature currently under active development. Your
|
|
12
|
+
> feedback is invaluable as we refine this feature. If you have ideas,
|
|
21
13
|
> suggestions, or encounter issues:
|
|
22
14
|
>
|
|
23
|
-
> - Use the `/bug` command within the CLI to file an issue.
|
|
24
15
|
> - [Open an issue](https://github.com/google-gemini/gemini-cli/issues) on
|
|
25
16
|
> GitHub.
|
|
17
|
+
> - Use the **/bug** command within Gemini CLI to file an issue.
|
|
26
18
|
|
|
27
|
-
- [
|
|
19
|
+
- [Enabling Plan Mode](#enabling-plan-mode)
|
|
28
20
|
- [How to use Plan Mode](#how-to-use-plan-mode)
|
|
29
21
|
- [Entering Plan Mode](#entering-plan-mode)
|
|
30
|
-
- [
|
|
22
|
+
- [Planning Workflow](#planning-workflow)
|
|
31
23
|
- [Exiting Plan Mode](#exiting-plan-mode)
|
|
32
24
|
- [Tool Restrictions](#tool-restrictions)
|
|
33
25
|
- [Customizing Planning with Skills](#customizing-planning-with-skills)
|
|
34
26
|
- [Customizing Policies](#customizing-policies)
|
|
27
|
+
- [Example: Allow git commands in Plan Mode](#example-allow-git-commands-in-plan-mode)
|
|
28
|
+
- [Example: Enable research subagents in Plan Mode](#example-enable-research-subagents-in-plan-mode)
|
|
29
|
+
- [Custom Plan Directory and Policies](#custom-plan-directory-and-policies)
|
|
35
30
|
|
|
36
|
-
##
|
|
31
|
+
## Enabling Plan Mode
|
|
37
32
|
|
|
38
|
-
|
|
33
|
+
To use Plan Mode, enable it via **/settings** (search for **Plan**) or add the
|
|
34
|
+
following to your `settings.json`:
|
|
39
35
|
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
36
|
+
```json
|
|
37
|
+
{
|
|
38
|
+
"experimental": {
|
|
39
|
+
"plan": true
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
## How to use Plan Mode
|
|
43
45
|
|
|
44
|
-
|
|
46
|
+
### Entering Plan Mode
|
|
45
47
|
|
|
46
|
-
|
|
47
|
-
|
|
48
|
+
You can configure Gemini CLI to start in Plan Mode by default or enter it
|
|
49
|
+
manually during a session.
|
|
50
|
+
|
|
51
|
+
- **Configuration:** Configure Gemini CLI to start directly in Plan Mode by
|
|
52
|
+
default:
|
|
53
|
+
1. Type `/settings` in the CLI.
|
|
54
|
+
2. Search for **Default Approval Mode**.
|
|
55
|
+
3. Set the value to **Plan**.
|
|
56
|
+
|
|
57
|
+
Alternatively, use the `gemini --approval-mode=plan` CLI flag or manually
|
|
58
|
+
update:
|
|
48
59
|
|
|
49
60
|
```json
|
|
50
61
|
{
|
|
@@ -54,42 +65,44 @@ Other ways to start in Plan Mode:
|
|
|
54
65
|
}
|
|
55
66
|
```
|
|
56
67
|
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
### Entering Plan Mode
|
|
60
|
-
|
|
61
|
-
You can enter Plan Mode in three ways:
|
|
68
|
+
- **Keyboard Shortcut:** Press `Shift+Tab` to cycle through approval modes
|
|
69
|
+
(`Default` -> `Auto-Edit` -> `Plan`).
|
|
62
70
|
|
|
63
|
-
|
|
64
|
-
|
|
71
|
+
> **Note:** Plan Mode is automatically removed from the rotation when Gemini
|
|
72
|
+
> CLI is actively processing or showing confirmation dialogs.
|
|
65
73
|
|
|
66
|
-
|
|
67
|
-
> agent is actively processing or showing confirmation dialogs.
|
|
74
|
+
- **Command:** Type `/plan` in the input box.
|
|
68
75
|
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
76
|
+
- **Natural Language:** Ask Gemini CLI to "start a plan for...". Gemini CLI then
|
|
77
|
+
calls the [`enter_plan_mode`] tool to switch modes.
|
|
78
|
+
> **Note:** This tool is not available when Gemini CLI is in [YOLO mode].
|
|
72
79
|
|
|
73
|
-
###
|
|
80
|
+
### Planning Workflow
|
|
74
81
|
|
|
75
|
-
1. **
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
82
|
+
1. **Explore & Analyze:** Analyze requirements and use read-only tools to map
|
|
83
|
+
the codebase and validate assumptions. For complex tasks, identify at least
|
|
84
|
+
two viable implementation approaches.
|
|
85
|
+
2. **Consult:** Present a summary of the identified approaches via [`ask_user`]
|
|
86
|
+
to obtain a selection. For simple or canonical tasks, this step may be
|
|
87
|
+
skipped.
|
|
88
|
+
3. **Draft:** Once an approach is selected, write a detailed implementation
|
|
89
|
+
plan to the plans directory.
|
|
90
|
+
4. **Review & Approval:** Use the [`exit_plan_mode`] tool to present the plan
|
|
91
|
+
and formally request approval.
|
|
92
|
+
- **Approve:** Exit Plan Mode and start implementation.
|
|
84
93
|
- **Iterate:** Provide feedback to refine the plan.
|
|
85
94
|
|
|
95
|
+
For more complex or specialized planning tasks, you can
|
|
96
|
+
[customize the planning workflow with skills](#customizing-planning-with-skills).
|
|
97
|
+
|
|
86
98
|
### Exiting Plan Mode
|
|
87
99
|
|
|
88
|
-
To exit Plan Mode:
|
|
100
|
+
To exit Plan Mode, you can:
|
|
101
|
+
|
|
102
|
+
- **Keyboard Shortcut:** Press `Shift+Tab` to cycle to the desired mode.
|
|
89
103
|
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
finalized plan for your approval.
|
|
104
|
+
- **Tool:** Gemini CLI calls the [`exit_plan_mode`] tool to present the
|
|
105
|
+
finalized plan for your approval.
|
|
93
106
|
|
|
94
107
|
## Tool Restrictions
|
|
95
108
|
|
|
@@ -102,30 +115,31 @@ These are the only allowed tools:
|
|
|
102
115
|
- **Interaction:** [`ask_user`]
|
|
103
116
|
- **MCP Tools (Read):** Read-only [MCP tools] (e.g., `github_read_issue`,
|
|
104
117
|
`postgres_read_schema`) are allowed.
|
|
105
|
-
- **Planning (Write):** [`write_file`] and [`replace`]
|
|
106
|
-
files in the `~/.gemini/tmp/<project>/<session-id>/plans/` directory
|
|
118
|
+
- **Planning (Write):** [`write_file`] and [`replace`] only allowed for `.md`
|
|
119
|
+
files in the `~/.gemini/tmp/<project>/<session-id>/plans/` directory or your
|
|
120
|
+
[custom plans directory](#custom-plan-directory-and-policies).
|
|
107
121
|
- **Skills:** [`activate_skill`] (allows loading specialized instructions and
|
|
108
122
|
resources in a read-only manner)
|
|
109
123
|
|
|
110
124
|
### Customizing Planning with Skills
|
|
111
125
|
|
|
112
|
-
You can
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
126
|
+
You can use [Agent Skills](./skills.md) to customize how Gemini CLI approaches
|
|
127
|
+
planning for specific types of tasks. When a skill is activated during Plan
|
|
128
|
+
Mode, its specialized instructions and procedural workflows will guide the
|
|
129
|
+
research, design and planning phases.
|
|
116
130
|
|
|
117
131
|
For example:
|
|
118
132
|
|
|
119
133
|
- A **"Database Migration"** skill could ensure the plan includes data safety
|
|
120
134
|
checks and rollback strategies.
|
|
121
|
-
- A **"Security Audit"** skill could prompt
|
|
135
|
+
- A **"Security Audit"** skill could prompt Gemini CLI to look for specific
|
|
122
136
|
vulnerabilities during codebase exploration.
|
|
123
|
-
- A **"Frontend Design"** skill could guide
|
|
137
|
+
- A **"Frontend Design"** skill could guide Gemini CLI to use specific UI
|
|
124
138
|
components and accessibility standards in its proposal.
|
|
125
139
|
|
|
126
|
-
To use a skill in Plan Mode, you can explicitly ask
|
|
127
|
-
|
|
128
|
-
on the task description.
|
|
140
|
+
To use a skill in Plan Mode, you can explicitly ask Gemini CLI to "use the
|
|
141
|
+
`<skill-name>` skill to plan..." or Gemini CLI may autonomously activate it
|
|
142
|
+
based on the task description.
|
|
129
143
|
|
|
130
144
|
### Customizing Policies
|
|
131
145
|
|
|
@@ -137,7 +151,7 @@ Because user policies (Tier 2) have a higher base priority than built-in
|
|
|
137
151
|
policies (Tier 1), you can override Plan Mode's default restrictions by creating
|
|
138
152
|
a rule in your `~/.gemini/policies/` directory.
|
|
139
153
|
|
|
140
|
-
#### Example: Allow
|
|
154
|
+
#### Example: Allow git commands in Plan Mode
|
|
141
155
|
|
|
142
156
|
This rule allows you to check the repository status and see changes while in
|
|
143
157
|
Plan Mode.
|
|
@@ -153,10 +167,10 @@ priority = 100
|
|
|
153
167
|
modes = ["plan"]
|
|
154
168
|
```
|
|
155
169
|
|
|
156
|
-
#### Example: Enable research
|
|
170
|
+
#### Example: Enable research subagents in Plan Mode
|
|
157
171
|
|
|
158
|
-
You can enable
|
|
159
|
-
|
|
172
|
+
You can enable experimental research [subagents] like `codebase_investigator` to
|
|
173
|
+
help gather architecture details during the planning phase.
|
|
160
174
|
|
|
161
175
|
`~/.gemini/policies/research-subagents.toml`
|
|
162
176
|
|
|
@@ -168,11 +182,51 @@ priority = 100
|
|
|
168
182
|
modes = ["plan"]
|
|
169
183
|
```
|
|
170
184
|
|
|
171
|
-
Tell
|
|
185
|
+
Tell Gemini CLI it can use these tools in your prompt, for example: _"You can
|
|
172
186
|
check ongoing changes in git."_
|
|
173
187
|
|
|
174
|
-
For more information on how the policy engine works, see the [
|
|
175
|
-
|
|
188
|
+
For more information on how the policy engine works, see the [policy engine]
|
|
189
|
+
docs.
|
|
190
|
+
|
|
191
|
+
### Custom Plan Directory and Policies
|
|
192
|
+
|
|
193
|
+
By default, planning artifacts are stored in a managed temporary directory
|
|
194
|
+
outside your project: `~/.gemini/tmp/<project>/<session-id>/plans/`.
|
|
195
|
+
|
|
196
|
+
You can configure a custom directory for plans in your `settings.json`. For
|
|
197
|
+
example, to store plans in a `.gemini/plans` directory within your project:
|
|
198
|
+
|
|
199
|
+
```json
|
|
200
|
+
{
|
|
201
|
+
"general": {
|
|
202
|
+
"plan": {
|
|
203
|
+
"directory": ".gemini/plans"
|
|
204
|
+
}
|
|
205
|
+
}
|
|
206
|
+
}
|
|
207
|
+
```
|
|
208
|
+
|
|
209
|
+
To maintain the safety of Plan Mode, user-configured paths for the plans
|
|
210
|
+
directory are restricted to the project root. This ensures that custom planning
|
|
211
|
+
locations defined within a project's workspace cannot be used to escape and
|
|
212
|
+
overwrite sensitive files elsewhere. Any user-configured directory must reside
|
|
213
|
+
within the project boundary.
|
|
214
|
+
|
|
215
|
+
Using a custom directory requires updating your [policy engine] configurations
|
|
216
|
+
to allow `write_file` and `replace` in that specific location. For example, to
|
|
217
|
+
allow writing to the `.gemini/plans` directory within your project, create a
|
|
218
|
+
policy file at `~/.gemini/policies/plan-custom-directory.toml`:
|
|
219
|
+
|
|
220
|
+
```toml
|
|
221
|
+
[[rule]]
|
|
222
|
+
toolName = ["write_file", "replace"]
|
|
223
|
+
decision = "allow"
|
|
224
|
+
priority = 100
|
|
225
|
+
modes = ["plan"]
|
|
226
|
+
# Adjust the pattern to match your custom directory.
|
|
227
|
+
# This example matches any .md file in a .gemini/plans directory within the project.
|
|
228
|
+
argsPattern = "\"file_path\":\"[^\"]*/\\.gemini/plans/[a-zA-Z0-9_-]+\\.md\""
|
|
229
|
+
```
|
|
176
230
|
|
|
177
231
|
[`list_directory`]: /docs/tools/file-system.md#1-list_directory-readfolder
|
|
178
232
|
[`read_file`]: /docs/tools/file-system.md#2-read_file-readfile
|
|
@@ -183,8 +237,9 @@ Guide].
|
|
|
183
237
|
[`replace`]: /docs/tools/file-system.md#6-replace-edit
|
|
184
238
|
[MCP tools]: /docs/tools/mcp-server.md
|
|
185
239
|
[`activate_skill`]: /docs/cli/skills.md
|
|
186
|
-
[
|
|
187
|
-
[
|
|
240
|
+
[subagents]: /docs/core/subagents.md
|
|
241
|
+
[policy engine]: /docs/reference/policy-engine.md
|
|
188
242
|
[`enter_plan_mode`]: /docs/tools/planning.md#1-enter_plan_mode-enterplanmode
|
|
189
243
|
[`exit_plan_mode`]: /docs/tools/planning.md#2-exit_plan_mode-exitplanmode
|
|
190
244
|
[`ask_user`]: /docs/tools/ask-user.md
|
|
245
|
+
[YOLO mode]: /docs/reference/configuration.md#command-line-arguments
|
|
@@ -167,6 +167,6 @@ gemini -s -p "run shell command: mount | grep workspace"
|
|
|
167
167
|
|
|
168
168
|
## Related documentation
|
|
169
169
|
|
|
170
|
-
- [Configuration](../
|
|
171
|
-
- [Commands](
|
|
172
|
-
- [Troubleshooting](../troubleshooting.md): General troubleshooting.
|
|
170
|
+
- [Configuration](../reference/configuration.md): Full configuration options.
|
|
171
|
+
- [Commands](../reference/commands.md): Available commands.
|
|
172
|
+
- [Troubleshooting](../resources/troubleshooting.md): General troubleshooting.
|
|
@@ -28,6 +28,7 @@ they appear in the UI.
|
|
|
28
28
|
| Default Approval Mode | `general.defaultApprovalMode` | The default approval mode for tool execution. 'default' prompts for approval, 'auto_edit' auto-approves edit tools, and 'plan' is read-only mode. 'yolo' is not supported yet. | `"default"` |
|
|
29
29
|
| Enable Auto Update | `general.enableAutoUpdate` | Enable automatic updates. | `true` |
|
|
30
30
|
| Enable Notifications | `general.enableNotifications` | Enable run-event notifications for action-required prompts and session completion. Currently macOS only. | `false` |
|
|
31
|
+
| Plan Directory | `general.plan.directory` | The directory where planning artifacts are stored. If not specified, defaults to the system temporary directory. | `undefined` |
|
|
31
32
|
| Enable Prompt Completion | `general.enablePromptCompletion` | Enable AI-powered prompt completion suggestions while typing. | `false` |
|
|
32
33
|
| Debug Keystroke Logging | `general.debugKeystrokeLogging` | Enable debug logging of keystrokes to the console. | `false` |
|
|
33
34
|
| Enable Session Cleanup | `general.sessionRetention.enabled` | Enable automatic session cleanup | `false` |
|
|
@@ -41,36 +42,36 @@ they appear in the UI.
|
|
|
41
42
|
|
|
42
43
|
### UI
|
|
43
44
|
|
|
44
|
-
| UI Label | Setting
|
|
45
|
-
| ------------------------------------ |
|
|
46
|
-
| Auto Theme Switching | `ui.autoThemeSwitching`
|
|
47
|
-
| Terminal Background Polling Interval | `ui.terminalBackgroundPollingInterval`
|
|
48
|
-
| Hide Window Title | `ui.hideWindowTitle`
|
|
49
|
-
| Inline Thinking | `ui.inlineThinkingMode`
|
|
50
|
-
| Show Thoughts in Title | `ui.showStatusInTitle`
|
|
51
|
-
| Dynamic Window Title | `ui.dynamicWindowTitle`
|
|
52
|
-
| Show Home Directory Warning | `ui.showHomeDirectoryWarning`
|
|
53
|
-
| Show Compatibility Warnings | `ui.showCompatibilityWarnings`
|
|
54
|
-
| Hide Tips | `ui.hideTips`
|
|
55
|
-
| Show Shortcuts Hint | `ui.showShortcutsHint`
|
|
56
|
-
| Hide Banner | `ui.hideBanner`
|
|
57
|
-
| Hide Context Summary | `ui.hideContextSummary`
|
|
58
|
-
| Hide CWD | `ui.footer.hideCWD`
|
|
59
|
-
| Hide Sandbox Status | `ui.footer.hideSandboxStatus`
|
|
60
|
-
| Hide Model Info | `ui.footer.hideModelInfo`
|
|
61
|
-
| Hide Context Window Percentage | `ui.footer.hideContextPercentage`
|
|
62
|
-
| Hide Footer | `ui.hideFooter`
|
|
63
|
-
| Show Memory Usage | `ui.showMemoryUsage`
|
|
64
|
-
| Show Line Numbers | `ui.showLineNumbers`
|
|
65
|
-
| Show Citations | `ui.showCitations`
|
|
66
|
-
| Show Model Info In Chat | `ui.showModelInfoInChat`
|
|
67
|
-
| Show User Identity | `ui.showUserIdentity`
|
|
68
|
-
| Use Alternate Screen Buffer | `ui.useAlternateBuffer`
|
|
69
|
-
| Use Background Color | `ui.useBackgroundColor`
|
|
70
|
-
| Incremental Rendering | `ui.incrementalRendering`
|
|
71
|
-
| Show Spinner | `ui.showSpinner`
|
|
72
|
-
|
|
|
73
|
-
| Screen Reader Mode | `ui.accessibility.screenReader`
|
|
45
|
+
| UI Label | Setting | Description | Default |
|
|
46
|
+
| ------------------------------------ | -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
|
|
47
|
+
| Auto Theme Switching | `ui.autoThemeSwitching` | Automatically switch between default light and dark themes based on terminal background color. | `true` |
|
|
48
|
+
| Terminal Background Polling Interval | `ui.terminalBackgroundPollingInterval` | Interval in seconds to poll the terminal background color. | `60` |
|
|
49
|
+
| Hide Window Title | `ui.hideWindowTitle` | Hide the window title bar | `false` |
|
|
50
|
+
| Inline Thinking | `ui.inlineThinkingMode` | Display model thinking inline: off or full. | `"off"` |
|
|
51
|
+
| Show Thoughts in Title | `ui.showStatusInTitle` | Show Gemini CLI model thoughts in the terminal window title during the working phase | `false` |
|
|
52
|
+
| Dynamic Window Title | `ui.dynamicWindowTitle` | Update the terminal window title with current status icons (Ready: ◇, Action Required: ✋, Working: ✦) | `true` |
|
|
53
|
+
| Show Home Directory Warning | `ui.showHomeDirectoryWarning` | Show a warning when running Gemini CLI in the home directory. | `true` |
|
|
54
|
+
| Show Compatibility Warnings | `ui.showCompatibilityWarnings` | Show warnings about terminal or OS compatibility issues. | `true` |
|
|
55
|
+
| Hide Tips | `ui.hideTips` | Hide helpful tips in the UI | `false` |
|
|
56
|
+
| Show Shortcuts Hint | `ui.showShortcutsHint` | Show the "? for shortcuts" hint above the input. | `true` |
|
|
57
|
+
| Hide Banner | `ui.hideBanner` | Hide the application banner | `false` |
|
|
58
|
+
| Hide Context Summary | `ui.hideContextSummary` | Hide the context summary (GEMINI.md, MCP servers) above the input. | `false` |
|
|
59
|
+
| Hide CWD | `ui.footer.hideCWD` | Hide the current working directory path in the footer. | `false` |
|
|
60
|
+
| Hide Sandbox Status | `ui.footer.hideSandboxStatus` | Hide the sandbox status indicator in the footer. | `false` |
|
|
61
|
+
| Hide Model Info | `ui.footer.hideModelInfo` | Hide the model name and context usage in the footer. | `false` |
|
|
62
|
+
| Hide Context Window Percentage | `ui.footer.hideContextPercentage` | Hides the context window remaining percentage. | `true` |
|
|
63
|
+
| Hide Footer | `ui.hideFooter` | Hide the footer from the UI | `false` |
|
|
64
|
+
| Show Memory Usage | `ui.showMemoryUsage` | Display memory usage information in the UI | `false` |
|
|
65
|
+
| Show Line Numbers | `ui.showLineNumbers` | Show line numbers in the chat. | `true` |
|
|
66
|
+
| Show Citations | `ui.showCitations` | Show citations for generated text in the chat. | `false` |
|
|
67
|
+
| Show Model Info In Chat | `ui.showModelInfoInChat` | Show the model name in the chat for each model turn. | `false` |
|
|
68
|
+
| Show User Identity | `ui.showUserIdentity` | Show the logged-in user's identity (e.g. email) in the UI. | `true` |
|
|
69
|
+
| Use Alternate Screen Buffer | `ui.useAlternateBuffer` | Use an alternate screen buffer for the UI, preserving shell history. | `false` |
|
|
70
|
+
| Use Background Color | `ui.useBackgroundColor` | Whether to use background colors in the UI. | `true` |
|
|
71
|
+
| Incremental Rendering | `ui.incrementalRendering` | Enable incremental rendering for the UI. This option will reduce flickering but may cause rendering artifacts. Only supported when useAlternateBuffer is enabled. | `true` |
|
|
72
|
+
| Show Spinner | `ui.showSpinner` | Show the spinner during operations. | `true` |
|
|
73
|
+
| Loading Phrases | `ui.loadingPhrases` | What to show while the model is working: tips, witty comments, both, or nothing. | `"tips"` |
|
|
74
|
+
| Screen Reader Mode | `ui.accessibility.screenReader` | Render output in plain-text to be more screen reader accessible | `false` |
|
|
74
75
|
|
|
75
76
|
### IDE
|
|
76
77
|
|
|
@@ -93,7 +93,7 @@ Environment variables can be used to override the settings in the file.
|
|
|
93
93
|
`true` or `1` will enable the feature. Any other value will disable it.
|
|
94
94
|
|
|
95
95
|
For detailed information about all configuration options, see the
|
|
96
|
-
[Configuration guide](../
|
|
96
|
+
[Configuration guide](../reference/configuration.md).
|
|
97
97
|
|
|
98
98
|
## Google Cloud telemetry
|
|
99
99
|
|