From 66d76ff3daa56b2dc1a1ddc12ca35f86456e328c Mon Sep 17 00:00:00 2001 From: g-samroberts Date: Tue, 17 Feb 2026 21:03:39 -0800 Subject: [PATCH] Update changed links. Delete cli/index as it's an outdated clone of docs/index. --- CONTRIBUTING.md | 2 +- docs/changelogs/index.md | 3 +- docs/cli/cli-reference.md | 46 ++++----- docs/cli/enterprise.md | 14 +-- docs/cli/gemini-md.md | 2 +- docs/cli/index.md | 123 ----------------------- docs/cli/model.md | 2 +- docs/cli/sandbox.md | 6 +- docs/cli/telemetry.md | 2 +- docs/cli/themes.md | 6 +- docs/cli/tutorials/memory-management.md | 4 +- docs/cli/tutorials/session-management.md | 2 +- docs/core/index.md | 14 +-- docs/core/subagents.md | 2 +- docs/extensions/reference.md | 2 +- docs/get-started/authentication.md | 8 +- docs/get-started/index.md | 2 +- docs/reference/commands.md | 10 +- docs/reference/configuration.md | 14 +-- docs/resources/faq.md | 2 +- docs/resources/troubleshooting.md | 2 +- docs/tools/index.md | 4 +- docs/tools/internal-docs.md | 6 +- docs/tools/shell.md | 6 +- 24 files changed, 83 insertions(+), 201 deletions(-) delete mode 100644 docs/cli/index.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6d8252f86c..c21d007770 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -546,7 +546,7 @@ Before submitting your documentation pull request, please: If you have questions about contributing documentation: -- Check our [FAQ](/docs/faq.md). +- Check our [FAQ](/docs/resources/faq). - Review existing documentation for examples. - Open [an issue](https://github.com/google-gemini/gemini-cli/issues) to discuss your proposed changes. diff --git a/docs/changelogs/index.md b/docs/changelogs/index.md index 013ee3281c..17de74defb 100644 --- a/docs/changelogs/index.md +++ b/docs/changelogs/index.md @@ -276,7 +276,8 @@ on GitHub. - **Experimental permission improvements:** We are now experimenting with a new policy engine in Gemini CLI. This allows users and administrators to create fine-grained policy for tool calls. Currently behind a flag. See - [policy engine documentation](../core/policy-engine.md) for more information. + [policy engine documentation](../reference/policy-engine.md) for more + information. - Blog: [https://allen.hutchison.org/2025/11/26/the-guardrails-of-autonomy/](https://allen.hutchison.org/2025/11/26/the-guardrails-of-autonomy/) - **Gemini 3 support for paid:** Gemini 3 support has been rolled out to all API diff --git a/docs/cli/cli-reference.md b/docs/cli/cli-reference.md index b44733916f..f8ff24bed6 100644 --- a/docs/cli/cli-reference.md +++ b/docs/cli/cli-reference.md @@ -26,29 +26,29 @@ and parameters. ## CLI Options -| Option | Alias | Type | Default | Description | -| -------------------------------- | ----- | ------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `--debug` | `-d` | boolean | `false` | Run in debug mode with verbose logging | -| `--version` | `-v` | - | - | Show CLI version number and exit | -| `--help` | `-h` | - | - | Show help information | -| `--model` | `-m` | string | `auto` | Model to use. See [Model Selection](#model-selection) for available values. | -| `--prompt` | `-p` | string | - | Prompt text. Appended to stdin input if provided. **Deprecated:** Use positional arguments instead. | -| `--prompt-interactive` | `-i` | string | - | Execute prompt and continue in interactive mode | -| `--sandbox` | `-s` | boolean | `false` | Run in a sandboxed environment for safer execution | -| `--approval-mode` | - | string | `default` | Approval mode for tool execution. Choices: `default`, `auto_edit`, `yolo` | -| `--yolo` | `-y` | boolean | `false` | **Deprecated.** Auto-approve all actions. Use `--approval-mode=yolo` instead. | -| `--experimental-acp` | - | boolean | - | Start in ACP (Agent Code Pilot) mode. **Experimental feature.** | -| `--experimental-zed-integration` | - | boolean | - | Run in Zed editor integration mode. **Experimental feature.** | -| `--allowed-mcp-server-names` | - | array | - | Allowed MCP server names (comma-separated or multiple flags) | -| `--allowed-tools` | - | array | - | **Deprecated.** Use the [Policy Engine](../core/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 (e.g. `--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) | -| `--screen-reader` | - | boolean | - | Enable screen reader mode for accessibility | -| `--output-format` | `-o` | string | `text` | The format of the CLI output. Choices: `text`, `json`, `stream-json` | +| Option | Alias | Type | Default | Description | +| -------------------------------- | ----- | ------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `--debug` | `-d` | boolean | `false` | Run in debug mode with verbose logging | +| `--version` | `-v` | - | - | Show CLI version number and exit | +| `--help` | `-h` | - | - | Show help information | +| `--model` | `-m` | string | `auto` | Model to use. See [Model Selection](#model-selection) for available values. | +| `--prompt` | `-p` | string | - | Prompt text. Appended to stdin input if provided. **Deprecated:** Use positional arguments instead. | +| `--prompt-interactive` | `-i` | string | - | Execute prompt and continue in interactive mode | +| `--sandbox` | `-s` | boolean | `false` | Run in a sandboxed environment for safer execution | +| `--approval-mode` | - | string | `default` | Approval mode for tool execution. Choices: `default`, `auto_edit`, `yolo` | +| `--yolo` | `-y` | boolean | `false` | **Deprecated.** Auto-approve all actions. Use `--approval-mode=yolo` instead. | +| `--experimental-acp` | - | boolean | - | Start in ACP (Agent Code Pilot) mode. **Experimental feature.** | +| `--experimental-zed-integration` | - | boolean | - | Run in Zed editor integration mode. **Experimental feature.** | +| `--allowed-mcp-server-names` | - | array | - | Allowed MCP server names (comma-separated or multiple flags) | +| `--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 (e.g. `--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) | +| `--screen-reader` | - | boolean | - | Enable screen reader mode for accessibility | +| `--output-format` | `-o` | string | `text` | The format of the CLI output. Choices: `text`, `json`, `stream-json` | ## Model selection diff --git a/docs/cli/enterprise.md b/docs/cli/enterprise.md index 31f7f89c83..b6d469755b 100644 --- a/docs/cli/enterprise.md +++ b/docs/cli/enterprise.md @@ -20,7 +20,7 @@ The most powerful tools for enterprise administration are the system-wide settings files. These files allow you to define a baseline configuration (`system-defaults.json`) and a set of overrides (`settings.json`) that apply to all users on a machine. For a complete overview of configuration options, see -the [Configuration documentation](../get-started/configuration.md). +the [Configuration documentation](../reference/configuration.md). Settings are merged from four files. The precedence order for single-value settings (like `theme`) is: @@ -224,8 +224,8 @@ gemini You can significantly enhance security by controlling which tools the Gemini model can use. This is achieved through the `tools.core` setting and the -[Policy Engine](../core/policy-engine.md). For a list of available tools, see -the [Tools documentation](../tools/index.md). +[Policy Engine](../reference/policy-engine.md). For a list of available tools, +see the [Tools documentation](../tools/index.md). ### Allowlisting with `coreTools` @@ -245,8 +245,8 @@ on the approved list. ### Blocklisting with `excludeTools` (Deprecated) -> **Deprecated:** Use the [Policy Engine](../core/policy-engine.md) for more -> robust control. +> **Deprecated:** Use the [Policy Engine](../reference/policy-engine.md) for +> more robust control. Alternatively, you can add specific tools that are considered dangerous in your environment to a blocklist. @@ -289,8 +289,8 @@ unintended tool execution. ## Managing custom tools (MCP servers) If your organization uses custom tools via -[Model-Context Protocol (MCP) servers](../core/tools-api.md), it is crucial to -understand how server configurations are managed to apply security policies +[Model-Context Protocol (MCP) servers](../reference/tools-api.md), it is crucial +to understand how server configurations are managed to apply security policies effectively. ### How MCP server configurations are merged diff --git a/docs/cli/gemini-md.md b/docs/cli/gemini-md.md index 01c99972d9..95f46ae095 100644 --- a/docs/cli/gemini-md.md +++ b/docs/cli/gemini-md.md @@ -88,7 +88,7 @@ More content here. @../shared/style-guide.md ``` -For more details, see the [Memory Import Processor](../core/memport.md) +For more details, see the [Memory Import Processor](../reference/memport.md) documentation. ## Customize the context file name diff --git a/docs/cli/index.md b/docs/cli/index.md deleted file mode 100644 index a9594169fa..0000000000 --- a/docs/cli/index.md +++ /dev/null @@ -1,123 +0,0 @@ -# Using Gemini CLI - -Gemini CLI is a terminal-first interface that brings the power of Gemini AI -models directly into your development workflow. It lets you interact with AI -using your local files, shell environment, and project context, creating a -bridge between generative AI and your system tools. - -## User guides - -These guides provide step-by-step instructions and practical examples for using -Gemini CLI in your daily development workflow. - -- **[Quickstart](../get-started/index.md):** Get up and running with Gemini CLI - in minutes. -- **[Examples](../get-started/examples.md):** See practical examples of Gemini - CLI in action. -- **[Get started with skills](./tutorials/skills-getting-started.md):** Learn - how to use and manage specialized expertise. -- **[File management](./tutorials/file-management.md):** How to include, search, - and modify local files. -- **[Set up an MCP server](./tutorials/mcp-setup.md):** Configure Model Context - Protocol servers for custom tools. -- **[Manage context and memory](./tutorials/memory-management.md):** Manage - persistent instructions and individual facts. -- **[Manage sessions and history](./tutorials/session-management.md):** Resume, - manage, and rewind your conversations. -- **[Execute shell commands](./tutorials/shell-commands.md):** Execute system - commands safely directly from your prompt. -- **[Plan tasks with todos](./tutorials/task-planning.md):** Using todos for - complex, multi-step agent requests. -- **[Web search and fetch](./tutorials/web-tools.md):** Searching and fetching - content from the web. - -## Features - -Technical reference documentation for each capability of Gemini CLI. - -- **[/about](../cli/commands.md#about):** Show version info. -- **[/auth](../cli/commands.md#auth):** Change authentication method. -- **[/bug](../cli/commands.md#bug):** File an issue about Gemini CLI. -- **[/chat](../cli/commands.md#chat):** Save and resume conversation history. -- **[/clear](../cli/commands.md#clear):** Clear the terminal screen. -- **[/compress](../cli/commands.md#compress):** Replace context with a summary. -- **[/copy](../cli/commands.md#copy):** Copy output to clipboard. -- **[/directory](../cli/commands.md#directory-or-dir):** Manage workspace - directories. -- **[/docs](../cli/commands.md#docs):** Open documentation in browser. -- **[/editor](../cli/commands.md#editor):** Select preferred editor. -- **[/extensions](../cli/commands.md#extensions):** List active extensions. -- **[/help](../cli/commands.md#help-or):** Display help information. -- **[/hooks](../hooks/index.md):** Manage hooks for lifecycle events. -- **[/ide](../ide-integration/index.md):** Manage IDE integration. -- **[/init](../cli/commands.md#init):** Create a GEMINI.md context file. -- **[/mcp](../tools/mcp-server.md):** Manage Model Context Protocol servers. -- **[/memory](../cli/commands.md#memory):** Manage instructional context. -- **[/model](./model.md):** Choose Gemini model. -- **[/policies](../cli/commands.md#policies):** Manage security policies. -- **[/privacy](../cli/commands.md#privacy):** Display privacy notice. -- **[/quit](../cli/commands.md#quit-or-exit):** Exit Gemini CLI. -- **[/restore](../cli/commands.md#restore):** Restore file state. -- **[/resume](../cli/commands.md#resume):** Browse and resume sessions. -- **[/rewind](./rewind.md):** Navigate backward through history. -- **[/settings](./settings.md):** Open settings editor. -- **[/setup-github](../cli/commands.md#setup-github):** Set up GitHub Actions. -- **[/shells](../cli/commands.md#shells-or-bashes):** Toggle background shells - view. -- **[/skills](./skills.md):** Manage Agent Skills. -- **[/stats](../cli/commands.md#stats):** Display session statistics. -- **[/terminal-setup](../cli/commands.md#terminal-setup):** Configure - keybindings. -- **[/theme](./themes.md):** Change visual theme. -- **[/tools](../cli/commands.md#tools):** Display list of available tools. -- **[/vim](../cli/commands.md#vim):** Toggle vim mode. -- **[Activate skill (tool)](../tools/activate-skill.md):** Internal mechanism - for loading expert procedures. -- **[Ask user (tool)](../tools/ask-user.md):** Internal dialog system for - clarification. -- **[Checkpointing](./checkpointing.md):** Automatic session snapshots. -- **[File system (tool)](../tools/file-system.md):** Technical details for local - file operations. -- **[Headless mode](./headless.md):** Programmatic and scripting interface. -- **[Internal documentation (tool)](../tools/internal-docs.md):** Technical - lookup for CLI features. -- **[Memory (tool)](../tools/memory.md):** Storage details for persistent facts. -- **[Model routing](./model-routing.md):** Automatic fallback resilience. -- **[Plan mode (experimental)](./plan-mode.md):** Use a safe, read-only mode for - planning complex changes. -- **[Sandboxing](./sandbox.md):** Isolate tool execution. -- **[Shell (tool)](../tools/shell.md):** Detailed system execution parameters. -- **[Telemetry](./telemetry.md):** Usage and performance metric details. -- **[Todo (tool)](../tools/todos.md):** Progress tracking specification. -- **[Token caching](./token-caching.md):** Performance optimization. -- **[Web fetch (tool)](../tools/web-fetch.md):** URL retrieval and extraction - details. -- **[Web search (tool)](../tools/web-search.md):** Google Search integration - technicals. - -## Configuration - -Settings and customization options for Gemini CLI. - -- **[Custom commands](./custom-commands.md):** Personalized shortcuts. -- **[Enterprise configuration](./enterprise.md):** Professional environment - controls. -- **[Ignore files (.geminiignore)](./gemini-ignore.md):** Exclusion pattern - reference. -- **[Model configuration](./generation-settings.md):** Fine-tune generation - parameters like temperature and thinking budget. -- **[Project context (GEMINI.md)](./gemini-md.md):** Technical hierarchy of - context files. -- **[Settings](./settings.md):** Full `settings.json` schema. -- **[System prompt override](./system-prompt.md):** Instruction replacement - logic. -- **[Themes](./themes.md):** UI personalization technical guide. -- **[Trusted folders](./trusted-folders.md):** Security permission logic. - -## Next steps - -- Explore the [Command reference](./commands.md) to learn about all available - slash commands. -- Read about [Project context](./gemini-md.md) to understand how to provide - persistent instructions to the model. -- See the [CLI reference](./cli-reference.md) for a quick cheatsheet of flags. diff --git a/docs/cli/model.md b/docs/cli/model.md index fd0e950bbb..62bfcf5b0b 100644 --- a/docs/cli/model.md +++ b/docs/cli/model.md @@ -39,7 +39,7 @@ To enable Gemini 3 Pro and Gemini 3 Flash (if available), enable You can also use the `--model` flag to specify a particular Gemini model on startup. For more details, refer to the -[configuration documentation](../get-started/configuration.md). +[configuration documentation](../reference/configuration.md). Changes to these settings will be applied to all subsequent interactions with Gemini CLI. diff --git a/docs/cli/sandbox.md b/docs/cli/sandbox.md index 9f632693c7..392c71a176 100644 --- a/docs/cli/sandbox.md +++ b/docs/cli/sandbox.md @@ -167,6 +167,6 @@ gemini -s -p "run shell command: mount | grep workspace" ## Related documentation -- [Configuration](../get-started/configuration.md): Full configuration options. -- [Commands](./commands.md): Available commands. -- [Troubleshooting](../troubleshooting.md): General troubleshooting. +- [Configuration](../reference/configuration.md): Full configuration options. +- [Commands](../reference/commands.md): Available commands. +- [Troubleshooting](../resources/troubleshooting.md): General troubleshooting. diff --git a/docs/cli/telemetry.md b/docs/cli/telemetry.md index ca44bccaf0..0cda8b4528 100644 --- a/docs/cli/telemetry.md +++ b/docs/cli/telemetry.md @@ -93,7 +93,7 @@ Environment variables can be used to override the settings in the file. `true` or `1` will enable the feature. Any other value will disable it. For detailed information about all configuration options, see the -[Configuration guide](../get-started/configuration.md). +[Configuration guide](../reference/configuration.md). ## Google Cloud telemetry diff --git a/docs/cli/themes.md b/docs/cli/themes.md index dc3423080f..08564a249a 100644 --- a/docs/cli/themes.md +++ b/docs/cli/themes.md @@ -41,8 +41,8 @@ can change the theme using the `/theme` command. ### Theme persistence Selected themes are saved in Gemini CLI's -[configuration](../get-started/configuration.md) so your preference is -remembered across sessions. +[configuration](../reference/configuration.md) so your preference is remembered +across sessions. --- @@ -194,7 +194,7 @@ untrusted sources. - Or, set it as the default by adding `"theme": "MyCustomTheme"` to the `ui` object in your `settings.json`. - Custom themes can be set at the user, project, or system level, and follow the - same [configuration precedence](../get-started/configuration.md) as other + same [configuration precedence](../reference/configuration.md) as other settings. ### Themes from extensions diff --git a/docs/cli/tutorials/memory-management.md b/docs/cli/tutorials/memory-management.md index f679719238..829fbecbd4 100644 --- a/docs/cli/tutorials/memory-management.md +++ b/docs/cli/tutorials/memory-management.md @@ -121,6 +121,6 @@ immediately. Force a reload with: - Learn about [Session management](session-management.md) to see how short-term history works. -- Explore the [Command reference](../../cli/commands.md) for more `/memory` - options. +- Explore the [Command reference](../../reference/commands.md) for more + `/memory` options. - Read the technical spec for [Project context](../../cli/gemini-md.md). diff --git a/docs/cli/tutorials/session-management.md b/docs/cli/tutorials/session-management.md index 775a1e9b5f..7815aa94d6 100644 --- a/docs/cli/tutorials/session-management.md +++ b/docs/cli/tutorials/session-management.md @@ -101,5 +101,5 @@ This creates a new branch of history without losing your original work. - Learn about [Checkpointing](../../cli/checkpointing.md) to understand the underlying safety mechanism. - Explore [Task planning](task-planning.md) to keep complex sessions organized. -- See the [Command reference](../../cli/commands.md) for all `/chat` and +- See the [Command reference](../../reference/commands.md) for all `/chat` and `/resume` options. diff --git a/docs/core/index.md b/docs/core/index.md index 0cd49ad43e..53aa647dc2 100644 --- a/docs/core/index.md +++ b/docs/core/index.md @@ -9,11 +9,11 @@ requests sent from `packages/cli`. For a general overview of Gemini CLI, see the - **[Sub-agents (experimental)](./subagents.md):** Learn how to create and use specialized sub-agents for complex tasks. -- **[Core tools API](./tools-api.md):** Information on how tools are defined, - registered, and used by the core. -- **[Memory Import Processor](./memport.md):** Documentation for the modular - GEMINI.md import feature using @file.md syntax. -- **[Policy Engine](./policy-engine.md):** Use the Policy Engine for +- **[Core tools API](../reference/tools-api.md):** Information on how tools are + defined, registered, and used by the core. +- **[Memory Import Processor](../reference/memport.md):** Documentation for the + modular GEMINI.md import feature using @file.md syntax. +- **[Policy Engine](../reference/policy-engine.md):** Use the Policy Engine for fine-grained control over tool execution. ## Role of the core @@ -92,8 +92,8 @@ This allows you to have global, project-level, and component-level context files, which are all combined to provide the model with the most relevant information. -You can use the [`/memory` command](../cli/commands.md) to `show`, `add`, and -`refresh` the content of loaded `GEMINI.md` files. +You can use the [`/memory` command](../reference/commands.md) to `show`, `add`, +and `refresh` the content of loaded `GEMINI.md` files. ## Citations diff --git a/docs/core/subagents.md b/docs/core/subagents.md index 1725d4a0f5..4ba1020509 100644 --- a/docs/core/subagents.md +++ b/docs/core/subagents.md @@ -17,7 +17,7 @@ the main agent's context or toolset. > ``` > > **Warning:** Sub-agents currently operate in -> ["YOLO mode"](../get-started/configuration.md#command-line-arguments), meaning +> ["YOLO mode"](../reference/configuration.md#command-line-arguments), meaning > they may execute tools without individual user confirmation for each step. > Proceed with caution when defining agents with powerful tools like > `run_shell_command` or `write_file`. diff --git a/docs/extensions/reference.md b/docs/extensions/reference.md index eec5b82025..b4a0df7336 100644 --- a/docs/extensions/reference.md +++ b/docs/extensions/reference.md @@ -130,7 +130,7 @@ The manifest file defines the extension's behavior and configuration. - `description`: A short summary shown in the extension gallery. - `mcpServers`: A map of Model Context Protocol (MCP) servers. Extension servers follow the same format as standard - [CLI configuration](../get-started/configuration.md). + [CLI configuration](../reference/configuration.md). - `contextFileName`: The name of the context file (defaults to `GEMINI.md`). Can also be an array of strings to load multiple context files. - `excludeTools`: An array of tools to block from the model. You can restrict diff --git a/docs/get-started/authentication.md b/docs/get-started/authentication.md index 6e2ce5ca05..e8696137cf 100644 --- a/docs/get-started/authentication.md +++ b/docs/get-started/authentication.md @@ -22,8 +22,8 @@ Select the authentication method that matches your situation in the table below: ### What is my Google account type? - **Individual Google accounts:** Includes all - [free tier accounts](../quota-and-pricing/#free-usage) such as Gemini Code - Assist for individuals, as well as paid subscriptions for + [free tier accounts](../resources/quota-and-pricing.md#free-usage) such as + Gemini Code Assist for individuals, as well as paid subscriptions for [Google AI Pro and Ultra](https://gemini.google/subscriptions/). - **Organization accounts:** Accounts using paid licenses through an @@ -317,5 +317,5 @@ configure authentication using environment variables: Your authentication method affects your quotas, pricing, Terms of Service, and privacy notices. Review the following pages to learn more: -- [Gemini CLI: Quotas and Pricing](../quota-and-pricing.md). -- [Gemini CLI: Terms of Service and Privacy Notice](../tos-privacy.md). +- [Gemini CLI: Quotas and Pricing](../resources/quota-and-pricing.md). +- [Gemini CLI: Terms of Service and Privacy Notice](../resources/tos-privacy.md). diff --git a/docs/get-started/index.md b/docs/get-started/index.md index 0dfb8ee18f..dfff12f53e 100644 --- a/docs/get-started/index.md +++ b/docs/get-started/index.md @@ -54,7 +54,7 @@ Gemini CLI offers several ways to configure its behavior, including environment variables, command-line arguments, and settings files. To explore your configuration options, see -[Gemini CLI Configuration](./configuration.md). +[Gemini CLI Configuration](../reference/configuration.md). ## Use diff --git a/docs/reference/commands.md b/docs/reference/commands.md index c9546948f4..0b6dfcff62 100644 --- a/docs/reference/commands.md +++ b/docs/reference/commands.md @@ -217,7 +217,7 @@ Slash commands provide meta-level control over the CLI itself. model. - **Note:** For more details on how `GEMINI.md` files contribute to hierarchical memory, see the - [CLI Configuration documentation](../get-started/configuration.md). + [CLI Configuration documentation](../reference/configuration.md). ### `/model` @@ -247,7 +247,7 @@ Slash commands provide meta-level control over the CLI itself. checkpoints to restore from. - **Usage:** `/restore [tool_call_id]` - **Note:** Only available if checkpointing is configured via - [settings](../get-started/configuration.md). See + [settings](../reference/configuration.md). See [Checkpointing documentation](../cli/checkpointing.md) for more details. ### `/rewind` @@ -286,7 +286,8 @@ Slash commands provide meta-level control over the CLI itself. settings that control the behavior and appearance of Gemini CLI. It is equivalent to manually editing the `.gemini/settings.json` file, but with validation and guidance to prevent errors. See the - [settings documentation](./settings.md) for a full list of available settings. + [settings documentation](../cli/settings.md) for a full list of available + settings. - **Usage:** Simply run `/settings` and the editor will open. You can then browse or search for specific settings, view their current values, and modify them as desired. Changes to some settings are applied immediately, while @@ -373,7 +374,8 @@ Slash commands provide meta-level control over the CLI itself. Custom commands allow you to create personalized shortcuts for your most-used prompts. For detailed instructions on how to create, manage, and use them, -please see the dedicated [Custom Commands documentation](./custom-commands.md). +please see the dedicated +[Custom Commands documentation](../cli/custom-commands.md). ## Input prompt shortcuts diff --git a/docs/reference/configuration.md b/docs/reference/configuration.md index 6e30344dce..6d82757b08 100644 --- a/docs/reference/configuration.md +++ b/docs/reference/configuration.md @@ -1199,8 +1199,8 @@ within your user's home folder. Environment variables are a common way to configure applications, especially for sensitive information like API keys or for settings that might change between environments. For authentication setup, see the -[Authentication documentation](./authentication.md) which covers all available -authentication methods. +[Authentication documentation](../get-started/authentication.md) which covers +all available authentication methods. The CLI automatically loads environment variables from an `.env` file. The loading order is: @@ -1219,7 +1219,8 @@ the `advanced.excludedEnvVars` setting in your `settings.json` file. - **`GEMINI_API_KEY`**: - Your API key for the Gemini API. - - One of several available [authentication methods](./authentication.md). + - One of several available + [authentication methods](../get-started/authentication.md). - Set this in your shell profile (e.g., `~/.bashrc`, `~/.zshrc`) or an `.env` file. - **`GEMINI_MODEL`**: @@ -1565,15 +1566,16 @@ conventions and context. about the active instructional context. - **Importing content:** You can modularize your context files by importing other Markdown files using the `@path/to/file.md` syntax. For more details, - see the [Memory Import Processor documentation](../core/memport.md). + see the [Memory Import Processor documentation](../reference/memport.md). - **Commands for memory management:** - Use `/memory refresh` to force a re-scan and reload of all context files from all configured locations. This updates the AI's instructional context. - Use `/memory show` to display the combined instructional context currently loaded, allowing you to verify the hierarchy and content being used by the AI. - - See the [Commands documentation](../cli/commands.md#memory) for full details - on the `/memory` command and its sub-commands (`show` and `refresh`). + - See the [Commands documentation](../reference/commands.md#memory) for full + details on the `/memory` command and its sub-commands (`show` and + `refresh`). By understanding and utilizing these configuration layers and the hierarchical nature of context files, you can effectively manage the AI's memory and tailor diff --git a/docs/resources/faq.md b/docs/resources/faq.md index 2e78f3aa34..eeb0396495 100644 --- a/docs/resources/faq.md +++ b/docs/resources/faq.md @@ -104,7 +104,7 @@ The Gemini CLI configuration is stored in two `settings.json` files: 1. In your home directory: `~/.gemini/settings.json`. 2. In your project's root directory: `./.gemini/settings.json`. -Refer to [Gemini CLI Configuration](./get-started/configuration.md) for more +Refer to [Gemini CLI Configuration](../reference/configuration.md) for more details. ## Google AI Pro/Ultra and subscription FAQs diff --git a/docs/resources/troubleshooting.md b/docs/resources/troubleshooting.md index f700d0b74f..9e567652d9 100644 --- a/docs/resources/troubleshooting.md +++ b/docs/resources/troubleshooting.md @@ -93,7 +93,7 @@ topics on: - **Cause:** When sandboxing is enabled, Gemini CLI may attempt operations that are restricted by your sandbox configuration, such as writing outside the project directory or system temp directory. - - **Solution:** Refer to the [Configuration: Sandboxing](./cli/sandbox.md) + - **Solution:** Refer to the [Configuration: Sandboxing](../cli/sandbox.md) documentation for more information, including how to customize your sandbox configuration. diff --git a/docs/tools/index.md b/docs/tools/index.md index 42304ef008..f496ad591a 100644 --- a/docs/tools/index.md +++ b/docs/tools/index.md @@ -98,5 +98,5 @@ Always review confirmation prompts carefully before allowing a tool to execute. ## Next steps - Learn how to [Provide context](../cli/gemini-md.md) to guide tool use. -- Explore the [Command reference](../cli/commands.md) for tool-related slash - commands. +- Explore the [Command reference](../reference/commands.md) for tool-related + slash commands. diff --git a/docs/tools/internal-docs.md b/docs/tools/internal-docs.md index f87099b2f3..42fc53b3cc 100644 --- a/docs/tools/internal-docs.md +++ b/docs/tools/internal-docs.md @@ -40,7 +40,7 @@ Gemini CLI uses this tool to ensure technical accuracy: ## Next steps -- Explore the [Command reference](../cli/commands.md) for a detailed guide to - slash commands. -- See the [Configuration guide](../get-started/configuration.md) for settings +- Explore the [Command reference](../reference/commands.md) for a detailed guide + to slash commands. +- See the [Configuration guide](../reference/configuration.md) for settings reference. diff --git a/docs/tools/shell.md b/docs/tools/shell.md index 7d8e407434..34fd7c8490 100644 --- a/docs/tools/shell.md +++ b/docs/tools/shell.md @@ -131,9 +131,9 @@ configuration file. commands. Including the generic `run_shell_command` acts as a wildcard, allowing any command not explicitly blocked. - `tools.exclude` [DEPRECATED]: To block specific commands, use the - [Policy Engine](../core/policy-engine.md). Historically, this setting allowed - adding entries to the `exclude` list under the `tools` category in the format - `run_shell_command()`. For example, + [Policy Engine](../reference/policy-engine.md). Historically, this setting + allowed adding entries to the `exclude` list under the `tools` category in the + format `run_shell_command()`. For example, `"tools": {"exclude": ["run_shell_command(rm)"]}` will block `rm` commands. The validation logic is designed to be secure and flexible: