@jaydennleemc/qwen-code-local 0.12.3-beta.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,203 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright 2025 Google LLC
191
+ Copyright 2025 Qwen
192
+
193
+ Licensed under the Apache License, Version 2.0 (the "License");
194
+ you may not use this file except in compliance with the License.
195
+ You may obtain a copy of the License at
196
+
197
+ http://www.apache.org/licenses/LICENSE-2.0
198
+
199
+ Unless required by applicable law or agreed to in writing, software
200
+ distributed under the License is distributed on an "AS IS" BASIS,
201
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
202
+ See the License for the specific language governing permissions and
203
+ limitations under the License.
package/README.md ADDED
@@ -0,0 +1,465 @@
1
+ <div align="center">
2
+
3
+ [![npm version](https://img.shields.io/npm/v/@qwen-code/qwen-code.svg)](https://www.npmjs.com/package/@qwen-code/qwen-code)
4
+ [![License](https://img.shields.io/github/license/QwenLM/qwen-code.svg)](./LICENSE)
5
+ [![Node.js Version](https://img.shields.io/badge/node-%3E%3D20.0.0-brightgreen.svg)](https://nodejs.org/)
6
+ [![Downloads](https://img.shields.io/npm/dm/@qwen-code/qwen-code.svg)](https://www.npmjs.com/package/@qwen-code/qwen-code)
7
+
8
+ <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>
9
+
10
+ **An open-source AI agent that lives in your terminal.**
11
+
12
+ <a href="https://qwenlm.github.io/qwen-code-docs/zh/users/overview">中文</a> |
13
+ <a href="https://qwenlm.github.io/qwen-code-docs/de/users/overview">Deutsch</a> |
14
+ <a href="https://qwenlm.github.io/qwen-code-docs/fr/users/overview">français</a> |
15
+ <a href="https://qwenlm.github.io/qwen-code-docs/ja/users/overview">日本語</a> |
16
+ <a href="https://qwenlm.github.io/qwen-code-docs/ru/users/overview">Русский</a> |
17
+ <a href="https://qwenlm.github.io/qwen-code-docs/pt-BR/users/overview">Português (Brasil)</a>
18
+
19
+ </div>
20
+
21
+ > 🎉 **News (2026-02-16)**: Qwen3.5-Plus is now live! Sign in via Qwen OAuth to use it directly, or get an API key from [Alibaba Cloud ModelStudio](https://modelstudio.console.alibabacloud.com?tab=doc#/doc/?type=model&url=2840914_2&modelId=group-qwen3.5-plus) to access it through the OpenAI-compatible API.
22
+
23
+ Qwen Code is an open-source AI agent for the terminal, optimized for [Qwen3-Coder](https://github.com/QwenLM/Qwen3-Coder). It helps you understand large codebases, automate tedious work, and ship faster.
24
+
25
+ ![](https://gw.alicdn.com/imgextra/i1/O1CN01D2DviS1wwtEtMwIzJ_!!6000000006373-2-tps-1600-900.png)
26
+
27
+ ## Why Qwen Code?
28
+
29
+ - **Multi-protocol, OAuth free tier**: use OpenAI / Anthropic / Gemini-compatible APIs, or sign in with Qwen OAuth for 1,000 free requests/day.
30
+ - **Open-source, co-evolving**: both the framework and the Qwen3-Coder model are open-source—and they ship and evolve together.
31
+ - **Agentic workflow, feature-rich**: rich built-in tools (Skills, SubAgents) for a full agentic workflow and a Claude Code-like experience.
32
+ - **Terminal-first, IDE-friendly**: built for developers who live in the command line, with optional integration for VS Code, Zed, and JetBrains IDEs.
33
+
34
+ ## Installation
35
+
36
+ ### Quick Install (Recommended)
37
+
38
+ #### Linux / macOS
39
+
40
+ ```bash
41
+ bash -c "$(curl -fsSL https://qwen-code-assets.oss-cn-hangzhou.aliyuncs.com/installation/install-qwen.sh)"
42
+ ```
43
+
44
+ #### Windows (Run as Administrator CMD)
45
+
46
+ ```cmd
47
+ curl -fsSL -o %TEMP%\install-qwen.bat https://qwen-code-assets.oss-cn-hangzhou.aliyuncs.com/installation/install-qwen.bat && %TEMP%\install-qwen.bat
48
+ ```
49
+
50
+ > **Note**: It's recommended to restart your terminal after installation to ensure environment variables take effect.
51
+
52
+ ### Manual Installation
53
+
54
+ #### Prerequisites
55
+
56
+ Make sure you have Node.js 20 or later installed. Download it from [nodejs.org](https://nodejs.org/en/download).
57
+
58
+ #### NPM
59
+
60
+ ```bash
61
+ npm install -g @qwen-code/qwen-code@latest
62
+ ```
63
+
64
+ #### Homebrew (macOS, Linux)
65
+
66
+ ```bash
67
+ brew install qwen-code
68
+ ```
69
+
70
+ ## Quick Start
71
+
72
+ ```bash
73
+ # Start Qwen Code (interactive)
74
+ qwen
75
+
76
+ # Then, in the session:
77
+ /help
78
+ /auth
79
+ ```
80
+
81
+ On first use, you'll be prompted to sign in. You can run `/auth` anytime to switch authentication methods.
82
+
83
+ Example prompts:
84
+
85
+ ```text
86
+ What does this project do?
87
+ Explain the codebase structure.
88
+ Help me refactor this function.
89
+ Generate unit tests for this module.
90
+ ```
91
+
92
+ <details>
93
+ <summary>Click to watch a demo video</summary>
94
+
95
+ <video src="https://cloud.video.taobao.com/vod/HLfyppnCHplRV9Qhz2xSqeazHeRzYtG-EYJnHAqtzkQ.mp4" controls>
96
+ Your browser does not support the video tag.
97
+ </video>
98
+
99
+ </details>
100
+
101
+ ## Authentication
102
+
103
+ Qwen Code supports two authentication methods:
104
+
105
+ - **Qwen OAuth (recommended & free)**: sign in with your `qwen.ai` account in a browser.
106
+ - **API-KEY**: use an API key to connect to any supported provider (OpenAI, Anthropic, Google GenAI, Alibaba Cloud Bailian, and other compatible endpoints).
107
+
108
+ #### Qwen OAuth (recommended)
109
+
110
+ Start `qwen`, then run:
111
+
112
+ ```bash
113
+ /auth
114
+ ```
115
+
116
+ Choose **Qwen OAuth** and complete the browser flow. Your credentials are cached locally so you usually won't need to log in again.
117
+
118
+ > **Note:** In non-interactive or headless environments (e.g., CI, SSH, containers), you typically **cannot** complete the OAuth browser login flow. In these cases, please use the API-KEY authentication method.
119
+
120
+ #### API-KEY (flexible)
121
+
122
+ Use this if you want more flexibility over which provider and model to use. Supports multiple protocols:
123
+
124
+ - **OpenAI-compatible**: Alibaba Cloud Bailian, ModelScope, OpenAI, OpenRouter, and other OpenAI-compatible providers
125
+ - **Anthropic**: Claude models
126
+ - **Google GenAI**: Gemini models
127
+
128
+ The **recommended** way to configure models and providers is by editing `~/.qwen_local/settings.json` (create it if it doesn't exist). This file lets you define all available models, API keys, and default settings in one place.
129
+
130
+ ##### Quick Setup in 3 Steps
131
+
132
+ **Step 1:** Create or edit `~/.qwen_local/settings.json`
133
+
134
+ Here is a complete example:
135
+
136
+ ```json
137
+ {
138
+ "modelProviders": {
139
+ "openai": [
140
+ {
141
+ "id": "qwen3-coder-plus",
142
+ "name": "qwen3-coder-plus",
143
+ "baseUrl": "https://dashscope.aliyuncs.com/compatible-mode/v1",
144
+ "description": "Qwen3-Coder via Dashscope",
145
+ "envKey": "DASHSCOPE_API_KEY"
146
+ }
147
+ ]
148
+ },
149
+ "env": {
150
+ "DASHSCOPE_API_KEY": "sk-xxxxxxxxxxxxx"
151
+ },
152
+ "security": {
153
+ "auth": {
154
+ "selectedType": "openai"
155
+ }
156
+ },
157
+ "model": {
158
+ "name": "qwen3-coder-plus"
159
+ }
160
+ }
161
+ ```
162
+
163
+ **Step 2:** Understand each field
164
+
165
+ | Field | What it does |
166
+ | ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
167
+ | `modelProviders` | Declares which models are available and how to connect to them. Keys like `openai`, `anthropic`, `gemini` represent the API protocol. |
168
+ | `modelProviders[].id` | The model ID sent to the API (e.g. `qwen3-coder-plus`, `gpt-4o`). |
169
+ | `modelProviders[].envKey` | The name of the environment variable that holds your API key. |
170
+ | `modelProviders[].baseUrl` | The API endpoint URL (required for non-default endpoints). |
171
+ | `env` | A fallback place to store API keys (lowest priority; prefer `.env` files or `export` for sensitive keys). |
172
+ | `security.auth.selectedType` | The protocol to use on startup (`openai`, `anthropic`, `gemini`, `vertex-ai`). |
173
+ | `model.name` | The default model to use when Qwen Code starts. |
174
+
175
+ **Step 3:** Start Qwen Code — your configuration takes effect automatically:
176
+
177
+ ```bash
178
+ qwen
179
+ ```
180
+
181
+ Use the `/model` command at any time to switch between all configured models.
182
+
183
+ ##### More Examples
184
+
185
+ <details>
186
+ <summary>Coding Plan (Alibaba Cloud Bailian) — fixed monthly fee, higher quotas</summary>
187
+
188
+ ```json
189
+ {
190
+ "modelProviders": {
191
+ "openai": [
192
+ {
193
+ "id": "qwen3.5-plus",
194
+ "name": "qwen3.5-plus (Coding Plan)",
195
+ "baseUrl": "https://coding.dashscope.aliyuncs.com/v1",
196
+ "description": "qwen3.5-plus with thinking enabled from Bailian Coding Plan",
197
+ "envKey": "BAILIAN_CODING_PLAN_API_KEY",
198
+ "generationConfig": {
199
+ "extra_body": {
200
+ "enable_thinking": true
201
+ }
202
+ }
203
+ },
204
+ {
205
+ "id": "qwen3-coder-plus",
206
+ "name": "qwen3-coder-plus (Coding Plan)",
207
+ "baseUrl": "https://coding.dashscope.aliyuncs.com/v1",
208
+ "description": "qwen3-coder-plus from Bailian Coding Plan",
209
+ "envKey": "BAILIAN_CODING_PLAN_API_KEY"
210
+ },
211
+ {
212
+ "id": "qwen3-coder-next",
213
+ "name": "qwen3-coder-next (Coding Plan)",
214
+ "baseUrl": "https://coding.dashscope.aliyuncs.com/v1",
215
+ "description": "qwen3-coder-next with thinking enabled from Bailian Coding Plan",
216
+ "envKey": "BAILIAN_CODING_PLAN_API_KEY",
217
+ "generationConfig": {
218
+ "extra_body": {
219
+ "enable_thinking": true
220
+ }
221
+ }
222
+ },
223
+ {
224
+ "id": "glm-4.7",
225
+ "name": "glm-4.7 (Coding Plan)",
226
+ "baseUrl": "https://coding.dashscope.aliyuncs.com/v1",
227
+ "description": "glm-4.7 with thinking enabled from Bailian Coding Plan",
228
+ "envKey": "BAILIAN_CODING_PLAN_API_KEY",
229
+ "generationConfig": {
230
+ "extra_body": {
231
+ "enable_thinking": true
232
+ }
233
+ }
234
+ },
235
+ {
236
+ "id": "kimi-k2.5",
237
+ "name": "kimi-k2.5 (Coding Plan)",
238
+ "baseUrl": "https://coding.dashscope.aliyuncs.com/v1",
239
+ "description": "kimi-k2.5 with thinking enabled from Bailian Coding Plan",
240
+ "envKey": "BAILIAN_CODING_PLAN_API_KEY",
241
+ "generationConfig": {
242
+ "extra_body": {
243
+ "enable_thinking": true
244
+ }
245
+ }
246
+ }
247
+ ]
248
+ },
249
+ "env": {
250
+ "BAILIAN_CODING_PLAN_API_KEY": "sk-xxxxxxxxxxxxx"
251
+ },
252
+ "security": {
253
+ "auth": {
254
+ "selectedType": "openai"
255
+ }
256
+ },
257
+ "model": {
258
+ "name": "qwen3-coder-plus"
259
+ }
260
+ }
261
+ ```
262
+
263
+ > Subscribe to the Coding Plan and get your API key at [Alibaba Cloud Bailian](https://modelstudio.console.aliyun.com/?tab=dashboard#/efm/coding_plan).
264
+
265
+ </details>
266
+
267
+ <details>
268
+ <summary>Multiple providers (OpenAI + Anthropic + Gemini)</summary>
269
+
270
+ ```json
271
+ {
272
+ "modelProviders": {
273
+ "openai": [
274
+ {
275
+ "id": "gpt-4o",
276
+ "name": "GPT-4o",
277
+ "envKey": "OPENAI_API_KEY",
278
+ "baseUrl": "https://api.openai.com/v1"
279
+ }
280
+ ],
281
+ "anthropic": [
282
+ {
283
+ "id": "claude-sonnet-4-20250514",
284
+ "name": "Claude Sonnet 4",
285
+ "envKey": "ANTHROPIC_API_KEY"
286
+ }
287
+ ],
288
+ "gemini": [
289
+ {
290
+ "id": "gemini-2.5-pro",
291
+ "name": "Gemini 2.5 Pro",
292
+ "envKey": "GEMINI_API_KEY"
293
+ }
294
+ ]
295
+ },
296
+ "env": {
297
+ "OPENAI_API_KEY": "sk-xxxxxxxxxxxxx",
298
+ "ANTHROPIC_API_KEY": "sk-ant-xxxxxxxxxxxxx",
299
+ "GEMINI_API_KEY": "AIzaxxxxxxxxxxxxx"
300
+ },
301
+ "security": {
302
+ "auth": {
303
+ "selectedType": "openai"
304
+ }
305
+ },
306
+ "model": {
307
+ "name": "gpt-4o"
308
+ }
309
+ }
310
+ ```
311
+
312
+ </details>
313
+
314
+ <details>
315
+ <summary>Enable thinking mode (for supported models like qwen3.5-plus)</summary>
316
+
317
+ ```json
318
+ {
319
+ "modelProviders": {
320
+ "openai": [
321
+ {
322
+ "id": "qwen3.5-plus",
323
+ "name": "qwen3.5-plus (thinking)",
324
+ "envKey": "DASHSCOPE_API_KEY",
325
+ "baseUrl": "https://dashscope.aliyuncs.com/compatible-mode/v1",
326
+ "generationConfig": {
327
+ "extra_body": {
328
+ "enable_thinking": true
329
+ }
330
+ }
331
+ }
332
+ ]
333
+ },
334
+ "env": {
335
+ "DASHSCOPE_API_KEY": "sk-xxxxxxxxxxxxx"
336
+ },
337
+ "security": {
338
+ "auth": {
339
+ "selectedType": "openai"
340
+ }
341
+ },
342
+ "model": {
343
+ "name": "qwen3.5-plus"
344
+ }
345
+ }
346
+ ```
347
+
348
+ </details>
349
+
350
+ > **Tip:** You can also set API keys via `export` in your shell or `.env` files, which take higher priority than `settings.json` → `env`. See the [authentication guide](https://qwenlm.github.io/qwen-code-docs/en/users/configuration/auth/) for full details.
351
+
352
+ > **Security note:** Never commit API keys to version control. The `~/.qwen_local/settings.json` file is in your home directory and should stay private.
353
+
354
+ ## Usage
355
+
356
+ As an open-source terminal agent, you can use Qwen Code in four primary ways:
357
+
358
+ 1. Interactive mode (terminal UI)
359
+ 2. Headless mode (scripts, CI)
360
+ 3. IDE integration (VS Code, Zed)
361
+ 4. TypeScript SDK
362
+
363
+ #### Interactive mode
364
+
365
+ ```bash
366
+ cd your-project/
367
+ qwen
368
+ ```
369
+
370
+ Run `qwen` in your project folder to launch the interactive terminal UI. Use `@` to reference local files (for example `@src/main.ts`).
371
+
372
+ #### Headless mode
373
+
374
+ ```bash
375
+ cd your-project/
376
+ qwen -p "your question"
377
+ ```
378
+
379
+ Use `-p` to run Qwen Code without the interactive UI—ideal for scripts, automation, and CI/CD. Learn more: [Headless mode](https://qwenlm.github.io/qwen-code-docs/en/users/features/headless).
380
+
381
+ #### IDE integration
382
+
383
+ Use Qwen Code inside your editor (VS Code, Zed, and JetBrains IDEs):
384
+
385
+ - [Use in VS Code](https://qwenlm.github.io/qwen-code-docs/en/users/integration-vscode/)
386
+ - [Use in Zed](https://qwenlm.github.io/qwen-code-docs/en/users/integration-zed/)
387
+ - [Use in JetBrains IDEs](https://qwenlm.github.io/qwen-code-docs/en/users/integration-jetbrains/)
388
+
389
+ #### TypeScript SDK
390
+
391
+ Build on top of Qwen Code with the TypeScript SDK:
392
+
393
+ - [Use the Qwen Code SDK](./packages/sdk-typescript/README.md)
394
+
395
+ ## Commands & Shortcuts
396
+
397
+ ### Session Commands
398
+
399
+ - `/help` - Display available commands
400
+ - `/clear` - Clear conversation history
401
+ - `/compress` - Compress history to save tokens
402
+ - `/stats` - Show current session information
403
+ - `/bug` - Submit a bug report
404
+ - `/exit` or `/quit` - Exit Qwen Code
405
+
406
+ ### Keyboard Shortcuts
407
+
408
+ - `Ctrl+C` - Cancel current operation
409
+ - `Ctrl+D` - Exit (on empty line)
410
+ - `Up/Down` - Navigate command history
411
+
412
+ > Learn more about [Commands](https://qwenlm.github.io/qwen-code-docs/en/users/features/commands/)
413
+ >
414
+ > **Tip**: In YOLO mode (`--yolo`), vision switching happens automatically without prompts when images are detected. Learn more about [Approval Mode](https://qwenlm.github.io/qwen-code-docs/en/users/features/approval-mode/)
415
+
416
+ ## Configuration
417
+
418
+ Qwen Code can be configured via `settings.json`, environment variables, and CLI flags.
419
+
420
+ | File | Scope | Description |
421
+ | ----------------------------- | ------------- | --------------------------------------------------------------------------------------- |
422
+ | `~/.qwen_local/settings.json` | User (global) | Applies to all your Qwen Code sessions. **Recommended for `modelProviders` and `env`.** |
423
+ | `.qwen/settings.json` | Project | Applies only when running Qwen Code in this project. Overrides user settings. |
424
+
425
+ The most commonly used top-level fields in `settings.json`:
426
+
427
+ | Field | Description |
428
+ | ---------------------------- | ---------------------------------------------------------------------------------------------------- |
429
+ | `modelProviders` | Define available models per protocol (`openai`, `anthropic`, `gemini`, `vertex-ai`). |
430
+ | `env` | Fallback environment variables (e.g. API keys). Lower priority than shell `export` and `.env` files. |
431
+ | `security.auth.selectedType` | The protocol to use on startup (e.g. `openai`). |
432
+ | `model.name` | The default model to use when Qwen Code starts. |
433
+
434
+ > See the [Authentication](#api-key-flexible) section above for complete `settings.json` examples, and the [settings reference](https://qwenlm.github.io/qwen-code-docs/en/users/configuration/settings/) for all available options.
435
+
436
+ ## Benchmark Results
437
+
438
+ ### Terminal-Bench Performance
439
+
440
+ | Agent | Model | Accuracy |
441
+ | --------- | ------------------ | -------- |
442
+ | Qwen Code | Qwen3-Coder-480A35 | 37.5% |
443
+ | Qwen Code | Qwen3-Coder-30BA3B | 31.3% |
444
+
445
+ ## Ecosystem
446
+
447
+ Looking for a graphical interface?
448
+
449
+ - [**AionUi**](https://github.com/iOfficeAI/AionUi) A modern GUI for command-line AI tools including Qwen Code
450
+ - [**Gemini CLI Desktop**](https://github.com/Piebald-AI/gemini-cli-desktop) A cross-platform desktop/web/mobile UI for Qwen Code
451
+
452
+ ## Troubleshooting
453
+
454
+ If you encounter issues, check the [troubleshooting guide](https://qwenlm.github.io/qwen-code-docs/en/users/support/troubleshooting/).
455
+
456
+ To report a bug from within the CLI, run `/bug` and include a short title and repro steps.
457
+
458
+ ## Connect with Us
459
+
460
+ - Discord: https://discord.gg/ycKBjdNd
461
+ - Dingtalk: https://qr.dingtalk.com/action/joingroup?code=v1,k1,+FX6Gf/ZDlTahTIRi8AEQhIaBlqykA0j+eBKKdhLeAE=&_dt_no_comment=1&origin=1
462
+
463
+ ## Acknowledgments
464
+
465
+ 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.