From 17785c418d7555c257fc6ca389ebe51fac3c099d Mon Sep 17 00:00:00 2001 From: pomelo-nwu Date: Thu, 4 Dec 2025 18:26:05 +0800 Subject: [PATCH] feat: restructure docs --- .../assets/connected_devtools.png | Bin .../assets/gemini-screenshot.png | Bin .../assets/qwen-screenshot.png | Bin .../{ => developers}/assets/release_patch.png | Bin .../assets/theme-ansi-light.png | Bin docs/{ => developers}/assets/theme-ansi.png | Bin .../assets/theme-atom-one.png | Bin .../assets/theme-ayu-light.png | Bin docs/{ => developers}/assets/theme-ayu.png | Bin docs/{ => developers}/assets/theme-custom.png | Bin .../assets/theme-default-light.png | Bin .../{ => developers}/assets/theme-default.png | Bin .../{ => developers}/assets/theme-dracula.png | Bin .../assets/theme-github-light.png | Bin docs/{ => developers}/assets/theme-github.png | Bin .../assets/theme-google-light.png | Bin .../assets/theme-xcode-light.png | Bin docs/{ => developers}/cli/Uninstall.md | 0 docs/{ => developers}/cli/_meta.ts | 0 docs/{ => developers}/cli/authentication.md | 0 docs/{ => developers}/cli/commands.md | 0 docs/{ => developers}/cli/configuration-v1.md | 0 docs/{ => developers}/cli/configuration.md | 0 docs/{ => developers}/cli/index.md | 0 .../cli/keyboard-shortcuts.md | 0 docs/{ => developers}/cli/language.md | 0 docs/{ => developers}/cli/openai-auth.md | 0 docs/{ => developers}/cli/qwen-ignore.md | 0 docs/{ => developers}/cli/themes.md | 0 docs/{ => developers}/cli/trusted-folders.md | 0 docs/{ => developers}/cli/tutorials.md | 0 docs/{ => developers}/core/index.md | 0 docs/{ => developers}/core/memport.md | 0 docs/{ => developers}/core/tools-api.md | 0 docs/{ => developers}/development/_meta.ts | 0 .../development/architecture.md | 0 .../development/deployment.md | 0 .../development/integration-tests.md | 0 .../development/issue-and-pr-automation.md | 0 docs/{ => developers}/development/npm.md | 0 .../{ => developers}/development/telemetry.md | 0 .../{ => developers}/examples/proxy-script.md | 0 .../extensions/extension-releasing.md | 0 docs/{ => developers}/extensions/extension.md | 0 .../extensions/getting-started-extensions.md | 0 docs/{ => developers}/mermaid/context.mmd | 0 docs/{ => developers}/mermaid/render-path.mmd | 0 docs/{ => developers}/tools/_meta.ts | 0 docs/{ => developers}/tools/file-system.md | 0 docs/{ => developers}/tools/index.md | 0 docs/{ => developers}/tools/mcp-server.md | 0 docs/{ => developers}/tools/memory.md | 0 docs/{ => developers}/tools/multi-file.md | 0 docs/{ => developers}/tools/shell.md | 0 docs/{ => developers}/tools/todo-write.md | 0 docs/{ => developers}/tools/web-fetch.md | 0 docs/{ => developers}/tools/web-search.md | 0 docs/index.md | 344 ------------------ docs/sidebar.json | 68 ---- docs/{ => users}/features/_meta.ts | 0 docs/{ => users}/features/checkpointing.md | 0 docs/{ => users}/features/headless.md | 0 docs/{ => users}/features/sandbox.md | 0 docs/{ => users}/features/subagents.md | 0 docs/{ => users}/features/token-caching.md | 0 docs/{ => users}/features/welcome-back.md | 0 docs/{ => users}/ide-integration/_meta.ts | 0 .../ide-integration/ide-companion-spec.md | 0 .../ide-integration/ide-integration.md | 0 docs/{ => users}/support/_meta.ts | 0 docs/{ => users}/support/tos-privacy.md | 0 docs/{ => users}/support/troubleshooting.md | 0 72 files changed, 412 deletions(-) rename docs/{ => developers}/assets/connected_devtools.png (100%) rename docs/{ => developers}/assets/gemini-screenshot.png (100%) rename docs/{ => developers}/assets/qwen-screenshot.png (100%) rename docs/{ => developers}/assets/release_patch.png (100%) rename docs/{ => developers}/assets/theme-ansi-light.png (100%) rename docs/{ => developers}/assets/theme-ansi.png (100%) rename docs/{ => developers}/assets/theme-atom-one.png (100%) rename docs/{ => developers}/assets/theme-ayu-light.png (100%) rename docs/{ => developers}/assets/theme-ayu.png (100%) rename docs/{ => developers}/assets/theme-custom.png (100%) rename docs/{ => developers}/assets/theme-default-light.png (100%) rename docs/{ => developers}/assets/theme-default.png (100%) rename docs/{ => developers}/assets/theme-dracula.png (100%) rename docs/{ => developers}/assets/theme-github-light.png (100%) rename docs/{ => developers}/assets/theme-github.png (100%) rename docs/{ => developers}/assets/theme-google-light.png (100%) rename docs/{ => developers}/assets/theme-xcode-light.png (100%) rename docs/{ => developers}/cli/Uninstall.md (100%) rename docs/{ => developers}/cli/_meta.ts (100%) rename docs/{ => developers}/cli/authentication.md (100%) rename docs/{ => developers}/cli/commands.md (100%) rename docs/{ => developers}/cli/configuration-v1.md (100%) rename docs/{ => developers}/cli/configuration.md (100%) rename docs/{ => developers}/cli/index.md (100%) rename docs/{ => developers}/cli/keyboard-shortcuts.md (100%) rename docs/{ => developers}/cli/language.md (100%) rename docs/{ => developers}/cli/openai-auth.md (100%) rename docs/{ => developers}/cli/qwen-ignore.md (100%) rename docs/{ => developers}/cli/themes.md (100%) rename docs/{ => developers}/cli/trusted-folders.md (100%) rename docs/{ => developers}/cli/tutorials.md (100%) rename docs/{ => developers}/core/index.md (100%) rename docs/{ => developers}/core/memport.md (100%) rename docs/{ => developers}/core/tools-api.md (100%) rename docs/{ => developers}/development/_meta.ts (100%) rename docs/{ => developers}/development/architecture.md (100%) rename docs/{ => developers}/development/deployment.md (100%) rename docs/{ => developers}/development/integration-tests.md (100%) rename docs/{ => developers}/development/issue-and-pr-automation.md (100%) rename docs/{ => developers}/development/npm.md (100%) rename docs/{ => developers}/development/telemetry.md (100%) rename docs/{ => developers}/examples/proxy-script.md (100%) rename docs/{ => developers}/extensions/extension-releasing.md (100%) rename docs/{ => developers}/extensions/extension.md (100%) rename docs/{ => developers}/extensions/getting-started-extensions.md (100%) rename docs/{ => developers}/mermaid/context.mmd (100%) rename docs/{ => developers}/mermaid/render-path.mmd (100%) rename docs/{ => developers}/tools/_meta.ts (100%) rename docs/{ => developers}/tools/file-system.md (100%) rename docs/{ => developers}/tools/index.md (100%) rename docs/{ => developers}/tools/mcp-server.md (100%) rename docs/{ => developers}/tools/memory.md (100%) rename docs/{ => developers}/tools/multi-file.md (100%) rename docs/{ => developers}/tools/shell.md (100%) rename docs/{ => developers}/tools/todo-write.md (100%) rename docs/{ => developers}/tools/web-fetch.md (100%) rename docs/{ => developers}/tools/web-search.md (100%) delete mode 100644 docs/index.md delete mode 100644 docs/sidebar.json rename docs/{ => users}/features/_meta.ts (100%) rename docs/{ => users}/features/checkpointing.md (100%) rename docs/{ => users}/features/headless.md (100%) rename docs/{ => users}/features/sandbox.md (100%) rename docs/{ => users}/features/subagents.md (100%) rename docs/{ => users}/features/token-caching.md (100%) rename docs/{ => users}/features/welcome-back.md (100%) rename docs/{ => users}/ide-integration/_meta.ts (100%) rename docs/{ => users}/ide-integration/ide-companion-spec.md (100%) rename docs/{ => users}/ide-integration/ide-integration.md (100%) rename docs/{ => users}/support/_meta.ts (100%) rename docs/{ => users}/support/tos-privacy.md (100%) rename docs/{ => users}/support/troubleshooting.md (100%) diff --git a/docs/assets/connected_devtools.png b/docs/developers/assets/connected_devtools.png similarity index 100% rename from docs/assets/connected_devtools.png rename to docs/developers/assets/connected_devtools.png diff --git a/docs/assets/gemini-screenshot.png b/docs/developers/assets/gemini-screenshot.png similarity index 100% rename from docs/assets/gemini-screenshot.png rename to docs/developers/assets/gemini-screenshot.png diff --git a/docs/assets/qwen-screenshot.png b/docs/developers/assets/qwen-screenshot.png similarity index 100% rename from docs/assets/qwen-screenshot.png rename to docs/developers/assets/qwen-screenshot.png diff --git a/docs/assets/release_patch.png b/docs/developers/assets/release_patch.png similarity index 100% rename from docs/assets/release_patch.png rename to docs/developers/assets/release_patch.png diff --git a/docs/assets/theme-ansi-light.png b/docs/developers/assets/theme-ansi-light.png similarity index 100% rename from docs/assets/theme-ansi-light.png rename to docs/developers/assets/theme-ansi-light.png diff --git a/docs/assets/theme-ansi.png b/docs/developers/assets/theme-ansi.png similarity index 100% rename from docs/assets/theme-ansi.png rename to docs/developers/assets/theme-ansi.png diff --git a/docs/assets/theme-atom-one.png b/docs/developers/assets/theme-atom-one.png similarity index 100% rename from docs/assets/theme-atom-one.png rename to docs/developers/assets/theme-atom-one.png diff --git a/docs/assets/theme-ayu-light.png b/docs/developers/assets/theme-ayu-light.png similarity index 100% rename from docs/assets/theme-ayu-light.png rename to docs/developers/assets/theme-ayu-light.png diff --git a/docs/assets/theme-ayu.png b/docs/developers/assets/theme-ayu.png similarity index 100% rename from docs/assets/theme-ayu.png rename to docs/developers/assets/theme-ayu.png diff --git a/docs/assets/theme-custom.png b/docs/developers/assets/theme-custom.png similarity index 100% rename from docs/assets/theme-custom.png rename to docs/developers/assets/theme-custom.png diff --git a/docs/assets/theme-default-light.png b/docs/developers/assets/theme-default-light.png similarity index 100% rename from docs/assets/theme-default-light.png rename to docs/developers/assets/theme-default-light.png diff --git a/docs/assets/theme-default.png b/docs/developers/assets/theme-default.png similarity index 100% rename from docs/assets/theme-default.png rename to docs/developers/assets/theme-default.png diff --git a/docs/assets/theme-dracula.png b/docs/developers/assets/theme-dracula.png similarity index 100% rename from docs/assets/theme-dracula.png rename to docs/developers/assets/theme-dracula.png diff --git a/docs/assets/theme-github-light.png b/docs/developers/assets/theme-github-light.png similarity index 100% rename from docs/assets/theme-github-light.png rename to docs/developers/assets/theme-github-light.png diff --git a/docs/assets/theme-github.png b/docs/developers/assets/theme-github.png similarity index 100% rename from docs/assets/theme-github.png rename to docs/developers/assets/theme-github.png diff --git a/docs/assets/theme-google-light.png b/docs/developers/assets/theme-google-light.png similarity index 100% rename from docs/assets/theme-google-light.png rename to docs/developers/assets/theme-google-light.png diff --git a/docs/assets/theme-xcode-light.png b/docs/developers/assets/theme-xcode-light.png similarity index 100% rename from docs/assets/theme-xcode-light.png rename to docs/developers/assets/theme-xcode-light.png diff --git a/docs/cli/Uninstall.md b/docs/developers/cli/Uninstall.md similarity index 100% rename from docs/cli/Uninstall.md rename to docs/developers/cli/Uninstall.md diff --git a/docs/cli/_meta.ts b/docs/developers/cli/_meta.ts similarity index 100% rename from docs/cli/_meta.ts rename to docs/developers/cli/_meta.ts diff --git a/docs/cli/authentication.md b/docs/developers/cli/authentication.md similarity index 100% rename from docs/cli/authentication.md rename to docs/developers/cli/authentication.md diff --git a/docs/cli/commands.md b/docs/developers/cli/commands.md similarity index 100% rename from docs/cli/commands.md rename to docs/developers/cli/commands.md diff --git a/docs/cli/configuration-v1.md b/docs/developers/cli/configuration-v1.md similarity index 100% rename from docs/cli/configuration-v1.md rename to docs/developers/cli/configuration-v1.md diff --git a/docs/cli/configuration.md b/docs/developers/cli/configuration.md similarity index 100% rename from docs/cli/configuration.md rename to docs/developers/cli/configuration.md diff --git a/docs/cli/index.md b/docs/developers/cli/index.md similarity index 100% rename from docs/cli/index.md rename to docs/developers/cli/index.md diff --git a/docs/cli/keyboard-shortcuts.md b/docs/developers/cli/keyboard-shortcuts.md similarity index 100% rename from docs/cli/keyboard-shortcuts.md rename to docs/developers/cli/keyboard-shortcuts.md diff --git a/docs/cli/language.md b/docs/developers/cli/language.md similarity index 100% rename from docs/cli/language.md rename to docs/developers/cli/language.md diff --git a/docs/cli/openai-auth.md b/docs/developers/cli/openai-auth.md similarity index 100% rename from docs/cli/openai-auth.md rename to docs/developers/cli/openai-auth.md diff --git a/docs/cli/qwen-ignore.md b/docs/developers/cli/qwen-ignore.md similarity index 100% rename from docs/cli/qwen-ignore.md rename to docs/developers/cli/qwen-ignore.md diff --git a/docs/cli/themes.md b/docs/developers/cli/themes.md similarity index 100% rename from docs/cli/themes.md rename to docs/developers/cli/themes.md diff --git a/docs/cli/trusted-folders.md b/docs/developers/cli/trusted-folders.md similarity index 100% rename from docs/cli/trusted-folders.md rename to docs/developers/cli/trusted-folders.md diff --git a/docs/cli/tutorials.md b/docs/developers/cli/tutorials.md similarity index 100% rename from docs/cli/tutorials.md rename to docs/developers/cli/tutorials.md diff --git a/docs/core/index.md b/docs/developers/core/index.md similarity index 100% rename from docs/core/index.md rename to docs/developers/core/index.md diff --git a/docs/core/memport.md b/docs/developers/core/memport.md similarity index 100% rename from docs/core/memport.md rename to docs/developers/core/memport.md diff --git a/docs/core/tools-api.md b/docs/developers/core/tools-api.md similarity index 100% rename from docs/core/tools-api.md rename to docs/developers/core/tools-api.md diff --git a/docs/development/_meta.ts b/docs/developers/development/_meta.ts similarity index 100% rename from docs/development/_meta.ts rename to docs/developers/development/_meta.ts diff --git a/docs/development/architecture.md b/docs/developers/development/architecture.md similarity index 100% rename from docs/development/architecture.md rename to docs/developers/development/architecture.md diff --git a/docs/development/deployment.md b/docs/developers/development/deployment.md similarity index 100% rename from docs/development/deployment.md rename to docs/developers/development/deployment.md diff --git a/docs/development/integration-tests.md b/docs/developers/development/integration-tests.md similarity index 100% rename from docs/development/integration-tests.md rename to docs/developers/development/integration-tests.md diff --git a/docs/development/issue-and-pr-automation.md b/docs/developers/development/issue-and-pr-automation.md similarity index 100% rename from docs/development/issue-and-pr-automation.md rename to docs/developers/development/issue-and-pr-automation.md diff --git a/docs/development/npm.md b/docs/developers/development/npm.md similarity index 100% rename from docs/development/npm.md rename to docs/developers/development/npm.md diff --git a/docs/development/telemetry.md b/docs/developers/development/telemetry.md similarity index 100% rename from docs/development/telemetry.md rename to docs/developers/development/telemetry.md diff --git a/docs/examples/proxy-script.md b/docs/developers/examples/proxy-script.md similarity index 100% rename from docs/examples/proxy-script.md rename to docs/developers/examples/proxy-script.md diff --git a/docs/extensions/extension-releasing.md b/docs/developers/extensions/extension-releasing.md similarity index 100% rename from docs/extensions/extension-releasing.md rename to docs/developers/extensions/extension-releasing.md diff --git a/docs/extensions/extension.md b/docs/developers/extensions/extension.md similarity index 100% rename from docs/extensions/extension.md rename to docs/developers/extensions/extension.md diff --git a/docs/extensions/getting-started-extensions.md b/docs/developers/extensions/getting-started-extensions.md similarity index 100% rename from docs/extensions/getting-started-extensions.md rename to docs/developers/extensions/getting-started-extensions.md diff --git a/docs/mermaid/context.mmd b/docs/developers/mermaid/context.mmd similarity index 100% rename from docs/mermaid/context.mmd rename to docs/developers/mermaid/context.mmd diff --git a/docs/mermaid/render-path.mmd b/docs/developers/mermaid/render-path.mmd similarity index 100% rename from docs/mermaid/render-path.mmd rename to docs/developers/mermaid/render-path.mmd diff --git a/docs/tools/_meta.ts b/docs/developers/tools/_meta.ts similarity index 100% rename from docs/tools/_meta.ts rename to docs/developers/tools/_meta.ts diff --git a/docs/tools/file-system.md b/docs/developers/tools/file-system.md similarity index 100% rename from docs/tools/file-system.md rename to docs/developers/tools/file-system.md diff --git a/docs/tools/index.md b/docs/developers/tools/index.md similarity index 100% rename from docs/tools/index.md rename to docs/developers/tools/index.md diff --git a/docs/tools/mcp-server.md b/docs/developers/tools/mcp-server.md similarity index 100% rename from docs/tools/mcp-server.md rename to docs/developers/tools/mcp-server.md diff --git a/docs/tools/memory.md b/docs/developers/tools/memory.md similarity index 100% rename from docs/tools/memory.md rename to docs/developers/tools/memory.md diff --git a/docs/tools/multi-file.md b/docs/developers/tools/multi-file.md similarity index 100% rename from docs/tools/multi-file.md rename to docs/developers/tools/multi-file.md diff --git a/docs/tools/shell.md b/docs/developers/tools/shell.md similarity index 100% rename from docs/tools/shell.md rename to docs/developers/tools/shell.md diff --git a/docs/tools/todo-write.md b/docs/developers/tools/todo-write.md similarity index 100% rename from docs/tools/todo-write.md rename to docs/developers/tools/todo-write.md diff --git a/docs/tools/web-fetch.md b/docs/developers/tools/web-fetch.md similarity index 100% rename from docs/tools/web-fetch.md rename to docs/developers/tools/web-fetch.md diff --git a/docs/tools/web-search.md b/docs/developers/tools/web-search.md similarity index 100% rename from docs/tools/web-search.md rename to docs/developers/tools/web-search.md diff --git a/docs/index.md b/docs/index.md deleted file mode 100644 index 07fc1db6..00000000 --- a/docs/index.md +++ /dev/null @@ -1,344 +0,0 @@ -# Welcome to Qwen Code documentation - -Qwen Code is a powerful command-line AI workflow tool adapted from [**Gemini CLI**](https://github.com/google-gemini/gemini-cli) ([details](./README.gemini.md)), specifically optimized for [Qwen3-Coder](https://github.com/QwenLM/Qwen3-Coder) models. It enhances your development workflow with advanced code understanding, automated tasks, and intelligent assistance. - -## ๐Ÿš€ Why Choose Qwen Code? - -- ๐ŸŽฏ **Free Tier:** Up to 60 requests/min and 2,000 requests/day with your [QwenChat](https://chat.qwen.ai/) account. -- ๐Ÿง  **Advanced Model:** Specially optimized for [Qwen3-Coder](https://github.com/QwenLM/Qwen3-Coder) for superior code understanding and assistance. -- ๐Ÿ† **Comprehensive Features:** Includes subagents, Plan Mode, TodoWrite, vision model support, and full OpenAI API compatibilityโ€”all seamlessly integrated. -- ๐Ÿ”ง **Built-in & Extensible Tools:** Includes file system operations, shell command execution, web fetch/search, and moreโ€”all easily extended via the Model Context Protocol (MCP) for custom integrations. -- ๐Ÿ’ป **Developer-Centric:** Built for terminal-first workflowsโ€”perfect for command-line enthusiasts. -- ๐Ÿ›ก๏ธ **Open Source:** Apache 2.0 licensed for maximum freedom and transparency. - -## Installation - -### Prerequisites - -Ensure you have [Node.js version 20](https://nodejs.org/en/download) or higher installed. - -```bash -curl -qL https://www.npmjs.com/install.sh | sh -``` - -### Install from npm - -```bash -npm install -g @qwen-code/qwen-code@latest -qwen --version -``` - -### Install from source - -```bash -git clone https://github.com/QwenLM/qwen-code.git -cd qwen-code -npm install -npm install -g . -``` - -### Install globally with Homebrew (macOS/Linux) - -```bash -brew install qwen-code -``` - -## Quick Start - -```bash -# Start Qwen Code -qwen - -# Example commands -> Explain this codebase structure -> Help me refactor this function -> Generate unit tests for this module -``` - -### Session Management - -Control your token usage with configurable session limits to optimize costs and performance. - -#### Configure Session Token Limit - -Create or edit `.qwen/settings.json` in your home directory: - -```json -{ - "sessionTokenLimit": 32000 -} -``` - -#### Session Commands - -- **`/compress`** - Compress conversation history to continue within token limits -- **`/clear`** (aliases: `/reset`, `/new`) - Clear conversation history, start a fresh session, and free up context -- **`/stats`** - Check current token usage and limits - -> ๐Ÿ“ **Note**: Session token limit applies to a single conversation, not cumulative API calls. - -### Vision Model Configuration - -Qwen Code includes intelligent vision model auto-switching that detects images in your input and can automatically switch to vision-capable models for multimodal analysis. **This feature is enabled by default** - when you include images in your queries, you'll see a dialog asking how you'd like to handle the vision model switch. - -#### Skip the Switch Dialog (Optional) - -If you don't want to see the interactive dialog each time, configure the default behavior in your `.qwen/settings.json`: - -```json -{ - "experimental": { - "vlmSwitchMode": "once" - } -} -``` - -**Available modes:** - -- **`"once"`** - Switch to vision model for this query only, then revert -- **`"session"`** - Switch to vision model for the entire session -- **`"persist"`** - Continue with current model (no switching) -- **Not set** - Show interactive dialog each time (default) - -#### Command Line Override - -You can also set the behavior via command line: - -```bash -# Switch once per query -qwen --vlm-switch-mode once - -# Switch for entire session -qwen --vlm-switch-mode session - -# Never switch automatically -qwen --vlm-switch-mode persist -``` - -#### Disable Vision Models (Optional) - -To completely disable vision model support, add to your `.qwen/settings.json`: - -```json -{ - "experimental": { - "visionModelPreview": false - } -} -``` - -> ๐Ÿ’ก **Tip**: In YOLO mode (`--yolo`), vision switching happens automatically without prompts when images are detected. - -### Authorization - -Choose your preferred authentication method based on your needs: - -#### 1. Qwen OAuth (๐Ÿš€ Recommended - Start in 30 seconds) - -The easiest way to get started - completely free with generous quotas: - -```bash -# Just run this command and follow the browser authentication -qwen -``` - -**What happens:** - -1. **Instant Setup**: CLI opens your browser automatically -2. **One-Click Login**: Authenticate with your qwen.ai account -3. **Automatic Management**: Credentials cached locally for future use -4. **No Configuration**: Zero setup required - just start coding! - -**Free Tier Benefits:** - -- โœ… **2,000 requests/day** (no token counting needed) -- โœ… **60 requests/minute** rate limit -- โœ… **Automatic credential refresh** -- โœ… **Zero cost** for individual users -- โ„น๏ธ **Note**: Model fallback may occur to maintain service quality - -#### 2. OpenAI-Compatible API - -Use API keys for OpenAI or other compatible providers: - -**Configuration Methods:** - -1. **Environment Variables** - - ```bash - export OPENAI_API_KEY="your_api_key_here" - export OPENAI_BASE_URL="your_api_endpoint" - export OPENAI_MODEL="your_model_choice" - ``` - -2. **Project `.env` File** - Create a `.env` file in your project root: - ```env - OPENAI_API_KEY=your_api_key_here - OPENAI_BASE_URL=your_api_endpoint - OPENAI_MODEL=your_model_choice - ``` - -**API Provider Options** - -> โš ๏ธ **Regional Notice:** -> -> - **Mainland China**: Use Alibaba Cloud Bailian or ModelScope -> - **International**: Use Alibaba Cloud ModelStudio or OpenRouter - -
-๐Ÿ‡จ๐Ÿ‡ณ For Users in Mainland China - -**Option 1: Alibaba Cloud Bailian** ([Apply for API Key](https://bailian.console.aliyun.com/)) - -```bash -export OPENAI_API_KEY="your_api_key_here" -export OPENAI_BASE_URL="https://dashscope.aliyuncs.com/compatible-mode/v1" -export OPENAI_MODEL="qwen3-coder-plus" -``` - -**Option 2: ModelScope (Free Tier)** ([Apply for API Key](https://modelscope.cn/docs/model-service/API-Inference/intro)) - -- โœ… **2,000 free API calls per day** -- โš ๏ธ Connect your Aliyun account to avoid authentication errors - -```bash -export OPENAI_API_KEY="your_api_key_here" -export OPENAI_BASE_URL="https://api-inference.modelscope.cn/v1" -export OPENAI_MODEL="Qwen/Qwen3-Coder-480B-A35B-Instruct" -``` - -
- -
-๐ŸŒ For International Users - -**Option 1: Alibaba Cloud ModelStudio** ([Apply for API Key](https://modelstudio.console.alibabacloud.com/)) - -```bash -export OPENAI_API_KEY="your_api_key_here" -export OPENAI_BASE_URL="https://dashscope-intl.aliyuncs.com/compatible-mode/v1" -export OPENAI_MODEL="qwen3-coder-plus" -``` - -**Option 2: OpenRouter (Free Tier Available)** ([Apply for API Key](https://openrouter.ai/)) - -```bash -export OPENAI_API_KEY="your_api_key_here" -export OPENAI_BASE_URL="https://openrouter.ai/api/v1" -export OPENAI_MODEL="qwen/qwen3-coder:free" -``` - -
- -## Usage Examples - -### ๐Ÿ” Explore Codebases - -```bash -cd your-project/ -qwen - -# Architecture analysis -> Describe the main pieces of this system's architecture -> What are the key dependencies and how do they interact? -> Find all API endpoints and their authentication methods -``` - -### ๐Ÿ’ป Code Development - -```bash -# Refactoring -> Refactor this function to improve readability and performance -> Convert this class to use dependency injection -> Split this large module into smaller, focused components - -# Code generation -> Create a REST API endpoint for user management -> Generate unit tests for the authentication module -> Add error handling to all database operations -``` - -### ๐Ÿ”„ Automate Workflows - -```bash -# Git automation -> Analyze git commits from the last 7 days, grouped by feature -> Create a changelog from recent commits -> Find all TODO comments and create GitHub issues - -# File operations -> Convert all images in this directory to PNG format -> Rename all test files to follow the *.test.ts pattern -> Find and remove all console.log statements -``` - -### ๐Ÿ› Debugging & Analysis - -```bash -# Performance analysis -> Identify performance bottlenecks in this React component -> Find all N+1 query problems in the codebase - -# Security audit -> Check for potential SQL injection vulnerabilities -> Find all hardcoded credentials or API keys -``` - -## Popular Tasks - -### ๐Ÿ“š Understand New Codebases - -```text -> What are the core business logic components? -> What security mechanisms are in place? -> How does the data flow through the system? -> What are the main design patterns used? -> Generate a dependency graph for this module -``` - -### ๐Ÿ”จ Code Refactoring & Optimization - -```text -> What parts of this module can be optimized? -> Help me refactor this class to follow SOLID principles -> Add proper error handling and logging -> Convert callbacks to async/await pattern -> Implement caching for expensive operations -``` - -### ๐Ÿ“ Documentation & Testing - -```text -> Generate comprehensive JSDoc comments for all public APIs -> Write unit tests with edge cases for this component -> Create API documentation in OpenAPI format -> Add inline comments explaining complex algorithms -> Generate a README for this module -``` - -### ๐Ÿš€ Development Acceleration - -```text -> Set up a new Express server with authentication -> Create a React component with TypeScript and tests -> Implement a rate limiter middleware -> Add database migrations for new schema -> Configure CI/CD pipeline for this project -``` - -## Commands & Shortcuts - -### Session Commands - -- `/help` - Display available commands -- `/clear` (aliases: `/reset`, `/new`) - Clear conversation history and start a fresh session -- `/compress` - Compress history to save tokens -- `/stats` - Show current session information -- `/exit` or `/quit` - Exit Qwen Code - -### Keyboard Shortcuts - -- `Ctrl+C` - Cancel current operation -- `Ctrl+D` - Exit (on empty line) -- `Up/Down` - Navigate command history diff --git a/docs/sidebar.json b/docs/sidebar.json deleted file mode 100644 index b4a75052..00000000 --- a/docs/sidebar.json +++ /dev/null @@ -1,68 +0,0 @@ -[ - { - "label": "Overview", - "items": [ - { "label": "Welcome", "slug": "docs" }, - { "label": "Execution and Deployment", "slug": "docs/deployment" }, - { "label": "Architecture Overview", "slug": "docs/architecture" } - ] - }, - { - "label": "CLI", - "items": [ - { "label": "Introduction", "slug": "docs/cli" }, - { "label": "Authentication", "slug": "docs/cli/authentication" }, - { "label": "Commands", "slug": "docs/cli/commands" }, - { "label": "Configuration", "slug": "docs/cli/configuration" }, - { "label": "Checkpointing", "slug": "docs/checkpointing" }, - { "label": "Extensions", "slug": "docs/extension" }, - { "label": "Headless Mode", "slug": "docs/headless" }, - { "label": "IDE Integration", "slug": "docs/ide-integration" }, - { - "label": "IDE Companion Spec", - "slug": "docs/ide-companion-spec" - }, - { "label": "Telemetry", "slug": "docs/telemetry" }, - { "label": "Themes", "slug": "docs/cli/themes" }, - { "label": "Token Caching", "slug": "docs/cli/token-caching" }, - { "label": "Trusted Folders", "slug": "docs/trusted-folders" }, - { "label": "Tutorials", "slug": "docs/cli/tutorials" } - ] - }, - { - "label": "Core", - "items": [ - { "label": "Introduction", "slug": "docs/core" }, - { "label": "Tools API", "slug": "docs/core/tools-api" }, - { "label": "Memory Import Processor", "slug": "docs/core/memport" } - ] - }, - { - "label": "Tools", - "items": [ - { "label": "Overview", "slug": "docs/tools" }, - { "label": "File System", "slug": "docs/tools/file-system" }, - { "label": "Multi-File Read", "slug": "docs/tools/multi-file" }, - { "label": "Shell", "slug": "docs/tools/shell" }, - { "label": "Web Fetch", "slug": "docs/tools/web-fetch" }, - { "label": "Web Search", "slug": "docs/tools/web-search" }, - { "label": "Memory", "slug": "docs/tools/memory" }, - { "label": "MCP Servers", "slug": "docs/tools/mcp-server" }, - { "label": "Sandboxing", "slug": "docs/sandbox" } - ] - }, - { - "label": "Development", - "items": [ - { "label": "NPM", "slug": "docs/npm" }, - { "label": "Releases", "slug": "docs/releases" } - ] - }, - { - "label": "Support", - "items": [ - { "label": "Troubleshooting", "slug": "docs/troubleshooting" }, - { "label": "Terms of Service", "slug": "docs/tos-privacy" } - ] - } -] diff --git a/docs/features/_meta.ts b/docs/users/features/_meta.ts similarity index 100% rename from docs/features/_meta.ts rename to docs/users/features/_meta.ts diff --git a/docs/features/checkpointing.md b/docs/users/features/checkpointing.md similarity index 100% rename from docs/features/checkpointing.md rename to docs/users/features/checkpointing.md diff --git a/docs/features/headless.md b/docs/users/features/headless.md similarity index 100% rename from docs/features/headless.md rename to docs/users/features/headless.md diff --git a/docs/features/sandbox.md b/docs/users/features/sandbox.md similarity index 100% rename from docs/features/sandbox.md rename to docs/users/features/sandbox.md diff --git a/docs/features/subagents.md b/docs/users/features/subagents.md similarity index 100% rename from docs/features/subagents.md rename to docs/users/features/subagents.md diff --git a/docs/features/token-caching.md b/docs/users/features/token-caching.md similarity index 100% rename from docs/features/token-caching.md rename to docs/users/features/token-caching.md diff --git a/docs/features/welcome-back.md b/docs/users/features/welcome-back.md similarity index 100% rename from docs/features/welcome-back.md rename to docs/users/features/welcome-back.md diff --git a/docs/ide-integration/_meta.ts b/docs/users/ide-integration/_meta.ts similarity index 100% rename from docs/ide-integration/_meta.ts rename to docs/users/ide-integration/_meta.ts diff --git a/docs/ide-integration/ide-companion-spec.md b/docs/users/ide-integration/ide-companion-spec.md similarity index 100% rename from docs/ide-integration/ide-companion-spec.md rename to docs/users/ide-integration/ide-companion-spec.md diff --git a/docs/ide-integration/ide-integration.md b/docs/users/ide-integration/ide-integration.md similarity index 100% rename from docs/ide-integration/ide-integration.md rename to docs/users/ide-integration/ide-integration.md diff --git a/docs/support/_meta.ts b/docs/users/support/_meta.ts similarity index 100% rename from docs/support/_meta.ts rename to docs/users/support/_meta.ts diff --git a/docs/support/tos-privacy.md b/docs/users/support/tos-privacy.md similarity index 100% rename from docs/support/tos-privacy.md rename to docs/users/support/tos-privacy.md diff --git a/docs/support/troubleshooting.md b/docs/users/support/troubleshooting.md similarity index 100% rename from docs/support/troubleshooting.md rename to docs/users/support/troubleshooting.md