abbyswag/qwen-code
1
0
Fork 0
mirror of https://github.com/QwenLM/qwen-code.git synced 2025-12-19 09:33:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: update and reorganize documentation (#806)

Browse Source
This commit is contained in:
cperry-goog
2025-06-07 10:47:30 -07:00
committed by GitHub
parent dcaecde844
commit 63757d6a7a
15 changed files with 170 additions and 163 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
docs/index.md
View File

@@ -6,6 +6,10 @@ This documentation provides a comprehensive guide to installing, using, and deve
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/core`), 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.
The `packages/cli` is the primary way users interact with the Gemini AI model and its associated tools directly from their terminal. It offers an interactive Read-Eval-Print Loop (REPL) environment where you can send prompts to Gemini, receive responses, and see the results of any tools Gemini uses to fulfill your requests.
The `packages/core` acts as the backend engine, handling communication with the Gemini API, managing tools, and processing requests from the CLI client.
## Navigating the Documentation
This documentation is organized into the following sections:
@@ -23,7 +27,8 @@ This documentation is organized into the following sections:
- **[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`, `edit_file`, etc.
- **[Shell Tool](./tools/shell.md):** Using the `execute_bash_command` tool.
- **[Web Fetch Tool](./tools/web.md):** Using the `web_fetch` tool.
- **[Web Fetch Tool](./tools/web-fetch.md):** Using the `web_fetch` tool.
- **[Web Search Tool](./tools/web-search.md):** Using the `google_web_search` tool.
- **[Multi-File Read Tool](./tools/multi-file.md):** Using the `read_many_files` tool.
- **[Contributing & Development Guide](../CONTRIBUTING.md):** Information for contributors and developers, including setup, building, testing, and coding conventions.
- **[Troubleshooting Guide](./troubleshooting.md):** Find solutions to common problems and FAQs.