MediaMetz/gemini-cli
1
0
Fork 0
mirror of https://github.com/google-gemini/gemini-cli.git synced 2026-03-10 14:10:37 -07:00
Code Issues Packages Projects Releases Wiki Activity

cleanup(markdown): Prettier format all markdown @ 80 char width (#10714)

Browse Source
This commit is contained in:
Richie Foreman
2025-10-09 08:17:37 -04:00
committed by GitHub
parent 0cd490a9b8
commit a08938010c
60 changed files with 4796 additions and 1733 deletions
Download Patch File Download Diff File Expand all files Collapse all files

82
docs/index.md
View File

@@ -1,10 +1,18 @@
# 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.
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`.
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
@@ -12,10 +20,13 @@ This documentation is organized into the following sections:
### Get started
- **[Gemini CLI Quickstart](./get-started/index.md):** Let's get started with Gemini CLI.
- **[Gemini CLI Quickstart](./get-started/index.md):** Let's get started with
Gemini CLI.
- **[Deployment](./get-started/deployment.md):** Install and run Gemini CLI.
- **[Authentication](./get-started/authentication.md):** Authenticate Gemini CLI.
- **[Configuration](./get-started/configuration.md):** Information on configuring the CLI.
- **[Authentication](./get-started/authentication.md):** Authenticate Gemini
CLI.
- **[Configuration](./get-started/configuration.md):** Information on
configuring the CLI.
- **[Examples](./get-started/examples.md):** Example usage of Gemini CLI.
### CLI
@@ -26,45 +37,66 @@ This documentation is organized into the following sections:
- **[Themes](./cli/themes.md):** Themes for Gemini CLI.
- **[Token Caching](./cli/token-caching.md):** Token caching and optimization.
- **[Tutorials](./cli/tutorials.md):** Tutorials for Gemini CLI.
- **[Checkpointing](./cli/checkpointing.md):** Documentation for the checkpointing feature.
- **[Checkpointing](./cli/checkpointing.md):** Documentation for the
checkpointing feature.
- **[Telemetry](./cli/telemetry.md):** Overview of telemetry in the CLI.
- **[Trusted Folders](./cli/trusted-folders.md):** An overview of the Trusted Folders security feature.
- **[Trusted Folders](./cli/trusted-folders.md):** An overview of the Trusted
Folders security feature.
### Core
- **[Gemini CLI core overview](./core/index.md):** Information about Gemini CLI core.
- **[Gemini CLI core overview](./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.
- **[Tools API](./core/tools-api.md):** Information on how the core manages and
exposes tools.
### Tools
- **[Gemini CLI tools overview](./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.
- **[Gemini CLI tools overview](./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.
- **[MCP servers](./tools/mcp-server.md):** Using MCP servers with Gemini CLI.
- **[Multi-File Read Tool](./tools/multi-file.md):** Documentation for the `read_many_files` tool.
- **[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.
- **[Multi-File Read Tool](./tools/multi-file.md):** Documentation for the
`read_many_files` tool.
- **[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.
### Extensions
- **[Extensions](./extensions/index.md):** How to extend the CLI with new functionality.
- **[Extension Releasing](./extensions/extension-releasing.md):** How to release Gemini CLI extensions.
- **[Extensions](./extensions/index.md):** How to extend the CLI with new
functionality.
- **[Extension Releasing](./extensions/extension-releasing.md):** How to release
Gemini CLI extensions.
### IDE integration
- **[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.
- **[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.
### About the Gemini CLI project
- **[Architecture Overview](./architecture.md):** Understand the high-level design of Gemini CLI, including its components and how they interact.
- **[Contributing & Development Guide](../CONTRIBUTING.md):** Information for contributors and developers, including setup, building, testing, and coding conventions.
- **[Architecture Overview](./architecture.md):** Understand the high-level
design of Gemini CLI, including its components and how they interact.
- **[Contributing & Development Guide](../CONTRIBUTING.md):** Information for
contributors and developers, including setup, building, testing, and coding
conventions.
- **[NPM](./npm.md):** Details on how the project's packages are structured.
- **[Troubleshooting Guide](./troubleshooting.md):** Find solutions to common problems.
- **[Troubleshooting Guide](./troubleshooting.md):** Find solutions to common
problems.
- **[FAQ](./faq.md):** Frequently asked questions.
- **[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.
- **[Releases](./releases.md):** Information on the project's releases and deployment cadence.
- **[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.
- **[Releases](./releases.md):** Information on the project's releases and
deployment cadence.
We hope this documentation helps you make the most of Gemini CLI!