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:

• Execution and Deployment: Information for running Gemini CLI.
• Architecture Overview: Understand the high-level design of Gemini CLI, including its components and how they interact.
• Architecture Analysis: Deep dive into the architecture design of Gemini CLI.
• NPM: Information on the NPM package.
• Quotas and Pricing: Information on the quotas and pricing of Gemini CLI.
• Keyboard Shortcuts: Overview of keyboard shortcuts in the CLI.
• Ignore Files: How to ignore files and directories.
• CLI Usage: Documentation for packages/cli.
  • CLI Introduction: Overview of the command-line interface.
  • Commands: Description of available CLI commands.
  • Configuration: Information on configuring the CLI.
  • Checkpointing: Documentation for the checkpointing feature.
  • Extensions: How to extend the CLI with new functionality.
  • Themes: Themes for the CLI.
  • Telemetry: Overview of telemetry in the CLI.
• Core Details: Documentation for packages/core.
  • Core Introduction: Overview of the core component.
  • Tools API: Information on how the core manages and exposes tools.
  • Memory Import Processor: Documentation for the memory import processor.
• Tools:
  • Tools Overview: Overview of the available tools.
  • File System Tools: Documentation for the read_file and write_file tools.
  • Multi-File Read Tool: Documentation for the read_many_files tool.
  • 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.
• Update Log:
  • 2025-08-05: Update log of Gemini CLI 2025-08-05.
  • 2025-07-21: Update log of Gemini CLI 2025-07-21.
  • 2025-07-08: Update log of Gemini CLI 2025-07-08.
  • 2025-07-05: Update log of Gemini CLI 2025-07-05.
• Showcase: Showcase of Gemini CLI in action.
• Uninstall: How to uninstall Gemini CLI.
• Troubleshooting Guide: Find solutions to common problems and FAQs.
• Terms of Service and Privacy Notice: Information on the terms of service and privacy notices applicable to your use of Gemini CLI.
• Kiro:
  • How to Use Kiro (TypeScript/JavaScript): How to use Kiro (TypeScript/JavaScript).
  • Kiro vs Cursor: Kiro and Cursor comparison.

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