qwen-code/docs/index.md

Welcome to Qwen Code documentation

This documentation provides a comprehensive guide to installing, using, and developing Qwen Code. This tool lets you interact with AI models through a command-line interface.

Overview

Qwen Code brings the capabilities of advanced code models to your terminal in an interactive Read-Eval-Print Loop (REPL) environment. Qwen Code consists of a client-side application (packages/cli) that communicates with a local server (packages/core). Qwen Code 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 Qwen Code.
• Architecture Overview: Understand the high-level design of Qwen Code, including its components and how they interact.
• 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.
  • IDE Integration: Connect the CLI to your editor.
  • IDE Companion Extension Spec: Spec for building IDE companion extensions.
  • Telemetry: Overview of telemetry in the CLI.
  • Trusted Folders: An overview of the Trusted Folders security feature.
• Core Details: Documentation for packages/core.
  • Core Introduction: Overview of the core component.
  • Tools API: Information on how the core manages and exposes tools.
• 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 web_search tool.
  • Memory Tool: Documentation for the save_memory tool.
• Subagents: Specialized AI assistants for focused tasks with comprehensive management, configuration, and usage guidance.
• Contributing & Development Guide: Information for contributors and developers, including setup, building, testing, and coding conventions.
• NPM: Details on how the project's packages are structured
• 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 Qwen Code.

We hope this documentation helps you make the most of Qwen Code!