From c4bd75946765683efffe4ac8f46d23282ee56fa4 Mon Sep 17 00:00:00 2001 From: Tommaso Sciortino Date: Mon, 13 Oct 2025 12:57:23 -0700 Subject: [PATCH] document all settings with showInDialog: true (#11049) --- docs/get-started/configuration.md | 84 +++++++++++++++++++++++ packages/cli/src/config/settingsSchema.ts | 5 ++ 2 files changed, 89 insertions(+) diff --git a/docs/get-started/configuration.md b/docs/get-started/configuration.md index 955f0392f4..b62215723b 100644 --- a/docs/get-started/configuration.md +++ b/docs/get-started/configuration.md @@ -110,6 +110,19 @@ their corresponding top-level category object in your `settings.json` file. - **Description:** Enable session checkpointing for recovery. - **Default:** `false` +- **`general.enablePromptCompletion`** (boolean): + - **Description:** Enable AI-powered prompt completion suggestions while + typing. + - **Default:** `false` + +- **`general.debugKeystrokeLogging`** (boolean): + - **Description:** Enable debug logging of keystrokes to the console. + - **Default:** `false` + +- **`general.sessionRetention.enabled`** (boolean): + - **Description:** Enable automatic session cleanup. + - **Default:** `false` + #### `output` - **`output.format`** (string): @@ -132,6 +145,11 @@ their corresponding top-level category object in your `settings.json` file. - **Description:** Hide the window title bar. - **Default:** `false` +- **`ui.showStatusInTitle`** (boolean): + - **Description:** Show Gemini CLI status and thoughts in the terminal window + title. + - **Default:** `false` + - **`ui.hideTips`** (boolean): - **Description:** Hide helpful tips in the UI. - **Default:** `false` @@ -140,10 +158,27 @@ their corresponding top-level category object in your `settings.json` file. - **Description:** Hide the application banner. - **Default:** `false` +- **`ui.hideContextSummary`** (boolean): + - **Description:** Hide the context summary (GEMINI.md, MCP servers) above the + input. + - **Default:** `false` + - **`ui.hideFooter`** (boolean): - **Description:** Hide the footer from the UI. - **Default:** `false` +- **`ui.footer.hideCWD`** (boolean): + - **Description:** Hide the current working directory path in the footer. + - **Default:** `false` + +- **`ui.footer.hideSandboxStatus`** (boolean): + - **Description:** Hide the sandbox status indicator in the footer. + - **Default:** `false` + +- **`ui.footer.hideModelInfo`** (boolean): + - **Description:** Hide the model name and context usage in the footer. + - **Default:** `false` + - **`ui.showMemoryUsage`** (boolean): - **Description:** Display memory usage information in the UI. - **Default:** `false` @@ -156,6 +191,10 @@ their corresponding top-level category object in your `settings.json` file. - **Description:** Show citations for generated text in the chat. - **Default:** `true` +- **`ui.useFullWidth`** (boolean): + - **Description:** Use the entire width of the terminal for output. + - **Default:** `false` + - **`ui.accessibility.disableLoadingPhrases`** (boolean): - **Description:** Disable loading phrases for accessibility. - **Default:** `false` @@ -256,6 +295,10 @@ their corresponding top-level category object in your `settings.json` file. the current tree when completing `@` prefixes in the prompt. - **Default:** `true` +- **`context.fileFiltering.disableFuzzySearch`** (boolean): + - **Description:** Disable fuzzy search when searching for files. + - **Default:** `false` + #### `tools` - **`tools.sandbox`** (boolean or string): @@ -269,6 +312,15 @@ their corresponding top-level category object in your `settings.json` file. shell. - **Default:** `true` +- **`tools.shell.showColor`** (boolean): + - **Description:** Show color in shell output. + - **Default:** `false` + +- **`tools.autoAccept`** (boolean): + - **Description:** Automatically accept and execute tool calls that are + considered safe (e.g., read-only operations). + - **Default:** `false` + - **`tools.core`** (array of strings): - **Description:** This can be used to restrict the set of built-in tools [with an allowlist](../cli/enterprise.md#restricting-tool-access). See @@ -306,6 +358,31 @@ their corresponding top-level category object in your `settings.json` file. [`functionResponse.response.content`](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#functionresponse). - **Default:** `undefined` +- **`tools.useRipgrep`** (boolean): + - **Description:** Use ripgrep for file content search instead of the fallback + implementation. Provides faster search performance. + - **Default:** `true` + +- **`tools.enableToolOutputTruncation`** (boolean): + - **Description:** Enable truncation of large tool outputs. + - **Default:** `true` + +- **`tools.truncateToolOutputThreshold`** (number): + - **Description:** Truncate tool output if it is larger than this many + characters. Set to -1 to disable. + - **Default:** `20000` + +- **`tools.truncateToolOutputLines`** (number): + - **Description:** The number of lines to keep when truncating tool output. + - **Default:** `1000` + +- **`tools.enableMessageBusIntegration`** (boolean): + - **Description:** Enable policy-based tool confirmation via message bus + integration. When enabled, tools will automatically respect policy engine + decisions (ALLOW/DENY/ASK_USER) without requiring individual tool + implementations. + - **Default:** `false` + #### `mcp` - **`mcp.serverCommand`** (string): @@ -356,6 +433,13 @@ their corresponding top-level category object in your `settings.json` file. - **Description:** Configuration for the bug report command. - **Default:** `undefined` +#### `experimental` + +- **`experimental.useModelRouter`** (boolean): + - **Description:** Enable model routing to route requests to the best model + based on complexity. + - **Default:** `false` + #### `mcpServers` Configures connections to one or more Model-Context Protocol (MCP) servers for diff --git a/packages/cli/src/config/settingsSchema.ts b/packages/cli/src/config/settingsSchema.ts index 286ab27b29..a57dbc6654 100644 --- a/packages/cli/src/config/settingsSchema.ts +++ b/packages/cli/src/config/settingsSchema.ts @@ -4,6 +4,11 @@ * SPDX-License-Identifier: Apache-2.0 */ +// -------------------------------------------------------------------------- +// IMPORTANT: When adding a new setting, especially one with `showInDialog: true`, +// please ensure it is also documented in `docs/get-started/configuration.md`. +// -------------------------------------------------------------------------- + import type { MCPServerConfig, BugCommandSettings,