From c5d0fc2c3e484d6d34a2dfb1e47e596582a534dc Mon Sep 17 00:00:00 2001 From: Jenna Inouye Date: Mon, 2 Feb 2026 10:28:32 -0800 Subject: [PATCH] Docs: Revise docs/index.md (#17879) --- docs/index.md | 224 ++++++++++++++++++++++---------------------------- 1 file changed, 99 insertions(+), 125 deletions(-) diff --git a/docs/index.md b/docs/index.md index e3ffb128db..c889350e04 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,149 +1,123 @@ -# Welcome to Gemini CLI documentation +# Gemini CLI documentation -This documentation provides a comprehensive guide to installing, using, and -developing Gemini CLI, a tool that lets you interact with Gemini models through -a command-line interface. +Gemini CLI is an open-source AI agent that brings the power of Gemini directly +into your terminal. It is designed to be a terminal-first, extensible, and +powerful tool for developers, engineers, SREs, and beyond. -## Gemini CLI overview +Gemini CLI integrates with your local environment. It can read and edit files, +execute shell commands, and search the web, all while maintaining your project +context. -Gemini CLI brings the capabilities of Gemini models to your terminal in an -interactive Read-Eval-Print Loop (REPL) environment. Gemini CLI consists of a -client-side application (`packages/cli`) that communicates with a local server -(`packages/core`), which in turn manages requests to the Gemini API and its AI -models. Gemini CLI also contains a variety of tools for tasks such as performing -file system operations, running shells, and web fetching, which are managed by -`packages/core`. +## Get started -## Navigating the documentation +Begin your journey with Gemini CLI by setting up your environment and learning +the basics. -This documentation is organized into the following sections: +- **[Quickstart](./get-started/index.md):** A streamlined guide to get you + chatting in minutes. +- **[Installation](./get-started/installation.md):** Instructions for macOS, + Linux, and Windows. +- **[Authentication](./get-started/authentication.md):** Set up access using + Google OAuth, API keys, or Vertex AI. +- **[Examples](./get-started/examples.md):** View common usage scenarios to + inspire your own workflows. -### Overview +## Use Gemini CLI -- **[Architecture overview](./architecture.md):** Understand the high-level - design of Gemini CLI, including its components and how they interact. -- **[Contribution guide](../CONTRIBUTING.md):** Information for contributors and - developers, including setup, building, testing, and coding conventions. +Master the core capabilities that let Gemini CLI interact with your system +safely and effectively. -### Get started - -- **[Gemini CLI quickstart](./get-started/index.md):** Let's get started with - Gemini CLI. -- **[Gemini 3 Pro on Gemini CLI](./get-started/gemini-3.md):** Learn how to - enable and use Gemini 3. -- **[Authentication](./get-started/authentication.md):** Authenticate to Gemini - CLI. -- **[Configuration](./get-started/configuration.md):** Learn how to configure - the CLI. -- **[Installation](./get-started/installation.md):** Install and run Gemini CLI. -- **[Examples](./get-started/examples.md):** Example usage of Gemini CLI. - -### CLI - -- **[Introduction: Gemini CLI](./cli/index.md):** Overview of the command-line +- **[Using the CLI](./cli/index.md):** Learn the basics of the command-line interface. -- **[Commands](./cli/commands.md):** Description of available CLI commands. -- **[Checkpointing](./cli/checkpointing.md):** Documentation for the - checkpointing feature. -- **[Custom commands](./cli/custom-commands.md):** Create your own commands and - shortcuts for frequently used prompts. -- **[Enterprise](./cli/enterprise.md):** Gemini CLI for enterprise. -- **[Headless mode](./cli/headless.md):** Use Gemini CLI programmatically for - scripting and automation. -- **[Keyboard shortcuts](./cli/keyboard-shortcuts.md):** A reference for all - keyboard shortcuts to improve your workflow. -- **[Model selection](./cli/model.md):** Select the model used to process your - commands with `/model`. -- **[Sandbox](./cli/sandbox.md):** Isolate tool execution in a secure, - containerized environment. -- **[Agent Skills](./cli/skills.md):** Extend the CLI with specialized expertise - and procedural workflows. -- **[Settings](./cli/settings.md):** Configure various aspects of the CLI's - behavior and appearance with `/settings`. -- **[Telemetry](./cli/telemetry.md):** Overview of telemetry in the CLI. -- **[Themes](./cli/themes.md):** Themes for Gemini CLI. -- **[Token caching](./cli/token-caching.md):** Token caching and optimization. -- **[Trusted Folders](./cli/trusted-folders.md):** An overview of the Trusted - Folders security feature. -- **[Tutorials](./cli/tutorials.md):** Tutorials for Gemini CLI. -- **[Uninstall](./cli/uninstall.md):** Methods for uninstalling the Gemini CLI. +- **[File management](./tools/file-system.md):** Grant the model the ability to + read code and apply changes directly to your files. +- **[Shell commands](./tools/shell.md):** Allow the model to run builds, tests, + and git commands. +- **[Memory management](./tools/memory.md):** Teach Gemini CLI facts about your + project and preferences that persist across sessions. +- **[Project context](./cli/gemini-md.md):** Use `GEMINI.md` files to provide + persistent context for your projects. +- **[Web search and fetch](./tools/web-search.md):** Enable the model to fetch + real-time information from the internet. +- **[Session management](./cli/session-management.md):** Save, resume, and + organize your chat sessions. -### Core +## Configuration -- **[Introduction: Gemini CLI core](./core/index.md):** Information about Gemini - CLI core. -- **[Memport](./core/memport.md):** Using the Memory Import Processor. -- **[Tools API](./core/tools-api.md):** Information on how the core manages and - exposes tools. -- **[System Prompt Override](./cli/system-prompt.md):** Replace built-in system - instructions using `GEMINI_SYSTEM_MD`. +Customize Gemini CLI to match your workflow and preferences. -- **[Policy Engine](./core/policy-engine.md):** Use the Policy Engine for - fine-grained control over tool execution. +- **[Settings](./cli/settings.md):** Control response creativity, output + verbosity, and more. +- **[Model selection](./cli/model.md):** Choose the best Gemini model for your + specific task. +- **[Ignore files](./cli/gemini-ignore.md):** Use `.geminiignore` to keep + sensitive files out of the model's context. +- **[Trusted folders](./cli/trusted-folders.md):** Define security boundaries + for file access and execution. +- **[Token caching](./cli/token-caching.md):** Optimize performance and cost by + caching context. +- **[Themes](./cli/themes.md):** Personalize the visual appearance of the CLI. -### Tools +## Advanced features -- **[Introduction: Gemini CLI tools](./tools/index.md):** Information about - Gemini CLI's tools. -- **[File system tools](./tools/file-system.md):** Documentation for the - `read_file` and `write_file` tools. -- **[Shell tool](./tools/shell.md):** Documentation for the `run_shell_command` - tool. -- **[Web fetch tool](./tools/web-fetch.md):** Documentation for the `web_fetch` - tool. -- **[Web search tool](./tools/web-search.md):** Documentation for the - `google_web_search` tool. -- **[Memory tool](./tools/memory.md):** Documentation for the `save_memory` - tool. -- **[Todo tool](./tools/todos.md):** Documentation for the `write_todos` tool. -- **[MCP servers](./tools/mcp-server.md):** Using MCP servers with Gemini CLI. +Explore powerful features for complex workflows and enterprise environments. -### Extensions +- **[Headless mode](./cli/headless.md):** Run Gemini CLI in scripts or CI/CD + pipelines for automated reasoning. +- **[Sandboxing](./cli/sandbox.md):** Execute untrusted code or tools in a + secure, isolated container. +- **[Checkpointing](./cli/checkpointing.md):** Save and restore workspace state + to recover from experimental changes. +- **[Custom commands](./cli/custom-commands.md):** Create shortcuts for + frequently used prompts. +- **[System prompt override](./cli/system-prompt.md):** Customize the core + instructions given to the model. +- **[Telemetry](./cli/telemetry.md):** Understand how usage data is collected + and managed. +- **[Enterprise](./cli/enterprise.md):** Manage configurations and policies for + large teams. -- **[Introduction: Extensions](./extensions/index.md):** How to extend the CLI - with new functionality. +## Extensions + +Extend Gemini CLI's capabilities with new tools and behaviors using extensions. + +- **[Introduction](./extensions/index.md):** Learn about the extension system + and how to manage extensions. - **[Writing extensions](./extensions/writing-extensions.md):** Learn how to - build your own extension. -- **[Extension releasing](./extensions/releasing.md):** How to release Gemini - CLI extensions. + create your first extension. +- **[Extensions reference](./extensions/reference.md):** Deeply understand the + extension format, commands, and configuration. +- **[Best practices](./extensions/best-practices.md):** Learn strategies for + building great extensions. +- **[Extensions releasing](./extensions/releasing.md):** Learn how to share your + extensions with the world. -### Hooks +## Ecosystem and extensibility -- **[Hooks](./hooks/index.md):** Intercept and customize Gemini CLI behavior at - key lifecycle points. -- **[Writing Hooks](./hooks/writing-hooks.md):** Learn how to create your first - hook with a comprehensive example. -- **[Best Practices](./hooks/best-practices.md):** Security, performance, and - debugging guidelines for hooks. +Connect Gemini CLI to external services and other development tools. -### IDE integration +- **[MCP servers](./tools/mcp-server.md):** Connect to external services using + the Model Context Protocol. +- **[IDE integration](./ide-integration/index.md):** Use Gemini CLI alongside VS + Code. +- **[Hooks](./hooks/index.md):** (Preview) Write scripts that run on specific + CLI events. +- **[Agent skills](./cli/skills.md):** (Preview) Add specialized expertise and + workflows. +- **[Sub-agents](./core/subagents.md):** (Preview) Delegate tasks to specialized + agents. -- **[Introduction to IDE integration](./ide-integration/index.md):** Connect the - CLI to your editor. -- **[IDE companion extension spec](./ide-integration/ide-companion-spec.md):** - Spec for building IDE companion extensions. +## Development and reference -### Development +Deep dive into the architecture and contribute to the project. -- **[NPM](./npm.md):** Details on how the project's packages are structured. -- **[Releases](./releases.md):** Information on the project's releases and - deployment cadence. -- **[Changelog](./changelogs/index.md):** Highlights and notable changes to +- **[Architecture](./architecture.md):** Understand the technical design of Gemini CLI. -- **[Integration tests](./integration-tests.md):** Information about the - integration testing framework used in this project. -- **[Issue and PR automation](./issue-and-pr-automation.md):** A detailed - overview of the automated processes we use to manage and triage issues and - pull requests. - -### Support - -- **[FAQ](./faq.md):** Frequently asked questions. -- **[Troubleshooting guide](./troubleshooting.md):** Find solutions to common - problems. -- **[Quota and pricing](./quota-and-pricing.md):** Learn about the free tier and - paid options. -- **[Terms of service and privacy notice](./tos-privacy.md):** Information on - the terms of service and privacy notices applicable to your use of Gemini CLI. - -We hope this documentation helps you make the most of Gemini CLI! +- **[Command reference](./cli/commands.md):** A complete list of available + commands. +- **[Local development](./local-development.md):** Set up your environment to + contribute to Gemini CLI. +- **[Contributing](../CONTRIBUTING.md):** Learn how to submit pull requests and + report issues. +- **[FAQ](./faq.md):** Answers to common questions. +- **[Troubleshooting](./troubleshooting.md):** Solutions for common issues.