MediaMetz/gemini-cli
1
0
Fork 0
mirror of https://github.com/google-gemini/gemini-cli.git synced 2026-05-12 12:54:07 -07:00
Code Issues Packages Projects Releases Wiki Activity

Docs: Make documentation links relative (#21490)

Browse Source
This commit is contained in:
Chris Williams
2026-03-09 08:23:00 -07:00
committed by GitHub
parent 936f6240dd
commit 0f019122b0
12 changed files with 93 additions and 91 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CONTRIBUTING.md
+3 -2
View File
@@ -267,7 +267,8 @@ npm run test:e2e
``` ```
For more detailed information on the integration testing framework, please see For more detailed information on the integration testing framework, please see
the [Integration Tests documentation](/docs/integration-tests.md). the
[Integration Tests documentation](https://geminicli.com/docs/integration-tests).
### Linting and preflight checks ### Linting and preflight checks
@@ -546,7 +547,7 @@ Before submitting your documentation pull request, please:
If you have questions about contributing documentation: If you have questions about contributing documentation:
- Check our [FAQ](/docs/resources/faq.md). - Check our [FAQ](https://geminicli.com/docs/resources/faq).
- Review existing documentation for examples. - Review existing documentation for examples.
- Open [an issue](https://github.com/google-gemini/gemini-cli/issues) to discuss - Open [an issue](https://github.com/google-gemini/gemini-cli/issues) to discuss
your proposed changes. your proposed changes.
docs/cli/plan-mode.md
+72 -69
View File
@@ -62,8 +62,11 @@ To start Plan Mode while using Gemini CLI:
- **Command:** Type `/plan` in the input box. - **Command:** Type `/plan` in the input box.
- **Natural Language:** Ask Gemini CLI to "start a plan for...". Gemini CLI - **Natural Language:** Ask Gemini CLI to "start a plan for...". Gemini CLI
calls the [`enter_plan_mode`] tool to switch modes. calls the
> **Note:** This tool is not available when Gemini CLI is in [YOLO mode]. [`enter_plan_mode`](../tools/planning.md#1-enter_plan_mode-enterplanmode) tool
to switch modes.
> **Note:** This tool is not available when Gemini CLI is in
> [YOLO mode](../reference/configuration.md#command-line-arguments).
## How to use Plan Mode ## How to use Plan Mode
@@ -74,7 +77,8 @@ Gemini CLI takes action.
will then enter Plan Mode (if it's not already) to research the task. will then enter Plan Mode (if it's not already) to research the task.
2. **Review research and provide input:** As Gemini CLI analyzes your codebase, 2. **Review research and provide input:** As Gemini CLI analyzes your codebase,
it may ask you questions or present different implementation options using it may ask you questions or present different implementation options using
[`ask_user`]. Provide your preferences to help guide the design. [`ask_user`](../tools/ask-user.md). Provide your preferences to help guide
the design.
3. **Review the plan:** Once Gemini CLI has a proposed strategy, it creates a 3. **Review the plan:** Once Gemini CLI has a proposed strategy, it creates a
detailed implementation plan as a Markdown file in your plans directory. You detailed implementation plan as a Markdown file in your plans directory. You
can open and read this file to understand the proposed changes. can open and read this file to understand the proposed changes.
@@ -116,25 +120,33 @@ Plan Mode enforces strict safety policies to prevent accidental changes.
These are the only allowed tools: These are the only allowed tools:
- **FileSystem (Read):** [`read_file`], [`list_directory`], [`glob`] - **FileSystem (Read):**
- **Search:** [`grep_search`], [`google_web_search`] [`read_file`](../tools/file-system.md#2-read_file-readfile),
- **Research Subagents:** [`codebase_investigator`], [`cli_help`] [`list_directory`](../tools/file-system.md#1-list_directory-readfolder),
- **Interaction:** [`ask_user`] [`glob`](../tools/file-system.md#4-glob-findfiles)
- **MCP tools (Read):** Read-only [MCP tools] (for example, `github_read_issue`, - **Search:** [`grep_search`](../tools/file-system.md#5-grep_search-searchtext),
`postgres_read_schema`) are allowed. [`google_web_search`](../tools/web-search.md)
- **Planning (Write):** [`write_file`] and [`replace`] only allowed for `.md` - **Research Subagents:**
[`codebase_investigator`](../core/subagents.md#codebase-investigator),
[`cli_help`](../core/subagents.md#cli-help-agent)
- **Interaction:** [`ask_user`](../tools/ask-user.md)
- **MCP tools (Read):** Read-only [MCP tools](../tools/mcp-server.md) (for
example, `github_read_issue`, `postgres_read_schema`) are allowed.
- **Planning (Write):**
[`write_file`](../tools/file-system.md#3-write_file-writefile) and
[`replace`](../tools/file-system.md#6-replace-edit) only allowed for `.md`
files in the `~/.gemini/tmp/<project>/<session-id>/plans/` directory or your files in the `~/.gemini/tmp/<project>/<session-id>/plans/` directory or your
[custom plans directory](#custom-plan-directory-and-policies). [custom plans directory](#custom-plan-directory-and-policies).
- **Memory:** [`save_memory`] - **Memory:** [`save_memory`](../tools/memory.md)
- **Skills:** [`activate_skill`] (allows loading specialized instructions and - **Skills:** [`activate_skill`](../cli/skills.md) (allows loading specialized
resources in a read-only manner) instructions and resources in a read-only manner)
### Custom planning with skills ### Custom planning with skills
You can use [Agent Skills] to customize how Gemini CLI approaches planning for You can use [Agent Skills](../cli/skills.md) to customize how Gemini CLI
specific types of tasks. When a skill is activated during Plan Mode, its approaches planning for specific types of tasks. When a skill is activated
specialized instructions and procedural workflows will guide the research, during Plan Mode, its specialized instructions and procedural workflows will
design, and planning phases. guide the research, design, and planning phases.
For example: For example:
@@ -151,10 +163,11 @@ based on the task description.
### Custom policies ### Custom policies
Plan Mode's default tool restrictions are managed by the [policy engine] and Plan Mode's default tool restrictions are managed by the
defined in the built-in [`plan.toml`] file. The built-in policy (Tier 1) [policy engine](../reference/policy-engine.md) and defined in the built-in
enforces the read-only state, but you can customize these rules by creating your [`plan.toml`] file. The built-in policy (Tier 1) enforces the read-only state,
own policies in your `~/.gemini/policies/` directory (Tier 2). but you can customize these rules by creating your own policies in your
`~/.gemini/policies/` directory (Tier 2).
#### Example: Automatically approve read-only MCP tools #### Example: Automatically approve read-only MCP tools
@@ -173,8 +186,8 @@ priority = 100
modes = ["plan"] modes = ["plan"]
``` ```
For more information on how the policy engine works, see the [policy engine] For more information on how the policy engine works, see the
docs. [policy engine](../reference/policy-engine.md) docs.
#### Example: Allow git commands in Plan Mode #### Example: Allow git commands in Plan Mode
@@ -194,9 +207,12 @@ modes = ["plan"]
#### Example: Enable custom subagents in Plan Mode #### Example: Enable custom subagents in Plan Mode
Built-in research [subagents] like [`codebase_investigator`] and [`cli_help`] Built-in research [subagents](../core/subagents.md) like
are enabled by default in Plan Mode. You can enable additional [custom [`codebase_investigator`](../core/subagents.md#codebase-investigator) and
subagents] by adding a rule to your policy. [`cli_help`](../core/subagents.md#cli-help-agent) are enabled by default in Plan
Mode. You can enable additional
[custom subagents](../core/subagents.md#creating-custom-subagents) by adding a
rule to your policy.
`~/.gemini/policies/research-subagents.toml` `~/.gemini/policies/research-subagents.toml`
@@ -235,10 +251,11 @@ locations defined within a project's workspace cannot be used to escape and
overwrite sensitive files elsewhere. Any user-configured directory must reside overwrite sensitive files elsewhere. Any user-configured directory must reside
within the project boundary. within the project boundary.
Using a custom directory requires updating your [policy engine] configurations Using a custom directory requires updating your
to allow `write_file` and `replace` in that specific location. For example, to [policy engine](../reference/policy-engine.md) configurations to allow
allow writing to the `.gemini/plans` directory within your project, create a `write_file` and `replace` in that specific location. For example, to allow
policy file at `~/.gemini/policies/plan-custom-directory.toml`: writing to the `.gemini/plans` directory within your project, create a policy
file at `~/.gemini/policies/plan-custom-directory.toml`:
```toml ```toml
[[rule]] [[rule]]
@@ -254,13 +271,16 @@ argsPattern = "\"file_path\":\"[^\"]+[\\\\/]+\\.gemini[\\\\/]+plans[\\\\/]+[\\w-
## Planning workflows ## Planning workflows
Plan Mode provides building blocks for structured research and design. These are Plan Mode provides building blocks for structured research and design. These are
implemented as [extensions] using core planning tools like [`enter_plan_mode`], implemented as [extensions](../extensions/index.md) using core planning tools
[`exit_plan_mode`], and [`ask_user`]. like [`enter_plan_mode`](../tools/planning.md#1-enter_plan_mode-enterplanmode),
[`exit_plan_mode`](../tools/planning.md#2-exit_plan_mode-exitplanmode), and
[`ask_user`](../tools/ask-user.md).
### Built-in planning workflow ### Built-in planning workflow
The built-in planner uses an adaptive workflow to analyze your project, consult The built-in planner uses an adaptive workflow to analyze your project, consult
you on trade-offs via [`ask_user`], and draft a plan for your approval. you on trade-offs via [`ask_user`](../tools/ask-user.md), and draft a plan for
your approval.
### Custom planning workflows ### Custom planning workflows
@@ -272,23 +292,29 @@ You can install or create specialized planners to suit your workflow.
"tracks" and stores persistent artifacts in your project's `conductor/` "tracks" and stores persistent artifacts in your project's `conductor/`
directory: directory:
- **Automate transitions:** Switches to read-only mode via [`enter_plan_mode`]. - **Automate transitions:** Switches to read-only mode via
- **Streamline decisions:** Uses [`ask_user`] for architectural choices. [`enter_plan_mode`](../tools/planning.md#1-enter_plan_mode-enterplanmode).
- **Streamline decisions:** Uses [`ask_user`](../tools/ask-user.md) for
architectural choices.
- **Maintain project context:** Stores artifacts in the project directory using - **Maintain project context:** Stores artifacts in the project directory using
[custom plan directory and policies](#custom-plan-directory-and-policies). [custom plan directory and policies](#custom-plan-directory-and-policies).
- **Handoff execution:** Transitions to implementation via [`exit_plan_mode`]. - **Handoff execution:** Transitions to implementation via
[`exit_plan_mode`](../tools/planning.md#2-exit_plan_mode-exitplanmode).
#### Build your own #### Build your own
Since Plan Mode is built on modular building blocks, you can develop your own Since Plan Mode is built on modular building blocks, you can develop your own
custom planning workflow as an [extensions]. By leveraging core tools and custom planning workflow as an [extensions](../extensions/index.md). By
[custom policies](#custom-policies), you can define how Gemini CLI researches leveraging core tools and [custom policies](#custom-policies), you can define
and stores plans for your specific domain. how Gemini CLI researches and stores plans for your specific domain.
To build a custom planning workflow, you can use: To build a custom planning workflow, you can use:
- **Tool usage:** Use core tools like [`enter_plan_mode`], [`ask_user`], and - **Tool usage:** Use core tools like
[`exit_plan_mode`] to manage the research and design process. [`enter_plan_mode`](../tools/planning.md#1-enter_plan_mode-enterplanmode),
[`ask_user`](../tools/ask-user.md), and
[`exit_plan_mode`](../tools/planning.md#2-exit_plan_mode-exitplanmode) to
manage the research and design process.
- **Customization:** Set your own storage locations and policy rules using - **Customization:** Set your own storage locations and policy rules using
[custom plan directories](#custom-plan-directory-and-policies) and [custom plan directories](#custom-plan-directory-and-policies) and
[custom policies](#custom-policies). [custom policies](#custom-policies).
@@ -302,8 +328,9 @@ high-reasoning model routing.
## Automatic Model Routing ## Automatic Model Routing
When using an [auto model], Gemini CLI automatically optimizes [model routing] When using an [auto model](../reference/configuration.md#model), Gemini CLI
based on the current phase of your task: automatically optimizes [model routing](../cli/telemetry.md#model-routing) based
on the current phase of your task:
1. **Planning Phase:** While in Plan Mode, the CLI routes requests to a 1. **Planning Phase:** While in Plan Mode, the CLI routes requests to a
high-reasoning **Pro** model to ensure robust architectural decisions and high-reasoning **Pro** model to ensure robust architectural decisions and
@@ -334,7 +361,8 @@ associated plan files and task trackers.
- **Default behavior:** Sessions (and their plans) are retained for **30 days**. - **Default behavior:** Sessions (and their plans) are retained for **30 days**.
- **Configuration:** You can customize this behavior via the `/settings` command - **Configuration:** You can customize this behavior via the `/settings` command
(search for **Session Retention**) or in your `settings.json` file. See (search for **Session Retention**) or in your `settings.json` file. See
[session retention] for more details. [session retention](../cli/session-management.md#session-retention) for more
details.
Manual deletion also removes all associated artifacts: Manual deletion also removes all associated artifacts:
@@ -344,32 +372,7 @@ Manual deletion also removes all associated artifacts:
If you use a [custom plans directory](#custom-plan-directory-and-policies), If you use a [custom plans directory](#custom-plan-directory-and-policies),
those files are not automatically deleted and must be managed manually. those files are not automatically deleted and must be managed manually.
[`list_directory`]: /docs/tools/file-system.md#1-list_directory-readfolder
[`read_file`]: /docs/tools/file-system.md#2-read_file-readfile
[`grep_search`]: /docs/tools/file-system.md#5-grep_search-searchtext
[`write_file`]: /docs/tools/file-system.md#3-write_file-writefile
[`glob`]: /docs/tools/file-system.md#4-glob-findfiles
[`google_web_search`]: /docs/tools/web-search.md
[`replace`]: /docs/tools/file-system.md#6-replace-edit
[MCP tools]: /docs/tools/mcp-server.md
[`save_memory`]: /docs/tools/memory.md
[`activate_skill`]: /docs/cli/skills.md
[`codebase_investigator`]: /docs/core/subagents.md#codebase-investigator
[`cli_help`]: /docs/core/subagents.md#cli-help-agent
[subagents]: /docs/core/subagents.md
[custom subagents]: /docs/core/subagents.md#creating-custom-subagents
[policy engine]: /docs/reference/policy-engine.md
[`enter_plan_mode`]: /docs/tools/planning.md#1-enter_plan_mode-enterplanmode
[`exit_plan_mode`]: /docs/tools/planning.md#2-exit_plan_mode-exitplanmode
[`ask_user`]: /docs/tools/ask-user.md
[YOLO mode]: /docs/reference/configuration.md#command-line-arguments
[`plan.toml`]: [`plan.toml`]:
https://github.com/google-gemini/gemini-cli/blob/main/packages/core/src/policy/policies/plan.toml https://github.com/google-gemini/gemini-cli/blob/main/packages/core/src/policy/policies/plan.toml
[auto model]: /docs/reference/configuration.md#model
[model routing]: /docs/cli/telemetry.md#model-routing
[preferred external editor]: /docs/reference/configuration.md#general
[session retention]: /docs/cli/session-management.md#session-retention
[extensions]: /docs/extensions/
[Conductor]: https://github.com/gemini-cli-extensions/conductor [Conductor]: https://github.com/gemini-cli-extensions/conductor
[open an issue]: https://github.com/google-gemini/gemini-cli/issues [open an issue]: https://github.com/google-gemini/gemini-cli/issues
[Agent Skills]: /docs/cli/skills.md
docs/core/subagents.md
+1 -1
View File
@@ -297,7 +297,7 @@ Gemini CLI can also delegate tasks to remote subagents using the Agent-to-Agent
> **Note: Remote subagents are currently an experimental feature.** > **Note: Remote subagents are currently an experimental feature.**
See the [Remote Subagents documentation](/docs/core/remote-agents) for detailed See the [Remote Subagents documentation](remote-agents) for detailed
configuration and usage instructions. configuration and usage instructions.
## Extension subagents ## Extension subagents
docs/get-started/authentication.md
+1 -1
View File
@@ -6,7 +6,7 @@ using the CLI.
> **Note:** Looking for a high-level comparison of all available subscriptions? > **Note:** Looking for a high-level comparison of all available subscriptions?
> To compare features and find the right quota for your needs, see our > To compare features and find the right quota for your needs, see our
> [Plans page](/plans/). > [Plans page](https://geminicli.com/plans/).
For most users, we recommend starting Gemini CLI and logging in with your For most users, we recommend starting Gemini CLI and logging in with your
personal Google account. personal Google account.
docs/get-started/gemini-3.md
+1 -1
View File
@@ -41,7 +41,7 @@ limit resets and Gemini 3 Pro can be used again.
> **Note:** Looking to upgrade for higher limits? To compare subscription > **Note:** Looking to upgrade for higher limits? To compare subscription
> options and find the right quota for your needs, see our > options and find the right quota for your needs, see our
> [Plans page](/plans/). > [Plans page](https://geminicli.com/plans/).
Similarly, when you reach your daily usage limit for Gemini 2.5 Pro, you’ll see Similarly, when you reach your daily usage limit for Gemini 2.5 Pro, you’ll see
a message prompting fallback to Gemini 2.5 Flash. a message prompting fallback to Gemini 2.5 Flash.
docs/get-started/installation.md
+1 -1
View File
@@ -70,7 +70,7 @@ gemini
``` ```
For a list of options and additional commands, see the For a list of options and additional commands, see the
[CLI cheatsheet](/docs/cli/cli-reference.md). [CLI cheatsheet](../cli/cli-reference.md).
You can also run Gemini CLI using one of the following advanced methods: You can also run Gemini CLI using one of the following advanced methods:
docs/hooks/best-practices.md
+1 -1
View File
@@ -449,7 +449,7 @@ When you open a project with hooks defined in `.gemini/settings.json`:
Hooks inherit the environment of the Gemini CLI process, which may include Hooks inherit the environment of the Gemini CLI process, which may include
sensitive API keys. Gemini CLI provides a sensitive API keys. Gemini CLI provides a
[redaction system](/docs/reference/configuration.md#environment-variable-redaction) [redaction system](../reference/configuration.md#environment-variable-redaction)
that automatically filters variables matching sensitive patterns (e.g., `KEY`, that automatically filters variables matching sensitive patterns (e.g., `KEY`,
`TOKEN`). `TOKEN`).
docs/hooks/index.md
+6 -6
View File
@@ -22,11 +22,11 @@ With hooks, you can:
### Getting started ### Getting started
- **[Writing hooks guide](/docs/hooks/writing-hooks)**: A tutorial on creating - **[Writing hooks guide](../hooks/writing-hooks)**: A tutorial on creating your
your first hook with comprehensive examples. first hook with comprehensive examples.
- **[Best practices](/docs/hooks/best-practices)**: Guidelines on security, - **[Best practices](../hooks/best-practices)**: Guidelines on security,
performance, and debugging. performance, and debugging.
- **[Hooks reference](/docs/hooks/reference)**: The definitive technical - **[Hooks reference](../hooks/reference)**: The definitive technical
specification of I/O schemas and exit codes. specification of I/O schemas and exit codes.
## Core concepts ## Core concepts
@@ -152,8 +152,8 @@ Gemini CLI **fingerprints** project hooks. If a hook's name or command changes
(e.g., via `git pull`), it is treated as a **new, untrusted hook** and you will (e.g., via `git pull`), it is treated as a **new, untrusted hook** and you will
be warned before it executes. be warned before it executes.
See [Security Considerations](/docs/hooks/best-practices#using-hooks-securely) See [Security Considerations](../hooks/best-practices#using-hooks-securely) for
for a detailed threat model. a detailed threat model.
## Managing hooks ## Managing hooks
docs/hooks/reference.md
+2 -2
View File
@@ -82,8 +82,8 @@ For `BeforeTool` and `AfterTool` events, the `matcher` field in your settings is
compared against the name of the tool being executed. compared against the name of the tool being executed.
- **Built-in Tools**: You can match any built-in tool (e.g., `read_file`, - **Built-in Tools**: You can match any built-in tool (e.g., `read_file`,
`run_shell_command`). See the [Tools Reference](/docs/reference/tools) for a `run_shell_command`). See the [Tools Reference](../reference/tools) for a full
full list of available tool names. list of available tool names.
- **MCP Tools**: Tools from MCP servers follow the naming pattern - **MCP Tools**: Tools from MCP servers follow the naming pattern
`mcp__<server_name>__<tool_name>`. `mcp__<server_name>__<tool_name>`.
- **Regex Support**: Matchers support regular expressions (e.g., - **Regex Support**: Matchers support regular expressions (e.g.,
docs/reference/policy-engine.md
+2 -4
View File
@@ -143,8 +143,8 @@ always active.
confirmation. confirmation.
- `autoEdit`: Optimized for automated code editing; some write tools may be - `autoEdit`: Optimized for automated code editing; some write tools may be
auto-approved. auto-approved.
- `plan`: A strict, read-only mode for research and design. See [Customizing - `plan`: A strict, read-only mode for research and design. See
Plan Mode Policies]. [Customizing Plan Mode Policies](../cli/plan-mode.md#customizing-policies).
- `yolo`: A mode where all tools are auto-approved (use with extreme caution). - `yolo`: A mode where all tools are auto-approved (use with extreme caution).
## Rule matching ## Rule matching
@@ -360,5 +360,3 @@ out-of-the-box experience.
- In **`yolo`** mode, a high-priority rule allows all tools. - In **`yolo`** mode, a high-priority rule allows all tools.
- In **`autoEdit`** mode, rules allow certain write operations to happen without - In **`autoEdit`** mode, rules allow certain write operations to happen without
prompting. prompting.
[Customizing Plan Mode Policies]: /docs/cli/plan-mode.md#customizing-policies
docs/resources/quota-and-pricing.md
+1 -1
View File
@@ -5,7 +5,7 @@ use cases. For enterprise or professional usage, or if you need increased quota,
several options are available depending on your authentication account type. several options are available depending on your authentication account type.
For a high-level comparison of available subscriptions and to select the right For a high-level comparison of available subscriptions and to select the right
quota for your needs, see the [Plans page](/plans/). quota for your needs, see the [Plans page](https://geminicli.com/plans/).
## Overview ## Overview
docs/resources/tos-privacy.md
+2 -2
View File
@@ -16,8 +16,8 @@ account.
Your Gemini CLI Usage Statistics are handled in accordance with Google's Privacy Your Gemini CLI Usage Statistics are handled in accordance with Google's Privacy
Policy. Policy.
**Note:** See [quotas and pricing](/docs/resources/quota-and-pricing.md) for the **Note:** See [quotas and pricing](quota-and-pricing.md) for the quota and
quota and pricing details that apply to your usage of the Gemini CLI. pricing details that apply to your usage of the Gemini CLI.
## Supported authentication methods ## Supported authentication methods