@google/gemini-cli 0.13.0-nightly.20251103.9187f6f6 → 0.13.0-preview.0

package/dist/src/config/settingsSchema.js

@@ -14,6 +14,16 @@ export const TOGGLE_TYPES = new Set([
     'boolean',
     'enum',
 ]);
+function oneLine(strings, ...values) {
+    let result = '';
+    for (let i = 0; i < strings.length; i++) {
+        result += strings[i];
+        if (i < values.length) {
+            result += String(values[i]);
+        }
+    }
+    return result.replace(/\s+/g, ' ').trim();
+}
 export var MergeStrategy;
 (function (MergeStrategy) {
     // Replace the old value with the new value. This is the default.
@@ -41,6 +51,10 @@ const SETTINGS_SCHEMA = {
         description: 'Configuration for MCP servers.',
         showInDialog: false,
         mergeStrategy: MergeStrategy.SHALLOW_MERGE,
+        additionalProperties: {
+            type: 'object',
+            ref: 'MCPServerConfig',
+        },
     },
     general: {
         type: 'object',
@@ -221,7 +235,7 @@ const SETTINGS_SCHEMA = {
                 category: 'UI',
                 requiresRestart: false,
                 default: undefined,
-                description: 'The color theme for the UI.',
+                description: 'The color theme for the UI. See the CLI themes guide for available options.',
                 showInDialog: false,
             },
             customThemes: {
@@ -232,6 +246,10 @@ const SETTINGS_SCHEMA = {
                 default: {},
                 description: 'Custom theme definitions.',
                 showInDialog: false,
+                additionalProperties: {
+                    type: 'object',
+                    ref: 'CustomTheme',
+                },
             },
             hideWindowTitle: {
                 type: 'boolean',
@@ -370,14 +388,27 @@ const SETTINGS_SCHEMA = {
                 description: 'Use the entire width of the terminal for output.',
                 showInDialog: true,
             },
+            useAlternateBuffer: {
+                type: 'boolean',
+                label: 'Use Alternate Screen Buffer',
+                category: 'UI',
+                requiresRestart: true,
+                default: false,
+                description: 'Use an alternate screen buffer for the UI, preserving shell history.',
+                showInDialog: true,
+            },
             customWittyPhrases: {
                 type: 'array',
                 label: 'Custom Witty Phrases',
                 category: 'UI',
                 requiresRestart: false,
                 default: [],
-                description: 'Custom witty phrases to display during loading.',
+                description: oneLine `
+          Custom witty phrases to display during loading.
+          When provided, the CLI cycles through these instead of the defaults.
+        `,
                 showInDialog: false,
+                items: { type: 'string' },
             },
             accessibility: {
                 type: 'object',
@@ -467,6 +498,7 @@ const SETTINGS_SCHEMA = {
         default: undefined,
         description: 'Telemetry configuration.',
         showInDialog: false,
+        ref: 'TelemetrySettings',
     },
     model: {
         type: 'object',
@@ -501,8 +533,17 @@ const SETTINGS_SCHEMA = {
                 category: 'Model',
                 requiresRestart: false,
                 default: undefined,
-                description: 'Settings for summarizing tool output.',
+                description: oneLine `
+          Enables or disables summarization of tool output.
+          Configure per-tool token budgets (for example {"run_shell_command": {"tokenBudget": 2000}}).
+          Currently only the run_shell_command tool supports summarization.
+        `,
                 showInDialog: false,
+                additionalProperties: {
+                    type: 'object',
+                    description: 'Per-tool summarization settings with an optional tokenBudget.',
+                    ref: 'SummarizeToolOutputSettings',
+                },
             },
             compressionThreshold: {
                 type: 'number',
@@ -534,12 +575,13 @@ const SETTINGS_SCHEMA = {
         showInDialog: false,
         properties: {
             fileName: {
-                type: 'object',
+                type: 'string',
                 label: 'Context File Name',
                 category: 'Context',
                 requiresRestart: false,
                 default: undefined,
-                description: 'The name of the context file.',
+                ref: 'StringOrStringArray',
+                description: 'The name of the context file or files to load into memory. Accepts either a single string or an array of strings.',
                 showInDialog: false,
             },
             importFormat: {
@@ -566,8 +608,12 @@ const SETTINGS_SCHEMA = {
                 category: 'Context',
                 requiresRestart: false,
                 default: [],
-                description: 'Additional directories to include in the workspace context. Missing directories will be skipped with a warning.',
+                description: oneLine `
+          Additional directories to include in the workspace context.
+          Missing directories will be skipped with a warning.
+        `,
                 showInDialog: false,
+                items: { type: 'string' },
                 mergeStrategy: MergeStrategy.CONCAT,
             },
             loadMemoryFromIncludeDirectories: {
@@ -576,7 +622,10 @@ const SETTINGS_SCHEMA = {
                 category: 'Context',
                 requiresRestart: false,
                 default: false,
-                description: 'Whether to load memory files from include directories.',
+                description: oneLine `
+          Controls how /memory refresh loads GEMINI.md files.
+          When true, include directories are scanned; when false, only the current directory is used.
+        `,
                 showInDialog: true,
             },
             fileFiltering: {
@@ -612,7 +661,9 @@ const SETTINGS_SCHEMA = {
                         category: 'Context',
                         requiresRestart: true,
                         default: true,
-                        description: 'Enable recursive file search functionality',
+                        description: oneLine `
+              Enable recursive file search functionality when completing @ references in the prompt.
+            `,
                         showInDialog: true,
                     },
                     disableFuzzySearch: {
@@ -638,12 +689,16 @@ const SETTINGS_SCHEMA = {
         showInDialog: false,
         properties: {
             sandbox: {
-                type: 'object',
+                type: 'string',
                 label: 'Sandbox',
                 category: 'Tools',
                 requiresRestart: true,
                 default: undefined,
-                description: 'Sandbox execution environment (can be a boolean or a path string).',
+                ref: 'BooleanOrString',
+                description: oneLine `
+          Sandbox execution environment.
+          Set to a boolean to enable or disable the sandbox, or provide a string path to a sandbox profile.
+        `,
                 showInDialog: false,
             },
             shell: {
@@ -661,7 +716,10 @@ const SETTINGS_SCHEMA = {
                         category: 'Tools',
                         requiresRestart: true,
                         default: true,
-                        description: 'Use node-pty for an interactive shell experience. Fallback to child_process still applies.',
+                        description: oneLine `
+              Use node-pty for an interactive shell experience.
+              Fallback to child_process still applies.
+            `,
                         showInDialog: true,
                     },
                     pager: {
@@ -690,7 +748,9 @@ const SETTINGS_SCHEMA = {
                 category: 'Tools',
                 requiresRestart: false,
                 default: false,
-                description: 'Automatically accept and execute tool calls that are considered safe (e.g., read-only operations).',
+                description: oneLine `
+          Automatically accept and execute tool calls that are considered safe (e.g., read-only operations).
+        `,
                 showInDialog: true,
             },
             core: {
@@ -699,8 +759,12 @@ const SETTINGS_SCHEMA = {
                 category: 'Tools',
                 requiresRestart: true,
                 default: undefined,
-                description: 'Paths to core tool definitions.',
+                description: oneLine `
+          Restrict the set of built-in tools with an allowlist.
+          Match semantics mirror tools.allowed; see the built-in tools documentation for available names.
+        `,
                 showInDialog: false,
+                items: { type: 'string' },
             },
             allowed: {
                 type: 'array',
@@ -708,8 +772,13 @@ const SETTINGS_SCHEMA = {
                 category: 'Advanced',
                 requiresRestart: true,
                 default: undefined,
-                description: 'A list of tool names that will bypass the confirmation dialog.',
+                description: oneLine `
+          Tool names that bypass the confirmation dialog.
+          Useful for trusted commands (for example ["run_shell_command(git)", "run_shell_command(npm test)"]).
+          See shell tool command restrictions for matching details.
+        `,
                 showInDialog: false,
+                items: { type: 'string' },
             },
             exclude: {
                 type: 'array',
@@ -719,6 +788,7 @@ const SETTINGS_SCHEMA = {
                 default: undefined,
                 description: 'Tool names to exclude from discovery.',
                 showInDialog: false,
+                items: { type: 'string' },
                 mergeStrategy: MergeStrategy.UNION,
             },
             discoveryCommand: {
@@ -736,7 +806,10 @@ const SETTINGS_SCHEMA = {
                 category: 'Tools',
                 requiresRestart: true,
                 default: undefined,
-                description: 'Command to run for tool calls.',
+                description: oneLine `
+          Defines a custom shell command for invoking discovered tools.
+          The command must take the tool name as the first argument, read JSON arguments from stdin, and emit JSON results on stdout.
+        `,
                 showInDialog: false,
             },
             useRipgrep: {
@@ -781,7 +854,10 @@ const SETTINGS_SCHEMA = {
                 category: 'Tools',
                 requiresRestart: true,
                 default: false,
-                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.',
+                description: oneLine `
+          Enable policy-based tool confirmation via message bus integration.
+          When enabled, tools automatically respect policy engine decisions (ALLOW/DENY/ASK_USER) without requiring individual tool implementations.
+        `,
                 showInDialog: true,
             },
             enableHooks: {
@@ -821,6 +897,7 @@ const SETTINGS_SCHEMA = {
                 default: undefined,
                 description: 'A list of MCP servers to allow.',
                 showInDialog: false,
+                items: { type: 'string' },
             },
             excluded: {
                 type: 'array',
@@ -830,6 +907,7 @@ const SETTINGS_SCHEMA = {
                 default: undefined,
                 description: 'A list of MCP servers to exclude.',
                 showInDialog: false,
+                items: { type: 'string' },
             },
         },
     },
@@ -847,7 +925,7 @@ const SETTINGS_SCHEMA = {
         label: 'Use Write Todos',
         category: 'Advanced',
         requiresRestart: false,
-        default: false,
+        default: true,
         description: 'Enable the write_todos_list tool.',
         showInDialog: false,
     },
@@ -964,6 +1042,7 @@ const SETTINGS_SCHEMA = {
                 default: ['DEBUG', 'DEBUG_MODE'],
                 description: 'Environment variables to exclude from project context.',
                 showInDialog: false,
+                items: { type: 'string' },
                 mergeStrategy: MergeStrategy.UNION,
             },
             bugCommand: {
@@ -974,6 +1053,7 @@ const SETTINGS_SCHEMA = {
                 default: undefined,
                 description: 'Configuration for the bug report command.',
                 showInDialog: false,
+                ref: 'BugCommandSettings',
             },
         },
     },
@@ -1027,7 +1107,7 @@ const SETTINGS_SCHEMA = {
                         label: 'Enable Codebase Investigator',
                         category: 'Experimental',
                         requiresRestart: true,
-                        default: false,
+                        default: true,
                         description: 'Enable the Codebase Investigator agent.',
                         showInDialog: true,
                     },
@@ -1036,7 +1116,7 @@ const SETTINGS_SCHEMA = {
                         label: 'Codebase Investigator Max Num Turns',
                         category: 'Experimental',
                         requiresRestart: true,
-                        default: 15,
+                        default: 10,
                         description: 'Maximum number of turns for the Codebase Investigator agent.',
                         showInDialog: true,
                     },
@@ -1045,7 +1125,7 @@ const SETTINGS_SCHEMA = {
                         label: 'Max Time (Minutes)',
                         category: 'Experimental',
                         requiresRestart: true,
-                        default: 5,
+                        default: 3,
                         description: 'Maximum time for the Codebase Investigator agent (in minutes).',
                         showInDialog: false,
                     },
@@ -1054,7 +1134,7 @@ const SETTINGS_SCHEMA = {
                         label: 'Thinking Budget',
                         category: 'Experimental',
                         requiresRestart: true,
-                        default: -1,
+                        default: 8192,
                         description: 'The thinking budget for the Codebase Investigator agent.',
                         showInDialog: false,
                     },
@@ -1088,6 +1168,7 @@ const SETTINGS_SCHEMA = {
                 default: [],
                 description: 'List of disabled extensions.',
                 showInDialog: false,
+                items: { type: 'string' },
                 mergeStrategy: MergeStrategy.UNION,
             },
             workspacesWithMigrationNudge: {
@@ -1098,6 +1179,7 @@ const SETTINGS_SCHEMA = {
                 default: [],
                 description: 'List of workspaces for which the migration nudge has been shown.',
                 showInDialog: false,
+                items: { type: 'string' },
                 mergeStrategy: MergeStrategy.UNION,
             },
         },
@@ -1113,6 +1195,255 @@ const SETTINGS_SCHEMA = {
         mergeStrategy: MergeStrategy.SHALLOW_MERGE,
     },
 };
+export const SETTINGS_SCHEMA_DEFINITIONS = {
+    MCPServerConfig: {
+        type: 'object',
+        description: 'Definition of a Model Context Protocol (MCP) server configuration.',
+        additionalProperties: false,
+        properties: {
+            command: {
+                type: 'string',
+                description: 'Executable invoked for stdio transport.',
+            },
+            args: {
+                type: 'array',
+                description: 'Command-line arguments for the stdio transport command.',
+                items: { type: 'string' },
+            },
+            env: {
+                type: 'object',
+                description: 'Environment variables to set for the server process.',
+                additionalProperties: { type: 'string' },
+            },
+            cwd: {
+                type: 'string',
+                description: 'Working directory for the server process.',
+            },
+            url: {
+                type: 'string',
+                description: 'SSE transport URL.',
+            },
+            httpUrl: {
+                type: 'string',
+                description: 'Streaming HTTP transport URL.',
+            },
+            headers: {
+                type: 'object',
+                description: 'Additional HTTP headers sent to the server.',
+                additionalProperties: { type: 'string' },
+            },
+            tcp: {
+                type: 'string',
+                description: 'TCP address for websocket transport.',
+            },
+            timeout: {
+                type: 'number',
+                description: 'Timeout in milliseconds for MCP requests.',
+            },
+            trust: {
+                type: 'boolean',
+                description: 'Marks the server as trusted. Trusted servers may gain additional capabilities.',
+            },
+            description: {
+                type: 'string',
+                description: 'Human-readable description of the server.',
+            },
+            includeTools: {
+                type: 'array',
+                description: 'Subset of tools that should be enabled for this server. When omitted all tools are enabled.',
+                items: { type: 'string' },
+            },
+            excludeTools: {
+                type: 'array',
+                description: 'Tools that should be disabled for this server even if exposed.',
+                items: { type: 'string' },
+            },
+            extension: {
+                type: 'object',
+                description: 'Metadata describing the Gemini CLI extension that owns this MCP server.',
+                additionalProperties: { type: ['string', 'boolean', 'number'] },
+            },
+            oauth: {
+                type: 'object',
+                description: 'OAuth configuration for authenticating with the server.',
+                additionalProperties: true,
+            },
+            authProviderType: {
+                type: 'string',
+                description: 'Authentication provider used for acquiring credentials (for example `dynamic_discovery`).',
+                enum: [
+                    'dynamic_discovery',
+                    'google_credentials',
+                    'service_account_impersonation',
+                ],
+            },
+            targetAudience: {
+                type: 'string',
+                description: 'OAuth target audience (CLIENT_ID.apps.googleusercontent.com).',
+            },
+            targetServiceAccount: {
+                type: 'string',
+                description: 'Service account email to impersonate (name@project.iam.gserviceaccount.com).',
+            },
+        },
+    },
+    TelemetrySettings: {
+        type: 'object',
+        description: 'Telemetry configuration for Gemini CLI.',
+        additionalProperties: false,
+        properties: {
+            enabled: {
+                type: 'boolean',
+                description: 'Enables telemetry emission.',
+            },
+            target: {
+                type: 'string',
+                description: 'Telemetry destination (for example `stderr`, `stdout`, or `otlp`).',
+            },
+            otlpEndpoint: {
+                type: 'string',
+                description: 'Endpoint for OTLP exporters.',
+            },
+            otlpProtocol: {
+                type: 'string',
+                description: 'Protocol for OTLP exporters.',
+                enum: ['grpc', 'http'],
+            },
+            logPrompts: {
+                type: 'boolean',
+                description: 'Whether prompts are logged in telemetry payloads.',
+            },
+            outfile: {
+                type: 'string',
+                description: 'File path for writing telemetry output.',
+            },
+            useCollector: {
+                type: 'boolean',
+                description: 'Whether to forward telemetry to an OTLP collector.',
+            },
+        },
+    },
+    BugCommandSettings: {
+        type: 'object',
+        description: 'Configuration for the bug report helper command.',
+        additionalProperties: false,
+        properties: {
+            urlTemplate: {
+                type: 'string',
+                description: 'Template used to open a bug report URL. Variables in the template are populated at runtime.',
+            },
+        },
+        required: ['urlTemplate'],
+    },
+    SummarizeToolOutputSettings: {
+        type: 'object',
+        description: 'Controls summarization behavior for individual tools. All properties are optional.',
+        additionalProperties: false,
+        properties: {
+            tokenBudget: {
+                type: 'number',
+                description: 'Maximum number of tokens used when summarizing tool output.',
+            },
+        },
+    },
+    CustomTheme: {
+        type: 'object',
+        description: 'Custom theme definition used for styling Gemini CLI output. Colors are provided as hex strings or named ANSI colors.',
+        additionalProperties: false,
+        properties: {
+            type: {
+                type: 'string',
+                enum: ['custom'],
+                default: 'custom',
+            },
+            name: {
+                type: 'string',
+                description: 'Theme display name.',
+            },
+            text: {
+                type: 'object',
+                additionalProperties: false,
+                properties: {
+                    primary: { type: 'string' },
+                    secondary: { type: 'string' },
+                    link: { type: 'string' },
+                    accent: { type: 'string' },
+                },
+            },
+            background: {
+                type: 'object',
+                additionalProperties: false,
+                properties: {
+                    primary: { type: 'string' },
+                    diff: {
+                        type: 'object',
+                        additionalProperties: false,
+                        properties: {
+                            added: { type: 'string' },
+                            removed: { type: 'string' },
+                        },
+                    },
+                },
+            },
+            border: {
+                type: 'object',
+                additionalProperties: false,
+                properties: {
+                    default: { type: 'string' },
+                    focused: { type: 'string' },
+                },
+            },
+            ui: {
+                type: 'object',
+                additionalProperties: false,
+                properties: {
+                    comment: { type: 'string' },
+                    symbol: { type: 'string' },
+                    gradient: {
+                        type: 'array',
+                        items: { type: 'string' },
+                    },
+                },
+            },
+            status: {
+                type: 'object',
+                additionalProperties: false,
+                properties: {
+                    error: { type: 'string' },
+                    success: { type: 'string' },
+                    warning: { type: 'string' },
+                },
+            },
+            Background: { type: 'string' },
+            Foreground: { type: 'string' },
+            LightBlue: { type: 'string' },
+            AccentBlue: { type: 'string' },
+            AccentPurple: { type: 'string' },
+            AccentCyan: { type: 'string' },
+            AccentGreen: { type: 'string' },
+            AccentYellow: { type: 'string' },
+            AccentRed: { type: 'string' },
+            DiffAdded: { type: 'string' },
+            DiffRemoved: { type: 'string' },
+            Comment: { type: 'string' },
+            Gray: { type: 'string' },
+            DarkGray: { type: 'string' },
+            GradientColors: {
+                type: 'array',
+                items: { type: 'string' },
+            },
+        },
+        required: ['type', 'name'],
+    },
+    StringOrStringArray: {
+        description: 'Accepts either a single string or an array of strings.',
+        anyOf: [{ type: 'string' }, { type: 'array', items: { type: 'string' } }],
+    },
+    BooleanOrString: {
+        description: 'Accepts either a boolean flag or a string command name.',
+        anyOf: [{ type: 'boolean' }, { type: 'string' }],
+    },
+};
 export function getSettingsSchema() {
     return SETTINGS_SCHEMA;
 }