mirror of
https://github.com/QwenLM/qwen-code.git
synced 2026-07-09 17:19:02 +00:00
70d6e5f93e
* docs: revamp README for clarity and focus - Rewrite tagline and value propositions to be more concise - Restructure sections: Installation → Quick Start → Usage Modes → Capabilities → Ecosystem → Contributing → Acknowledgments - Add GitHub alert (TIP) highlighting self-evolving AI workflow and #2 contributor status - Add Capabilities comparison table with Claude Code - Add Contributing section linking to CONTRIBUTING.md - Update Acknowledgments: clarify fork origin (Gemini CLI v0.8) and independent development since Qwen Code v0.1 - Replace hero image, remove demo video and example prompts - Compact Installation section, remove verbose Authentication and Configuration sections - Rebrand Claw section as ecosystem list item linking to openclaw/acpx * docs: address review comments on README revamp - Add auth docs links after Quick Start (missing after removing ~300 lines) - Simplify SDK row in comparison table (Claude Code has no Java SDK) - Fix /debug → /bugfix in comparison table (/debug is not a valid command) - Mark Daemon mode as (experimental) per serve.ts source - Fix Gemini CLI version v0.8 → v0.8.2 (verified via PR #838) - Soften TIP: remove unverifiable '#2 contributor' and 'approve merges' claims - Retain parity link: wenshao is a Qwen Code maintainer
157 lines
9.3 KiB
Markdown
157 lines
9.3 KiB
Markdown
<div align="center">
|
|
|
|
[](https://www.npmjs.com/package/@qwen-code/qwen-code)
|
|
[](./LICENSE)
|
|
[](https://nodejs.org/)
|
|
[](https://www.npmjs.com/package/@qwen-code/qwen-code)
|
|
|
|
<a href="https://trendshift.io/repositories/15287" target="_blank"><img src="https://trendshift.io/api/badge/repositories/15287" alt="QwenLM%2Fqwen-code | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
|
|
|
|
**The open-source AI coding agent that lives in your terminal.**
|
|
|
|
<a href="https://qwenlm.github.io/qwen-code-docs/zh/users/overview">中文</a> |
|
|
<a href="https://qwenlm.github.io/qwen-code-docs/de/users/overview">Deutsch</a> |
|
|
<a href="https://qwenlm.github.io/qwen-code-docs/fr/users/overview">français</a> |
|
|
<a href="https://qwenlm.github.io/qwen-code-docs/ja/users/overview">日本語</a> |
|
|
<a href="https://qwenlm.github.io/qwen-code-docs/ru/users/overview">Русский</a> |
|
|
<a href="https://qwenlm.github.io/qwen-code-docs/pt-BR/users/overview">Português (Brasil)</a>
|
|
|
|
</div>
|
|
|
|
## Why Qwen Code?
|
|
|
|
- **Agentic out of the box** — Auto-Memory, Auto-Skills, SubAgents, Agent Teams, and MCP. Dynamic workflows, zero setup.
|
|
- **Open-source, inside and out** — The framework and the Qwen models are open-source. They evolve together. No vendor lock-in.
|
|
- **Multi-protocol** — Supports OpenAI, Anthropic, Gemini, and Qwen APIs. Any third-party provider or local model (Ollama / vLLM). Switch at runtime.
|
|
- **Beyond the terminal** — IDE plugins, Desktop app, daemon mode, SDKs, and IM bots (Telegram / DingTalk / WeChat / Feishu).
|
|
|
|
> [!TIP]
|
|
> Qwen Code is actively iterating on itself — using its own agent and models to file issues, submit PRs, review code, and run tests. Powered by the community, driven by AI.
|
|
|
|
## Installation
|
|
|
|
**Linux / macOS:**
|
|
|
|
```bash
|
|
curl -fsSL https://qwen-code-assets.oss-cn-hangzhou.aliyuncs.com/installation/install-qwen-standalone.sh | bash
|
|
```
|
|
|
|
**Windows:**
|
|
|
|
```powershell
|
|
irm https://qwen-code-assets.oss-cn-hangzhou.aliyuncs.com/installation/install-qwen-standalone.ps1 | iex
|
|
```
|
|
|
|
> Restart your terminal after installation to ensure environment variables take effect.
|
|
|
|
<details>
|
|
<summary>NPM / Homebrew</summary>
|
|
|
|
**NPM** (requires [Node.js 22+](https://nodejs.org/)):
|
|
|
|
```bash
|
|
npm install -g @qwen-code/qwen-code@latest
|
|
```
|
|
|
|
**Homebrew** (macOS / Linux):
|
|
|
|
```bash
|
|
brew install qwen-code
|
|
```
|
|
|
|
</details>
|
|
|
|
## Quick Start
|
|
|
|
```bash
|
|
qwen # Launch interactive terminal UI
|
|
# Inside the session:
|
|
/auth # Configure your provider and API key
|
|
```
|
|
|
|
See the [Authentication Guide](https://qwenlm.github.io/qwen-code-docs/en/users/configuration/auth/) and [Settings Reference](https://qwenlm.github.io/qwen-code-docs/en/users/configuration/settings/) for detailed setup.
|
|
|
|
|
|
|
|
## How to Use Qwen Code
|
|
|
|
| Mode | Command | Use Case |
|
|
| --------------- | --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| **Interactive** | `qwen` | Terminal UI with rich rendering, `@file` references, slash commands |
|
|
| **Headless** | `qwen -p "..."` | Scripts, CI/CD, batch processing — no UI |
|
|
| **IDE** | — | [VS Code](https://qwenlm.github.io/qwen-code-docs/en/users/integration-vscode/), [Zed](https://qwenlm.github.io/qwen-code-docs/en/users/integration-zed/), [JetBrains](https://qwenlm.github.io/qwen-code-docs/en/users/integration-jetbrains/) |
|
|
| **Desktop** | — | [Qwen Code Desktop](https://github.com/QwenLM/qwen-code/releases/tag/desktop-latest) — GUI for macOS, Windows, Linux |
|
|
| **Daemon** | `qwen serve` | Shared agent session over HTTP+SSE (ACP). Multiple clients, one agent. _(experimental)_ [Docs](https://qwenlm.github.io/qwen-code-docs/en/users/qwen-serve) |
|
|
| **SDK** | — | [TypeScript](./packages/sdk-typescript/README.md), [Python](./packages/sdk-python/README.md), [Java](./packages/sdk-java/qwencode/README.md) |
|
|
| **IM Bot** | `qwen channel` | Connect to Telegram, DingTalk, WeChat, or Feishu |
|
|
|
|
<details>
|
|
<summary>SDK example (Python)</summary>
|
|
|
|
```python
|
|
import asyncio
|
|
|
|
from qwen_code_sdk import is_sdk_result_message, query
|
|
|
|
|
|
async def main() -> None:
|
|
result = query(
|
|
"Summarize the repository layout.",
|
|
{
|
|
"cwd": "/path/to/project",
|
|
"path_to_qwen_executable": "qwen",
|
|
},
|
|
)
|
|
|
|
async for message in result:
|
|
if is_sdk_result_message(message):
|
|
print(message["result"])
|
|
|
|
|
|
asyncio.run(main())
|
|
```
|
|
|
|
</details>
|
|
|
|
## Capabilities
|
|
|
|
If you know Claude Code, you already know Qwen Code — and then some. We've put significant effort into [bringing Qwen Code to feature parity with Claude Code](https://github.com/wenshao/codeagents/blob/main/docs/comparison/qwen-code-improvement-report.md), improving both breadth and reliability across the board.
|
|
|
|
| Feature | Qwen Code | Claude Code |
|
|
| ------------------------------------------------------------------ | :-------: | :---------: |
|
|
| SubAgents, Agent Teams, Dynamic Workflows | ✓ | ✓ |
|
|
| Auto-Memory, Auto-Skills, Hooks | ✓ | ✓ |
|
|
| Built-in Skills (/review, /batch, /loop, /bugfix…) | ✓ | ✓ |
|
|
| MCP, Plan Mode, LSP Integration | ✓ | ✓ |
|
|
| Auto Mode, Sandbox, Git Worktrees | ✓ | ✓ |
|
|
| Computer Use (desktop automation) | ✓ | ✓ |
|
|
| IDE Plugins (VS Code / JetBrains / Zed) | ✓ | ✓ |
|
|
| SDK | ✓ | ✓ |
|
|
| Headless Mode, Session Management | ✓ | ✓ |
|
|
| Open-source — model and framework | ✓ | — |
|
|
| Multi-protocol (OpenAI / Anthropic / Gemini / Qwen + any provider) | ✓ | — |
|
|
| Agent Arena (multi-model head-to-head on same task) | ✓ | — |
|
|
| Daemon Mode — `qwen serve` (multi-client shared agent) | ✓ | — |
|
|
| IM Channels (Telegram / DingTalk / WeChat / Feishu) | ✓ | — |
|
|
|
|
## Ecosystem
|
|
|
|
- [**Qwen Code Desktop**](https://github.com/QwenLM/qwen-code/releases/tag/desktop-latest) — Official desktop app for macOS, Windows, and Linux
|
|
- [**AionUi**](https://github.com/iOfficeAI/AionUi) — A modern GUI for command-line AI tools including Qwen Code
|
|
- [**Gemini CLI Desktop**](https://github.com/Piebald-AI/gemini-cli-desktop) — A cross-platform desktop/web/mobile UI for Qwen Code
|
|
|
|
- [**🦞 Qwen Code Claw**](https://github.com/openclaw/acpx) — Let other agents (Claude, Codex, etc.) delegate coding tasks to Qwen Code via ACP. Paste this prompt into your agent:
|
|
|
|
```text
|
|
Use Qwen Code as a coding agent. First, fetch and read this skill reference:
|
|
https://raw.githubusercontent.com/QwenLM/qwen-code/refs/heads/main/.qwen/skills/qwen-code-claw/SKILL.md
|
|
Then follow the instructions inside to install, authenticate, and use Qwen Code via acpx for all coding tasks.
|
|
```
|
|
|
|
## Contributing
|
|
|
|
Contributions are welcome! See [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines.
|
|
|
|
## Acknowledgments
|
|
|
|
This project was originally based on [Google Gemini CLI](https://github.com/google-gemini/gemini-cli) v0.8.2. We gratefully acknowledge the Gemini CLI team's excellent work. Starting from Qwen Code v0.1, we stopped syncing with upstream and began independent development as a multi-protocol, multi-platform agent framework with deep integrations for Qwen models and beyond.
|