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

Update changed links. Delete cli/index as it's an

Browse Source 
outdated clone of docs/index.
This commit is contained in:
g-samroberts
2026-02-17 21:03:39 -08:00
parent 0efda7c790
commit 66d76ff3da
24 changed files with 83 additions and 201 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CONTRIBUTING.md
+1 -1
View File
@@ -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.
docs/changelogs/index.md
+2 -1
View File
@@ -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
docs/cli/cli-reference.md
+2 -2
View File
@@ -27,7 +27,7 @@ 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 |
@@ -40,7 +40,7 @@ and parameters.
| `--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) |
| `--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`) |
docs/cli/enterprise.md
+7 -7
View File
@@ -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
docs/cli/gemini-md.md
+1 -1
View File
@@ -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
docs/cli/index.md
-123
View File
@@ -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.
docs/cli/model.md
+1 -1
View File
@@ -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.
docs/cli/sandbox.md
+3 -3
View File
@@ -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.
docs/cli/telemetry.md
+1 -1
View File
@@ -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
docs/cli/themes.md
+3 -3
View File
@@ -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
docs/cli/tutorials/memory-management.md
+2 -2
View File
@@ -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).
docs/cli/tutorials/session-management.md
+1 -1
View File
@@ -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.
docs/core/index.md
+7 -7
View File
@@ -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
docs/core/subagents.md
+1 -1
View File
@@ -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`.
docs/extensions/reference.md
+1 -1
View File
@@ -130,7 +130,7 @@ The manifest file defines the extension's behavior and configuration.
- `description`: A short summary shown in the extension gallery.
- <a id="mcp-servers"></a>`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
docs/get-started/authentication.md
+4 -4
View File
@@ -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).
docs/get-started/index.md
+1 -1
View File
@@ -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
docs/reference/commands.md
+6 -4
View File
@@ -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
docs/reference/configuration.md
+8 -6
View File
@@ -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
docs/resources/faq.md
+1 -1
View File
@@ -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
docs/resources/troubleshooting.md
+1 -1
View File
@@ -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.
docs/tools/index.md
+2 -2
View File
@@ -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.
docs/tools/internal-docs.md
+3 -3
View File
@@ -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.
docs/tools/shell.md
+3 -3
View File
@@ -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(<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(<command>)`. For example,
`"tools": {"exclude": ["run_shell_command(rm)"]}` will block `rm` commands.
The validation logic is designed to be secure and flexible: