@google/gemini-cli 0.13.0-nightly.20251102.d7243fb8 → 0.13.0-preview.0

package/dist/src/config/settingsSchema.d.ts

@@ -3,7 +3,7 @@
  * Copyright 2025 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
-import type { MCPServerConfig, BugCommandSettings, TelemetrySettings, AuthType } from '@google/gemini-cli-core';
+import type { MCPServerConfig, BugCommandSettings, TelemetrySettings, AuthType, HookDefinition, HookEventName } from '@google/gemini-cli-core';
 import type { CustomTheme } from '../ui/themes/theme.js';
 import type { SessionRetentionSettings } from './settings.js';
 export type SettingsType = 'boolean' | 'string' | 'number' | 'array' | 'object' | 'enum';
@@ -18,6 +18,18 @@ export interface SettingEnumOption {
     value: string | number;
     label: string;
 }
+export interface SettingCollectionDefinition {
+    type: SettingsType;
+    description?: string;
+    properties?: SettingsSchema;
+    /** Enum type options  */
+    options?: readonly SettingEnumOption[];
+    /**
+     * Optional reference identifier for generators that emit a `$ref`.
+     * For example, a JSON schema generator can use this to point to a shared definition.
+     */
+    ref?: string;
+}
 export declare enum MergeStrategy {
     REPLACE = "replace",
     CONCAT = "concat",
@@ -39,6 +51,18 @@ export interface SettingDefinition {
     mergeStrategy?: MergeStrategy;
     /** Enum type options  */
     options?: readonly SettingEnumOption[];
+    /**
+     * For collection types (e.g. arrays), describes the shape of each item.
+     */
+    items?: SettingCollectionDefinition;
+    /**
+     * For map-like objects without explicit `properties`, describes the shape of the values.
+     */
+    additionalProperties?: SettingCollectionDefinition;
+    /**
+     * Optional reference identifier for generators that emit a `$ref`.
+     */
+    ref?: string;
 }
 export interface SettingsSchema {
     [key: string]: SettingDefinition;
@@ -60,6 +84,10 @@ declare const SETTINGS_SCHEMA: {
         readonly description: "Configuration for MCP servers.";
         readonly showInDialog: false;
         readonly mergeStrategy: MergeStrategy.SHALLOW_MERGE;
+        readonly additionalProperties: {
+            readonly type: "object";
+            readonly ref: "MCPServerConfig";
+        };
     };
     readonly general: {
         readonly type: "object";
@@ -243,7 +271,7 @@ declare const SETTINGS_SCHEMA: {
                 readonly category: "UI";
                 readonly requiresRestart: false;
                 readonly default: string | undefined;
-                readonly description: "The color theme for the UI.";
+                readonly description: "The color theme for the UI. See the CLI themes guide for available options.";
                 readonly showInDialog: false;
             };
             readonly customThemes: {
@@ -254,6 +282,10 @@ declare const SETTINGS_SCHEMA: {
                 readonly default: Record<string, CustomTheme>;
                 readonly description: "Custom theme definitions.";
                 readonly showInDialog: false;
+                readonly additionalProperties: {
+                    readonly type: "object";
+                    readonly ref: "CustomTheme";
+                };
             };
             readonly hideWindowTitle: {
                 readonly type: "boolean";
@@ -392,14 +424,26 @@ declare const SETTINGS_SCHEMA: {
                 readonly description: "Use the entire width of the terminal for output.";
                 readonly showInDialog: true;
             };
+            readonly useAlternateBuffer: {
+                readonly type: "boolean";
+                readonly label: "Use Alternate Screen Buffer";
+                readonly category: "UI";
+                readonly requiresRestart: true;
+                readonly default: false;
+                readonly description: "Use an alternate screen buffer for the UI, preserving shell history.";
+                readonly showInDialog: true;
+            };
             readonly customWittyPhrases: {
                 readonly type: "array";
                 readonly label: "Custom Witty Phrases";
                 readonly category: "UI";
                 readonly requiresRestart: false;
                 readonly default: string[];
-                readonly description: "Custom witty phrases to display during loading.";
+                readonly description: string;
                 readonly showInDialog: false;
+                readonly items: {
+                    readonly type: "string";
+                };
             };
             readonly accessibility: {
                 readonly type: "object";
@@ -489,6 +533,7 @@ declare const SETTINGS_SCHEMA: {
         readonly default: TelemetrySettings | undefined;
         readonly description: "Telemetry configuration.";
         readonly showInDialog: false;
+        readonly ref: "TelemetrySettings";
     };
     readonly model: {
         readonly type: "object";
@@ -525,8 +570,13 @@ declare const SETTINGS_SCHEMA: {
                 readonly default: Record<string, {
                     tokenBudget?: number;
                 }> | undefined;
-                readonly description: "Settings for summarizing tool output.";
+                readonly description: string;
                 readonly showInDialog: false;
+                readonly additionalProperties: {
+                    readonly type: "object";
+                    readonly description: "Per-tool summarization settings with an optional tokenBudget.";
+                    readonly ref: "SummarizeToolOutputSettings";
+                };
             };
             readonly compressionThreshold: {
                 readonly type: "number";
@@ -558,12 +608,13 @@ declare const SETTINGS_SCHEMA: {
         readonly showInDialog: false;
         readonly properties: {
             readonly fileName: {
-                readonly type: "object";
+                readonly type: "string";
                 readonly label: "Context File Name";
                 readonly category: "Context";
                 readonly requiresRestart: false;
                 readonly default: string | string[] | undefined;
-                readonly description: "The name of the context file.";
+                readonly ref: "StringOrStringArray";
+                readonly description: "The name of the context file or files to load into memory. Accepts either a single string or an array of strings.";
                 readonly showInDialog: false;
             };
             readonly importFormat: {
@@ -590,8 +641,11 @@ declare const SETTINGS_SCHEMA: {
                 readonly category: "Context";
                 readonly requiresRestart: false;
                 readonly default: string[];
-                readonly description: "Additional directories to include in the workspace context. Missing directories will be skipped with a warning.";
+                readonly description: string;
                 readonly showInDialog: false;
+                readonly items: {
+                    readonly type: "string";
+                };
                 readonly mergeStrategy: MergeStrategy.CONCAT;
             };
             readonly loadMemoryFromIncludeDirectories: {
@@ -600,7 +654,7 @@ declare const SETTINGS_SCHEMA: {
                 readonly category: "Context";
                 readonly requiresRestart: false;
                 readonly default: false;
-                readonly description: "Whether to load memory files from include directories.";
+                readonly description: string;
                 readonly showInDialog: true;
             };
             readonly fileFiltering: {
@@ -636,7 +690,7 @@ declare const SETTINGS_SCHEMA: {
                         readonly category: "Context";
                         readonly requiresRestart: true;
                         readonly default: true;
-                        readonly description: "Enable recursive file search functionality";
+                        readonly description: string;
                         readonly showInDialog: true;
                     };
                     readonly disableFuzzySearch: {
@@ -662,12 +716,13 @@ declare const SETTINGS_SCHEMA: {
         readonly showInDialog: false;
         readonly properties: {
             readonly sandbox: {
-                readonly type: "object";
+                readonly type: "string";
                 readonly label: "Sandbox";
                 readonly category: "Tools";
                 readonly requiresRestart: true;
                 readonly default: boolean | string | undefined;
-                readonly description: "Sandbox execution environment (can be a boolean or a path string).";
+                readonly ref: "BooleanOrString";
+                readonly description: string;
                 readonly showInDialog: false;
             };
             readonly shell: {
@@ -685,7 +740,7 @@ declare const SETTINGS_SCHEMA: {
                         readonly category: "Tools";
                         readonly requiresRestart: true;
                         readonly default: true;
-                        readonly description: "Use node-pty for an interactive shell experience. Fallback to child_process still applies.";
+                        readonly description: string;
                         readonly showInDialog: true;
                     };
                     readonly pager: {
@@ -714,7 +769,7 @@ declare const SETTINGS_SCHEMA: {
                 readonly category: "Tools";
                 readonly requiresRestart: false;
                 readonly default: false;
-                readonly description: "Automatically accept and execute tool calls that are considered safe (e.g., read-only operations).";
+                readonly description: string;
                 readonly showInDialog: true;
             };
             readonly core: {
@@ -723,8 +778,11 @@ declare const SETTINGS_SCHEMA: {
                 readonly category: "Tools";
                 readonly requiresRestart: true;
                 readonly default: string[] | undefined;
-                readonly description: "Paths to core tool definitions.";
+                readonly description: string;
                 readonly showInDialog: false;
+                readonly items: {
+                    readonly type: "string";
+                };
             };
             readonly allowed: {
                 readonly type: "array";
@@ -732,8 +790,11 @@ declare const SETTINGS_SCHEMA: {
                 readonly category: "Advanced";
                 readonly requiresRestart: true;
                 readonly default: string[] | undefined;
-                readonly description: "A list of tool names that will bypass the confirmation dialog.";
+                readonly description: string;
                 readonly showInDialog: false;
+                readonly items: {
+                    readonly type: "string";
+                };
             };
             readonly exclude: {
                 readonly type: "array";
@@ -743,6 +804,9 @@ declare const SETTINGS_SCHEMA: {
                 readonly default: string[] | undefined;
                 readonly description: "Tool names to exclude from discovery.";
                 readonly showInDialog: false;
+                readonly items: {
+                    readonly type: "string";
+                };
                 readonly mergeStrategy: MergeStrategy.UNION;
             };
             readonly discoveryCommand: {
@@ -760,7 +824,7 @@ declare const SETTINGS_SCHEMA: {
                 readonly category: "Tools";
                 readonly requiresRestart: true;
                 readonly default: string | undefined;
-                readonly description: "Command to run for tool calls.";
+                readonly description: string;
                 readonly showInDialog: false;
             };
             readonly useRipgrep: {
@@ -805,9 +869,18 @@ declare const SETTINGS_SCHEMA: {
                 readonly category: "Tools";
                 readonly requiresRestart: true;
                 readonly default: false;
-                readonly 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.";
+                readonly description: string;
                 readonly showInDialog: true;
             };
+            readonly enableHooks: {
+                readonly type: "boolean";
+                readonly label: "Enable Hooks System";
+                readonly category: "Advanced";
+                readonly requiresRestart: true;
+                readonly default: false;
+                readonly description: "Enable the hooks system for intercepting and customizing Gemini CLI behavior. When enabled, hooks configured in settings will execute at appropriate lifecycle events (BeforeTool, AfterTool, BeforeModel, etc.). Requires MessageBus integration.";
+                readonly showInDialog: false;
+            };
         };
     };
     readonly mcp: {
@@ -836,6 +909,9 @@ declare const SETTINGS_SCHEMA: {
                 readonly default: string[] | undefined;
                 readonly description: "A list of MCP servers to allow.";
                 readonly showInDialog: false;
+                readonly items: {
+                    readonly type: "string";
+                };
             };
             readonly excluded: {
                 readonly type: "array";
@@ -845,6 +921,9 @@ declare const SETTINGS_SCHEMA: {
                 readonly default: string[] | undefined;
                 readonly description: "A list of MCP servers to exclude.";
                 readonly showInDialog: false;
+                readonly items: {
+                    readonly type: "string";
+                };
             };
         };
     };
@@ -862,7 +941,7 @@ declare const SETTINGS_SCHEMA: {
         readonly label: "Use Write Todos";
         readonly category: "Advanced";
         readonly requiresRestart: false;
-        readonly default: false;
+        readonly default: true;
         readonly description: "Enable the write_todos_list tool.";
         readonly showInDialog: false;
     };
@@ -979,6 +1058,9 @@ declare const SETTINGS_SCHEMA: {
                 readonly default: string[];
                 readonly description: "Environment variables to exclude from project context.";
                 readonly showInDialog: false;
+                readonly items: {
+                    readonly type: "string";
+                };
                 readonly mergeStrategy: MergeStrategy.UNION;
             };
             readonly bugCommand: {
@@ -989,6 +1071,7 @@ declare const SETTINGS_SCHEMA: {
                 readonly default: BugCommandSettings | undefined;
                 readonly description: "Configuration for the bug report command.";
                 readonly showInDialog: false;
+                readonly ref: "BugCommandSettings";
             };
         };
     };
@@ -1042,7 +1125,7 @@ declare const SETTINGS_SCHEMA: {
                         readonly label: "Enable Codebase Investigator";
                         readonly category: "Experimental";
                         readonly requiresRestart: true;
-                        readonly default: false;
+                        readonly default: true;
                         readonly description: "Enable the Codebase Investigator agent.";
                         readonly showInDialog: true;
                     };
@@ -1051,7 +1134,7 @@ declare const SETTINGS_SCHEMA: {
                         readonly label: "Codebase Investigator Max Num Turns";
                         readonly category: "Experimental";
                         readonly requiresRestart: true;
-                        readonly default: 15;
+                        readonly default: 10;
                         readonly description: "Maximum number of turns for the Codebase Investigator agent.";
                         readonly showInDialog: true;
                     };
@@ -1060,7 +1143,7 @@ declare const SETTINGS_SCHEMA: {
                         readonly label: "Max Time (Minutes)";
                         readonly category: "Experimental";
                         readonly requiresRestart: true;
-                        readonly default: 5;
+                        readonly default: 3;
                         readonly description: "Maximum time for the Codebase Investigator agent (in minutes).";
                         readonly showInDialog: false;
                     };
@@ -1069,7 +1152,7 @@ declare const SETTINGS_SCHEMA: {
                         readonly label: "Thinking Budget";
                         readonly category: "Experimental";
                         readonly requiresRestart: true;
-                        readonly default: -1;
+                        readonly default: 8192;
                         readonly description: "The thinking budget for the Codebase Investigator agent.";
                         readonly showInDialog: false;
                     };
@@ -1103,6 +1186,9 @@ declare const SETTINGS_SCHEMA: {
                 readonly default: string[];
                 readonly description: "List of disabled extensions.";
                 readonly showInDialog: false;
+                readonly items: {
+                    readonly type: "string";
+                };
                 readonly mergeStrategy: MergeStrategy.UNION;
             };
             readonly workspacesWithMigrationNudge: {
@@ -1113,12 +1199,27 @@ declare const SETTINGS_SCHEMA: {
                 readonly default: string[];
                 readonly description: "List of workspaces for which the migration nudge has been shown.";
                 readonly showInDialog: false;
+                readonly items: {
+                    readonly type: "string";
+                };
                 readonly mergeStrategy: MergeStrategy.UNION;
             };
         };
     };
+    readonly hooks: {
+        readonly type: "object";
+        readonly label: "Hooks";
+        readonly category: "Advanced";
+        readonly requiresRestart: false;
+        readonly default: { [K in HookEventName]?: HookDefinition[]; };
+        readonly description: "Hook configurations for intercepting and customizing agent behavior.";
+        readonly showInDialog: false;
+        readonly mergeStrategy: MergeStrategy.SHALLOW_MERGE;
+    };
 };
 export type SettingsSchemaType = typeof SETTINGS_SCHEMA;
+export type SettingsJsonSchemaDefinition = Record<string, unknown>;
+export declare const SETTINGS_SCHEMA_DEFINITIONS: Record<string, SettingsJsonSchemaDefinition>;
 export declare function getSettingsSchema(): SettingsSchemaType;
 type InferSettings<T extends SettingsSchema> = {
     -readonly [K in keyof T]?: T[K] extends {