mirror of
https://github.com/google-gemini/gemini-cli.git
synced 2026-06-12 04:17:15 -07:00
docs: weekly audit results for 24319780415
This commit is contained in:
github-merge-queue
committed by
github-actions[bot]
github-actions[bot]
parent
0179726222
commit
3266d7dbd8
@@ -60,7 +60,7 @@ These commands are available within the interactive REPL.
|
||||
| `--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 (for example `--resume 5`) |
|
||||
| `--resume` | `-r` | string | - | Resume a previous session. Use `"latest"` for most recent or index number (for example, `--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) |
|
||||
|
||||
+2
-2
@@ -27,8 +27,8 @@ Running this command will open a dialog with your options:
|
||||
| Auto (Gemini 2.5) | Let the system choose the best Gemini 2.5 model for your task. | gemini-2.5-pro, gemini-2.5-flash |
|
||||
| Manual | Select a specific model. | Any available model. |
|
||||
|
||||
We recommend selecting one of the above **Auto** options. However, you can
|
||||
select **Manual** to select a specific model from those available.
|
||||
Gemini CLI recommends selecting one of the above **Auto** options. However, you
|
||||
can select **Manual** to select a specific model from those available.
|
||||
|
||||
You can also use the `--model` flag to specify a particular Gemini model on
|
||||
startup. For more details, refer to the
|
||||
|
||||
+31
-45
@@ -1,59 +1,45 @@
|
||||
# Notifications (experimental)
|
||||
# Notifications
|
||||
|
||||
Gemini CLI can send system notifications to alert you when a session completes
|
||||
or when it needs your attention, such as when it's waiting for you to approve a
|
||||
tool call.
|
||||
Gemini CLI can provide run-event notifications to alert you when an action is
|
||||
required or when a long-running session completes.
|
||||
|
||||
<!-- prettier-ignore -->
|
||||
> [!NOTE]
|
||||
> This is an experimental feature currently under active development and
|
||||
> may need to be enabled under `/settings`.
|
||||
## Overview
|
||||
|
||||
Notifications are particularly useful when running long-running tasks or using
|
||||
[Plan Mode](./plan-mode.md), letting you switch to other windows while Gemini
|
||||
CLI works in the background.
|
||||
Notifications help you stay informed about the agent's progress without
|
||||
constantly monitoring the terminal. When enabled, Gemini CLI uses system-level
|
||||
notifications to alert you in the following scenarios:
|
||||
|
||||
## Requirements
|
||||
|
||||
### Terminal support
|
||||
|
||||
The CLI uses the OSC 9 terminal escape sequence to trigger system notifications.
|
||||
This is supported by several modern terminal emulators including iTerm2,
|
||||
WezTerm, Ghostty, and Kitty. If your terminal does not support OSC 9
|
||||
notifications, Gemini CLI falls back to a terminal bell (BEL) to get your
|
||||
attention. Most terminals respond to BEL with a taskbar flash or system alert
|
||||
sound.
|
||||
- **Action required:** When the agent is waiting for your approval to execute a
|
||||
tool.
|
||||
- **Session completed:** When a sequence of tasks has finished.
|
||||
- **Critical errors:** When a session terminates due to an error.
|
||||
|
||||
## Enable notifications
|
||||
|
||||
Notifications are disabled by default. You can enable them using the `/settings`
|
||||
command or by updating your `settings.json` file.
|
||||
To enable notifications, set the `general.enableNotifications` setting to
|
||||
`true`.
|
||||
|
||||
1. Open the settings dialog by typing `/settings` in an interactive session.
|
||||
2. Navigate to the **General** category.
|
||||
3. Toggle the **Enable Notifications** setting to **On**.
|
||||
|
||||
Alternatively, add the following to your `settings.json`:
|
||||
|
||||
```json
|
||||
{
|
||||
"general": {
|
||||
"enableNotifications": true
|
||||
}
|
||||
}
|
||||
```bash
|
||||
gemini config set general.enableNotifications true
|
||||
```
|
||||
|
||||
## Types of notifications
|
||||
Alternatively, you can enable them via the `/settings` dialog:
|
||||
|
||||
Gemini CLI sends notifications for the following events:
|
||||
1. Open the settings dialog by typing `/settings`.
|
||||
2. Navigate to the **General** category.
|
||||
3. Check the **Enable Notifications** box.
|
||||
|
||||
- **Action required:** Triggered when the model is waiting for user input or
|
||||
tool approval. This helps you know when the CLI has paused and needs you to
|
||||
intervene.
|
||||
- **Session complete:** Triggered when a session finishes successfully. This is
|
||||
useful for tracking the completion of automated tasks.
|
||||
## Requirements
|
||||
|
||||
## Next steps
|
||||
Notifications depend on your operating system's capabilities:
|
||||
|
||||
- Start planning with [Plan Mode](./plan-mode.md).
|
||||
- Configure your experience with other [settings](./settings.md).
|
||||
- **macOS:** Uses the built-in Notification Center.
|
||||
- **Linux:** Requires a notification daemon (like `dunst` or `notify-osd`) and
|
||||
the `notify-send` utility.
|
||||
- **Windows:** Uses the Windows Action Center.
|
||||
|
||||
<!-- prettier-ignore -->
|
||||
> [!NOTE]
|
||||
> In some terminal environments or remote sessions (like SSH), system
|
||||
> notifications may not be available or may require additional configuration on
|
||||
> the host machine.
|
||||
|
||||
@@ -35,9 +35,9 @@ To launch Gemini CLI in Plan Mode once:
|
||||
To start Plan Mode while using Gemini CLI:
|
||||
|
||||
- **Keyboard shortcut:** Press `Shift+Tab` to cycle through approval modes
|
||||
(`Default` -> `Auto-Edit` -> `Plan`). Plan Mode is automatically removed from
|
||||
the rotation when Gemini CLI is actively processing or showing confirmation
|
||||
dialogs.
|
||||
(**Default** -> **Auto-Edit** -> **Plan**). Plan Mode is automatically removed
|
||||
from the rotation when Gemini CLI is actively processing or showing
|
||||
confirmation dialogs.
|
||||
|
||||
- **Command:** Type `/plan [goal]` in the input box. The `[goal]` is optional;
|
||||
for example, `/plan implement authentication` will switch to Plan Mode and
|
||||
|
||||
Reference in New Issue
Block a user