qwen-code/README.md

3.0 KiB

Qwen Code

Qwen Code Screenshot

Qwen Code is a command-line AI workflow tool adapted from Gemini CLI(Please refer to this document for more details), optimized for Qwen-Coder models with enhanced parser support & tool support.

Key Features

  • Code Understanding & Editing - Query and edit large codebases beyond traditional context window limits
  • Workflow Automation - Automate operational tasks like handling pull requests and complex rebases
  • Enhanced Parser - Adapted parser specifically optimized for Qwen-Coder models

Quick Start

Prerequisites

Ensure you have Node.js version 20 or higher installed.

curl -qL https://www.npmjs.com/install.sh | sh

Installation

npm install -g @qwen-code/qwen-code
qwen --version

Then run from anywhere:

qwen

Or you can install it from source:

git clone https://github.com/QwenLM/qwen-code.git
cd qwen-code
npm install
npm install -g .

API Configuration

Set your Qwen API key (In Qwen Code project, you can also set your API key in .env file):

export OPENAI_API_KEY="your_api_key_here"
export OPENAI_BASE_URL="your_api_base_url_here"
export OPENAI_MODEL="your_api_model_here"

Usage Examples

Explore Codebases

cd your-project/
qwen
> Describe the main pieces of this system's architecture

Code Development

> Refactor this function to improve readability and performance

Automate Workflows

> Analyze git commits from the last 7 days, grouped by feature and team member
> Convert all images in this directory to PNG format

Understand New Codebases

> What are the core business logic components?
> What security mechanisms are in place?
> How does the data flow work?

Code Refactoring & Optimization

> What parts of this module can be optimized?
> Help me refactor this class to follow better design patterns
> Add proper error handling and logging

Documentation & Testing

> Generate comprehensive JSDoc comments for this function
> Write unit tests for this component
> Create API documentation

Project Structure

qwen-code/
├── packages/           # Core packages
├── docs/              # Documentation
├── examples/          # Example code
└── tests/            # Test files

Development & Contributing

See CONTRIBUTING.md to learn how to contribute to the project.

Troubleshooting

If you encounter issues, check the troubleshooting guide.

Acknowledgments

This project is based on Google Gemini CLI. We acknowledge and appreciate the excellent work of the Gemini CLI team. Our main contribution focuses on parser-level adaptations to better support Qwen-Coder models.

License

LICENSE