qwen-code/packages/zed-extension/README.md

Qwen Code Agent Server Extension for Zed

A Zed extension that integrates Qwen Code as an AI agent server using the Agent Client Protocol (ACP).

Features

• Native Agent Experience: Integrated AI assistant panel within Zed's interface
• Agent Client Protocol: Full support for ACP enabling advanced IDE interactions
• File Management: @-mention files to add them to the conversation context
• Conversation History: Access to past conversations within Zed
• Multi-platform Support: Works on macOS (ARM64 & Intel), Linux, and Windows

Installation

1. Open Zed Editor
2. Open the Extensions panel (cmd-shift-x on macOS or ctrl-shift-x on Linux/Windows)
3. Search for "Qwen Code"
4. Click "Install"
5. Switch to the Agent Server tab and ensure Qwen Code is enabled

Alternatively, you can install from the command line:

zed --install-extension qwen-code

Usage

1. Open the Agent Panel in Zed (cmd-shift-a on macOS or ctrl-shift-a on Linux/Windows)
2. Select "Qwen Code" from the agent list
3. Start chatting with the AI assistant

Tips

• Use @filename to mention files in your conversation
• The agent can read, write, and edit files in your workspace
• Ask the agent to explain code, suggest improvements, or help with debugging
• Use natural language to describe what you want to accomplish

Requirements

• Zed Editor (latest version recommended)
• Internet connection for AI model access
• Node.js >= 20 (for running Qwen Code agent server)

Configuration

Environment Variables

When running as an agent server, Qwen Code will:

• Inherit environment variables from Zed
• Read/create ~/.qwen directory for runtime settings
• Use existing model and authentication settings in ~/.qwen/settings.json (except for initial login)

For additional environment variables, configure them in your Zed settings:

{
  "agent_servers": {
    "qwen-code": {
      "env": {
        "QWEN_LOG_LEVEL": "info",
        "YOUR_CUSTOM_VAR": "value"
      }
    }
  }
}

Troubleshooting

Server shutdown unexpectedly

If you encounter errors like "server shut down unexpectedly" or similar issues:

1. Collect logs by pressing cmd+shift+p (macOS) or ctrl+shift+p (Linux/Windows)
2. Select Zed: Open Log
3. Check logs related to agent server or Node.js
4. Include the relevant log information when creating an issue

Agent server starts but encounters issues

If the agent server starts successfully but you experience problems during use:

1. Press cmd+shift+p (macOS) or ctrl+shift+p (Linux/Windows)
2. Select Dev: Open ACP Logs
3. Review ACP logs for error messages
4. Include the relevant log information when creating an issue

Where to report issues

You can report issues at either:

• Qwen Code Issues
• Qwen Code Zed Extension Issues

Documentation

• Qwen Code Documentation
• Zed Agent Panel Guide
• Agent Client Protocol

Support

• Report Issues
• Qwen Code Discussions
• Zed Community

License

See LICENSE file for details.

Contributing

Contributions are welcome! Please feel free to submit issues or pull requests.

About Qwen Code

Qwen Code is an AI-powered coding assistant that helps developers write better code faster. It provides intelligent code completion, refactoring suggestions, bug detection, and natural language code generation.

Learn more at qwenlm.github.io/qwen-code-docs

Stay Tuned

The current version still requires Node.js to run. A single-file executable version is in development - stay tuned for updates!