gemini-cli/docs/index.md

Welcome to Gemini CLI documentation

This documentation provides a comprehensive guide to installing, using, and developing Gemini CLI. This tool lets you interact with Gemini models through a command-line interface.

Overview

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.

Navigating the documentation

This documentation is organized into the following sections:

Get started

• Gemini CLI Quickstart: Let's get started with Gemini CLI.
• Installation: Install and run Gemini CLI.
• Authentication: Authenticate Gemini CLI.
• Configuration: Information on configuring the CLI.
• Examples: Example usage of Gemini CLI.
• Get started with Gemini 3: Learn how to enable and use Gemini 3.

CLI

• CLI overview: Overview of the command-line interface.
• Commands: Description of available CLI commands.
• Enterprise: Gemini CLI for enterprise.
• Model Selection: Select the model used to process your commands with /model.
• Settings: Configure various aspects of the CLI's behavior and appearance with /settings.
• Themes: Themes for Gemini CLI.
• Token Caching: Token caching and optimization.
• Tutorials: Tutorials for Gemini CLI.
• Checkpointing: Documentation for the checkpointing feature.
• Telemetry: Overview of telemetry in the CLI.
• Trusted Folders: An overview of the Trusted Folders security feature.

Core

• Gemini CLI core overview: Information about Gemini CLI core.
• Memport: Using the Memory Import Processor.
• Tools API: Information on how the core manages and exposes tools.
• Policy Engine: Use the Policy Engine for fine-grained control over tool execution.

Tools

• Gemini CLI tools overview: Information about Gemini CLI's tools.
• File System Tools: Documentation for the read_file and write_file tools.
• MCP servers: Using MCP servers with Gemini CLI.
• Shell Tool: Documentation for the run_shell_command tool.
• Web Fetch Tool: Documentation for the web_fetch tool.
• Web Search Tool: Documentation for the google_web_search tool.
• Memory Tool: Documentation for the save_memory tool.
• Todo Tool: Documentation for the write_todos tool.

Extensions

• Extensions: How to extend the CLI with new functionality.
• Get Started with Extensions: Learn how to build your own extension.
• Extension Releasing: How to release Gemini CLI extensions.

IDE integration

• IDE Integration: Connect the CLI to your editor.
• IDE Companion Extension Spec: Spec for building IDE companion extensions.

About the Gemini CLI project

• Architecture Overview: Understand the high-level design of Gemini CLI, including its components and how they interact.
• Contributing & Development Guide: Information for contributors and developers, including setup, building, testing, and coding conventions.
• NPM: Details on how the project's packages are structured.
• Troubleshooting Guide: Find solutions to common problems.
• FAQ: Frequently asked questions.
• Terms of Service and Privacy Notice: Information on the terms of service and privacy notices applicable to your use of Gemini CLI.
• Releases: Information on the project's releases and deployment cadence.

We hope this documentation helps you make the most of Gemini CLI!