diff --git a/README.md b/README.md index 1eee11b43..099d55504 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ Qwen Code is an open-source AI agent for the terminal, optimized for [Qwen3-Code - **OpenAI-compatible, OAuth free tier**: use an OpenAI-compatible API, or sign in with Qwen OAuth to get 2,000 free requests/day. - **Open-source, co-evolving**: both the framework and the Qwen3-Coder model are open-source—and they ship and evolve together. - **Agentic workflow, feature-rich**: rich built-in tools (Skills, SubAgents, Plan Mode) for a full agentic workflow and a Claude Code-like experience. -- **Terminal-first, IDE-friendly**: built for developers who live in the command line, with optional integration for VS Code and Zed. +- **Terminal-first, IDE-friendly**: built for developers who live in the command line, with optional integration for VS Code, Zed, and JetBrains IDEs. ## Installation @@ -137,10 +137,11 @@ Use `-p` to run Qwen Code without the interactive UI—ideal for scripts, automa #### IDE integration -Use Qwen Code inside your editor (VS Code and Zed): +Use Qwen Code inside your editor (VS Code, Zed, and JetBrains IDEs): - [Use in VS Code](https://qwenlm.github.io/qwen-code-docs/en/users/integration-vscode/) - [Use in Zed](https://qwenlm.github.io/qwen-code-docs/en/users/integration-zed/) +- [Use in JetBrains IDEs](https://qwenlm.github.io/qwen-code-docs/en/users/integration-jetbrains/) #### TypeScript SDK diff --git a/docs/users/_meta.ts b/docs/users/_meta.ts index a44167cff..2ec43d773 100644 --- a/docs/users/_meta.ts +++ b/docs/users/_meta.ts @@ -12,6 +12,7 @@ export default { }, 'integration-vscode': 'Visual Studio Code', 'integration-zed': 'Zed IDE', + 'integration-jetbrains': 'JetBrains IDEs', 'integration-github-action': 'Github Actions', 'Code with Qwen Code': { type: 'separator', diff --git a/docs/users/integration-jetbrains.md b/docs/users/integration-jetbrains.md new file mode 100644 index 000000000..9584cd097 --- /dev/null +++ b/docs/users/integration-jetbrains.md @@ -0,0 +1,55 @@ +# JetBrains IDEs + +> JetBrains IDEs provide native support for AI coding assistants through the Agent Control Protocol (ACP). This integration allows you to use Qwen Code directly within your JetBrains IDE with real-time code suggestions. + +### Features + +- **Native agent experience**: Integrated AI assistant panel within your JetBrains IDE +- **Agent Control Protocol**: Full support for ACP enabling advanced IDE interactions +- **Symbol management**: #-mention files to add them to the conversation context +- **Conversation history**: Access to past conversations within the IDE + +### Requirements + +- JetBrains IDE with ACP support (IntelliJ IDEA, WebStorm, PyCharm, etc.) +- Qwen Code CLI installed + +### Installation + +1. Install Qwen Code CLI: + + ```bash + npm install -g qwen-code + ``` + +2. Open your JetBrains IDE and navigate to AI Chat tool window. + +3. Click the 3-dot menu in the upper-right corner and select **Configure ACP Agent** and configure Qwen Code with the following settings: + +```json +{ + "agent_servers": { + "qwen": { + "command": "/path/to/qwen", + "args": ["--experimental-acp"], + "env": {} + } + } +} +``` + +4. The Qwen Code agent should now be available in the AI Assistant panel + +## Troubleshooting + +### Agent not appearing + +- Run `qwen --version` in terminal to verify installation +- Ensure your JetBrains IDE version supports ACP +- Restart your JetBrains IDE + +### Qwen Code not responding + +- Check your internet connection +- Verify CLI works by running `qwen` in terminal +- [File an issue on GitHub](https://github.com/qwenlm/qwen-code/issues) if the problem persists