@qwen-code/qwen-code 0.0.1 → 0.0.2

package/README.md

@@ -1,113 +1,287 @@
 # Qwen Code
 
+<div align="center">
+
 ![Qwen Code Screenshot](./docs/assets/qwen-screenshot.png)
 
-Qwen Code is a command-line AI workflow tool adapted from [**Gemini CLI**](https://github.com/google-gemini/gemini-cli)(Please refer to [this document](./README.gemini.md) for more details), optimized for Qwen-Coder models with enhanced parser support & tool support.
+[![npm version](https://img.shields.io/npm/v/@qwen-code/qwen-code.svg)](https://www.npmjs.com/package/@qwen-code/qwen-code)
+[![License](https://img.shields.io/github/license/QwenLM/qwen-code.svg)](./LICENSE)
+[![Node.js Version](https://img.shields.io/badge/node-%3E%3D20.0.0-brightgreen.svg)](https://nodejs.org/)
+[![Downloads](https://img.shields.io/npm/dm/@qwen-code/qwen-code.svg)](https://www.npmjs.com/package/@qwen-code/qwen-code)
+
+**AI-powered command-line workflow tool for developers**
+
+[Installation](#installation) • [Quick Start](#quick-start) • [Features](#key-features) • [Documentation](./docs/) • [Contributing](./CONTRIBUTING.md)
+
+</div>
+
+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.
+
+> [!WARNING]
+> **Token Usage Notice**: Qwen Code may issue multiple API calls per cycle, resulting in higher token usage (similar to Claude Code). We're actively optimizing API efficiency.
+>
+> 💡 **Free Option**: ModelScope provides **2,000 free API calls per day** for users in mainland China. OpenRouter offers up to **1,000 free API calls per day** worldwide. For setup instructions, see [API Configuration](#api-configuration).
 
 ## Key Features
 
 - **Code Understanding & Editing** - Query and edit large codebases beyond traditional context window limits
-- **Multimodal Capabilities** - Generate new apps from PDFs or sketches with image understanding
 - **Workflow Automation** - Automate operational tasks like handling pull requests and complex rebases
-- **Tool Integration** - Connect new capabilities through MCP servers
 - **Enhanced Parser** - Adapted parser specifically optimized for Qwen-Coder models
 
-## Main Changes
+## Installation
 
-Compared to the original Gemini CLI, key adaptations include:
+### Prerequisites
 
-- Modified parser to work seamlessly with Qwen-Coder model responses
-- Optimized model interaction logic for Qwen series models
+Ensure you have [Node.js version 20](https://nodejs.org/en/download) or higher installed.
 
-## Quick Start
+```bash
+curl -qL https://www.npmjs.com/install.sh | sh
+```
 
-### Prerequisites
+### Install from npm
 
-Ensure you have [Node.js version 20](https://nodejs.org/en/download) or higher installed.
+```bash
+npm install -g @qwen-code/qwen-code@latest
+qwen --version
+```
 
-### Installation
+### Install from source
 
 ```bash
-npm install -g @qwen-code/qwen-code
+git clone https://github.com/QwenLM/qwen-code.git
+cd qwen-code
+npm install
+npm install -g .
 ```
 
-Then run from anywhere:
+## 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`** - Clear all conversation history and start fresh
+- **`/status`** - Check current token usage and limits
+
+> 📝 **Note**: Session token limit applies to a single conversation, not cumulative API calls.
+
 ### API Configuration
 
-Set your Qwen API key (In Qwen Code project, you can also set your API key in `.env` file):
+Qwen Code supports multiple API providers. You can configure your API key through environment variables or a `.env` file in your project root.
+
+#### 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
+
+<details>
+<summary><b>🇨🇳 For Users in Mainland China</b></summary>
+
+**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"
+```
+
+</details>
+
+<details>
+<summary><b>🌍 For International Users</b></summary>
+
+**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="your_api_base_url_here"
-export OPENAI_MODEL="your_api_model_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"
+```
+
+</details>
+
 ## Usage Examples
 
-### Explore Codebases
+### 🔍 Explore Codebases
 
-```sh
+```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
+### 💻 Code Development
 
-```sh
+```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
+### 🔄 Automate Workflows
 
-```sh
-> Analyze git commits from the last 7 days, grouped by feature and team member
-```
+```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
 
-```sh
+# 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
+### 📚 Understand New Codebases
 
 ```text
 > What are the core business logic components?
 > What security mechanisms are in place?
-> How does the data flow work?
+> 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
+### 🔨 Code Refactoring & Optimization
 
 ```text
 > What parts of this module can be optimized?
-> Help me refactor this class to follow better design patterns
+> 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
+### 📝 Documentation & Testing
 
 ```text
-> Generate comprehensive JSDoc comments for this function
-> Write unit tests for this component
-> Create API documentation
+> 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
 ```
 
-## Project Structure
+### 🚀 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
 ```
-qwen-code/
-├── packages/           # Core packages
-├── docs/              # Documentation
-├── examples/          # Example code
-└── tests/            # Test files
-```
+
+## Commands & Shortcuts
+
+### Session Commands
+
+- `/help` - Display available commands
+- `/clear` - Clear conversation history
+- `/compress` - Compress history to save tokens
+- `/status` - 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
+
+## Benchmark Results
+
+### Terminal-Bench Performance
+
+| Agent     | Model              | Accuracy |
+| --------- | ------------------ | -------- |
+| Qwen Code | Qwen3-Coder-480A35 | 37.5%    |
+| Qwen Code | Qwen3-Coder-30BA3B | 31.3%    |
 
 ## Development & Contributing
 
@@ -119,8 +293,12 @@ If you encounter issues, check the [troubleshooting guide](docs/troubleshooting.
 
 ## Acknowledgments
 
-This project is based on [Google Gemini CLI](https://github.com/google-gemini/gemini-cli). We acknowledge and appreciate the excellent work of the original team. Our main contribution focuses on parser-level adaptations to better support Qwen-Coder models.
+This project is based on [Google Gemini CLI](https://github.com/google-gemini/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](./LICENSE)
+
+## Star History
+
+[![Star History Chart](https://api.star-history.com/svg?repos=QwenLM/qwen-code&type=Date)](https://www.star-history.com/#QwenLM/qwen-code&Date)

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+#!/usr/bin/env node
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import './src/gemini.js';

package/dist/index.js

@@ -0,0 +1,20 @@
+#!/usr/bin/env node
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import './src/gemini.js';
+import { main } from './src/gemini.js';
+// --- Global Entry Point ---
+main().catch((error) => {
+    console.error('An unexpected critical error occurred:');
+    if (error instanceof Error) {
+        console.error(error.stack);
+    }
+    else {
+        console.error(String(error));
+    }
+    process.exit(1);
+});
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";AAEA;;;;GAIG;AAEH,OAAO,iBAAiB,CAAC;AACzB,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAEvC,6BAA6B;AAC7B,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;IACrB,OAAO,CAAC,KAAK,CAAC,wCAAwC,CAAC,CAAC;IACxD,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;QAC3B,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAC7B,CAAC;SAAM,CAAC;QACN,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;IAC/B,CAAC;IACD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC,CAAC,CAAC"}

package/dist/package.json

@@ -0,0 +1,79 @@
+{
+    "name": "@qwen-code/qwen-code",
+    "version": "0.0.2",
+    "description": "Qwen Code",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/QwenLM/qwen-code.git"
+    },
+    "type": "module",
+    "main": "dist/index.js",
+    "bin": {
+        "qwen": "dist/index.js"
+    },
+    "scripts": {
+        "build": "node ../../scripts/build_package.js",
+        "start": "node dist/index.js",
+        "debug": "node --inspect-brk dist/index.js",
+        "lint": "eslint . --ext .ts,.tsx",
+        "format": "prettier --write .",
+        "test": "vitest run",
+        "test:ci": "vitest run --coverage",
+        "typecheck": "tsc --noEmit"
+    },
+    "files": [
+        "dist"
+    ],
+    "config": {
+        "sandboxImageUri": "ghcr.io/qwenlm/qwen-code:0.0.2"
+    },
+    "dependencies": {
+        "@qwen-code/qwen-code-core": "file:../core",
+        "@types/update-notifier": "^6.0.8",
+        "command-exists": "^1.2.9",
+        "diff": "^7.0.0",
+        "dotenv": "^17.1.0",
+        "gaxios": "^7.1.1",
+        "glob": "^10.4.1",
+        "highlight.js": "^11.11.1",
+        "ink": "^6.0.1",
+        "ink-big-text": "^2.0.0",
+        "ink-gradient": "^3.0.0",
+        "ink-link": "^4.1.0",
+        "ink-select-input": "^6.2.0",
+        "ink-spinner": "^5.0.0",
+        "lowlight": "^3.3.0",
+        "mime-types": "^3.0.1",
+        "open": "^10.1.2",
+        "react": "^19.1.0",
+        "read-package-up": "^11.0.0",
+        "shell-quote": "^1.8.3",
+        "string-width": "^7.1.0",
+        "strip-ansi": "^7.1.0",
+        "strip-json-comments": "^3.1.1",
+        "update-notifier": "^7.3.1",
+        "yargs": "^18.0.0"
+    },
+    "devDependencies": {
+        "@babel/runtime": "^7.27.6",
+        "@testing-library/react": "^16.3.0",
+        "@types/command-exists": "^1.2.3",
+        "@types/diff": "^7.0.2",
+        "@types/dotenv": "^6.1.1",
+        "@types/node": "^20.11.24",
+        "@types/react": "^19.1.8",
+        "@types/react-dom": "^19.1.6",
+        "@types/semver": "^7.7.0",
+        "@types/shell-quote": "^1.7.5",
+        "@types/yargs": "^17.0.32",
+        "ink-testing-library": "^4.0.0",
+        "jsdom": "^26.1.0",
+        "pretty-format": "^30.0.2",
+        "react-dom": "^19.1.0",
+        "typescript": "^5.3.3",
+        "vitest": "^3.1.1"
+    },
+    "engines": {
+        "node": ">=20"
+    }
+}

package/dist/src/config/auth.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+export declare const validateAuthMethod: (authMethod: string) => string | null;
+export declare const setOpenAIApiKey: (apiKey: string) => void;
+export declare const setOpenAIBaseUrl: (baseUrl: string) => void;
+export declare const setOpenAIModel: (model: string) => void;

package/dist/src/config/auth.js

@@ -0,0 +1,48 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { AuthType } from '@qwen-code/qwen-code-core';
+import { loadEnvironment } from './settings.js';
+export const validateAuthMethod = (authMethod) => {
+    loadEnvironment();
+    if (authMethod === AuthType.LOGIN_WITH_GOOGLE ||
+        authMethod === AuthType.CLOUD_SHELL) {
+        return null;
+    }
+    if (authMethod === AuthType.USE_GEMINI) {
+        if (!process.env.GEMINI_API_KEY) {
+            return 'GEMINI_API_KEY environment variable not found. Add that to your environment and try again (no reload needed if using .env)!';
+        }
+        return null;
+    }
+    if (authMethod === AuthType.USE_VERTEX_AI) {
+        const hasVertexProjectLocationConfig = !!process.env.GOOGLE_CLOUD_PROJECT && !!process.env.GOOGLE_CLOUD_LOCATION;
+        const hasGoogleApiKey = !!process.env.GOOGLE_API_KEY;
+        if (!hasVertexProjectLocationConfig && !hasGoogleApiKey) {
+            return ('When using Vertex AI, you must specify either:\n' +
+                '• GOOGLE_CLOUD_PROJECT and GOOGLE_CLOUD_LOCATION environment variables.\n' +
+                '• GOOGLE_API_KEY environment variable (if using express mode).\n' +
+                'Update your environment and try again (no reload needed if using .env)!');
+        }
+        return null;
+    }
+    if (authMethod === AuthType.USE_OPENAI) {
+        if (!process.env.OPENAI_API_KEY) {
+            return 'OPENAI_API_KEY environment variable not found. You can enter it interactively or add it to your .env file.';
+        }
+        return null;
+    }
+    return 'Invalid auth method selected.';
+};
+export const setOpenAIApiKey = (apiKey) => {
+    process.env.OPENAI_API_KEY = apiKey;
+};
+export const setOpenAIBaseUrl = (baseUrl) => {
+    process.env.OPENAI_BASE_URL = baseUrl;
+};
+export const setOpenAIModel = (model) => {
+    process.env.OPENAI_MODEL = model;
+};
+//# sourceMappingURL=auth.js.map

package/dist/src/config/auth.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth.js","sourceRoot":"","sources":["../../../src/config/auth.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AACrD,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAEhD,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,UAAkB,EAAiB,EAAE;IACtE,eAAe,EAAE,CAAC;IAClB,IACE,UAAU,KAAK,QAAQ,CAAC,iBAAiB;QACzC,UAAU,KAAK,QAAQ,CAAC,WAAW,EACnC,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,UAAU,KAAK,QAAQ,CAAC,UAAU,EAAE,CAAC;QACvC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,CAAC;YAChC,OAAO,6HAA6H,CAAC;QACvI,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,UAAU,KAAK,QAAQ,CAAC,aAAa,EAAE,CAAC;QAC1C,MAAM,8BAA8B,GAClC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,oBAAoB,IAAI,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,CAAC;QAC5E,MAAM,eAAe,GAAG,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC;QACrD,IAAI,CAAC,8BAA8B,IAAI,CAAC,eAAe,EAAE,CAAC;YACxD,OAAO,CACL,kDAAkD;gBAClD,2EAA2E;gBAC3E,kEAAkE;gBAClE,yEAAyE,CAC1E,CAAC;QACJ,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,UAAU,KAAK,QAAQ,CAAC,UAAU,EAAE,CAAC;QACvC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,CAAC;YAChC,OAAO,4GAA4G,CAAC;QACtH,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,+BAA+B,CAAC;AACzC,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,MAAc,EAAQ,EAAE;IACtD,OAAO,CAAC,GAAG,CAAC,cAAc,GAAG,MAAM,CAAC;AACtC,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,OAAe,EAAQ,EAAE;IACxD,OAAO,CAAC,GAAG,CAAC,eAAe,GAAG,OAAO,CAAC;AACxC,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,KAAa,EAAQ,EAAE;IACpD,OAAO,CAAC,GAAG,CAAC,YAAY,GAAG,KAAK,CAAC;AACnC,CAAC,CAAC"}

package/dist/src/config/config.d.ts

@@ -0,0 +1,39 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { Config, FileDiscoveryService } from '@qwen-code/qwen-code-core';
+import { Settings } from './settings.js';
+import { Extension } from './extension.js';
+export interface CliArgs {
+    model: string | undefined;
+    sandbox: boolean | string | undefined;
+    sandboxImage: string | undefined;
+    debug: boolean | undefined;
+    prompt: string | undefined;
+    promptInteractive: string | undefined;
+    allFiles: boolean | undefined;
+    all_files: boolean | undefined;
+    showMemoryUsage: boolean | undefined;
+    show_memory_usage: boolean | undefined;
+    yolo: boolean | undefined;
+    telemetry: boolean | undefined;
+    checkpointing: boolean | undefined;
+    telemetryTarget: string | undefined;
+    telemetryOtlpEndpoint: string | undefined;
+    telemetryLogPrompts: boolean | undefined;
+    allowedMcpServerNames: string[] | undefined;
+    extensions: string[] | undefined;
+    listExtensions: boolean | undefined;
+    ideMode: boolean | undefined;
+    openaiLogging: boolean | undefined;
+    openaiApiKey: string | undefined;
+    openaiBaseUrl: string | undefined;
+}
+export declare function parseArguments(): Promise<CliArgs>;
+export declare function loadHierarchicalGeminiMemory(currentWorkingDirectory: string, debugMode: boolean, fileService: FileDiscoveryService, extensionContextFilePaths?: string[]): Promise<{
+    memoryContent: string;
+    fileCount: number;
+}>;
+export declare function loadCliConfig(settings: Settings, extensions: Extension[], sessionId: string, argv: CliArgs): Promise<Config>;