summaryrefslogtreecommitdiff
path: root/docs/index.md
diff options
context:
space:
mode:
authorcperry-goog <[email protected]>2025-05-15 20:04:33 -0700
committerGitHub <[email protected]>2025-05-15 20:04:33 -0700
commit58ef39e2a964386a1026ba68419e4d64c4612551 (patch)
tree5c00113b2a92a33ee9bc4f0d4dc03782d3b342b2 /docs/index.md
parent3674fb0c7e230651f1f33c4d46b24ca003dd532a (diff)
Docs: Add initial project documentation structure and content (#368)
Co-authored-by: Taylor Mullen <[email protected]>
Diffstat (limited to 'docs/index.md')
-rw-r--r--docs/index.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/docs/index.md b/docs/index.md
new file mode 100644
index 00000000..23a0f9fb
--- /dev/null
+++ b/docs/index.md
@@ -0,0 +1,33 @@
+# Welcome to the Gemini CLI Documentation
+
+This documentation provides a comprehensive guide to installing, using, and developing the Gemini CLI tool. Gemini CLI allows you to interact with Gemini models through a powerful and flexible command-line interface.
+
+## Overview
+
+The Gemini CLI is a tool designed to bring the capabilities of Gemini models to your terminal. It consists of a client-side application (`packages/cli`) that communicates with a local server (`packages/server`), which in turn interacts with the Gemini API. The CLI supports a variety of tools for file system operations, code execution, web fetching, and more, enhancing your workflow with AI-powered assistance.
+
+## Navigating the Documentation
+
+This documentation is organized into the following sections:
+
+- **[Getting Started](./getting-started.md):** Learn how to install, configure, and run the Gemini CLI for the first time.
+- **[Architecture Overview](./architecture.md):** Understand the high-level design of the Gemini CLI, including its core components and how they interact.
+- **CLI Usage:**
+ - **[CLI Introduction](./cli/index.md):** An overview of the command-line interface.
+ - **[Commands](./cli/commands.md):** Detailed descriptions of all available CLI commands.
+ - **[UI Guide](./cli/ui-guide.md):** Information on the terminal UI, themes, and customization.
+ - **[Configuration](./cli/configuration.md):** How to configure the CLI.
+- **Server Details:**
+ - **[Server Introduction](./server/index.md):** An overview of the server component.
+ - **[Configuration](./server/configuration.md):** How to configure the server.
+ - **[Tools API](./server/tools-api.md):** Information on how the server manages and exposes tools.
+- **Tools:**
+ - **[Tools Overview](./tools/index.md):** A general look at the available tools.
+ - **[File System Tools](./tools/file-system.md):** Documentation for tools like `read_file`, `write_file`, etc.
+ - **[Shell Tool](./tools/shell.md):** Using the `execute_bash_command` tool.
+ - **[Web Fetch Tool](./tools/web.md):** Using the `web_fetch` tool.
+ - **[Multi-File Read Tool](./tools/multi-file.md):** Using the `read_many_files` tool.
+- **[Contributing & Development Guide](../CONTRIBUTING.md#development-setup-and-workflow):** Information for contributors and developers, including setup, building, testing, and coding conventions.
+- **[Troubleshooting Guide](./troubleshooting.md):** Find solutions to common problems and FAQs.
+
+We hope this documentation helps you make the most of the Gemini CLI!