gemini-cli/docs/index.md

Gemini CLI documentation

Gemini CLI brings the power of Gemini models directly into your terminal. Use it to understand code, automate tasks, and build workflows with your local project context.

Install

npm install -g @google/gemini-cli

Get started

• Overview: An overview of Gemini CLI and its features.
• Quickstart: Your first session with Gemini CLI.
• Installation: How to install Gemini CLI on your system.
• Authentication: Setup instructions for personal and enterprise accounts.
• Examples: Practical examples of Gemini CLI in action.
• CLI cheatsheet: A quick reference for common commands and options.
• Gemini 3 on Gemini CLI: Learn how to use Gemini 3 with Gemini CLI.

Use Gemini CLI

• File management: How to work with local files and directories.
• Manage context and memory: Managing persistent instructions and facts.
• Execute shell commands: Executing system commands safely.
• Manage sessions and history: Resuming, managing, and rewinding conversations.
• Plan tasks with todos: Using todos for complex workflows.
• Web search and fetch: Searching and fetching content from the web.
• Get started with skills: Getting started with specialized expertise.
• Set up an MCP server: Learn how to set up a Model-Context Protocol server.
• Automate tasks: Automate common development tasks.

Features

• Agent Skills: Extend the capabilities of Gemini CLI with custom skills.
• Authentication: Learn about the different authentication methods.
• Checkpointing: Automatically save and restore your sessions.
• Extensions: Extend the functionality of Gemini CLI with extensions.
• Headless mode: Run Gemini CLI in a non-interactive mode.
• Hooks: Customize the behavior of Gemini CLI with hooks.
• IDE integration: Integrate Gemini CLI with your favorite IDE.
• MCP servers: Connect to Model-Context Protocol servers.
• Model routing: Automatically route requests to the best model.
• Model selection: Learn how to select the right model for your task.
• Plan mode (experimental): Plan and review changes before they are executed.
• Rewind: Rewind the conversation to a previous point.
• Sandboxing: Isolate tool execution in a sandboxed environment.
• Settings: Customize the behavior of Gemini CLI.
• Telemetry: Understand the usage data that Gemini CLI collects.
• Token caching: Cache tokens to improve performance.

Configuration

• Custom commands: Create your own custom commands.
• Enterprise configuration: Configure Gemini CLI for your enterprise.
• Ignore files (.geminiignore): Ignore files and directories.
• Model configuration: Configure the generation settings for your models.
• Project context (GEMINI.md): Provide project-specific context to the model.
• Settings: A full reference of all the available settings.
• System prompt override: Override the default system prompt.
• Themes: Customize the look and feel of Gemini CLI.
• Trusted folders: Configure trusted folders to bypass security warnings.

Extensions

• Overview: An overview of the extension system.
• User guide: Install and manage: Learn how to install and manage extensions.
• Developer guide: Build extensions: Learn how to build your own extensions.
• Developer guide: Best practices: Best practices for writing extensions.
• Developer guide: Releasing: Learn how to release your extensions.
• Developer guide: Reference: A full reference of the extension API.

Development

• Contribution guide: Learn how to contribute to Gemini CLI.
• Integration testing: Learn how to run the integration tests.
• Issue and PR automation: Learn about the issue and PR automation.
• Local development: Learn how to set up your local development environment.
• NPM package structure: Learn about the structure of the NPM packages.

Reference

• Command reference: A full reference of all the available commands.
• Configuration reference: A full reference of all the available configuration options.
• Keyboard shortcuts: A list of all the available keyboard shortcuts.
• Memory import processor: Learn how to use the memory import processor.
• Policy engine: Learn how to use the policy engine.
• Tools API: Learn how to use the tools API.

Resources

• Quota and pricing: Information about quota and pricing.
• Terms and privacy: The terms of service and privacy policy.
• FAQ: Frequently asked questions.
• Troubleshooting: Troubleshooting common issues.
• Uninstall: How to uninstall Gemini CLI.

Changelog

• Release notes: The release notes for all versions.
• Stable release: The latest stable release.
• Preview release: The latest preview release.