@mmmbuto/qwen-code-termux 0.12.0-termux → 0.14.0-termux
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/README.md +188 -55
- package/bundled/loop/SKILL.md +61 -0
- package/bundled/qc-helper/SKILL.md +151 -0
- package/bundled/qc-helper/docs/_meta.ts +30 -0
- package/bundled/qc-helper/docs/common-workflow.md +571 -0
- package/bundled/qc-helper/docs/configuration/_meta.ts +10 -0
- package/bundled/qc-helper/docs/configuration/auth.md +366 -0
- package/bundled/qc-helper/docs/configuration/memory.md +0 -0
- package/bundled/qc-helper/docs/configuration/model-providers.md +542 -0
- package/bundled/qc-helper/docs/configuration/qwen-ignore.md +55 -0
- package/bundled/qc-helper/docs/configuration/settings.md +655 -0
- package/bundled/qc-helper/docs/configuration/themes.md +160 -0
- package/bundled/qc-helper/docs/configuration/trusted-folders.md +61 -0
- package/bundled/qc-helper/docs/configuration.md +73 -0
- package/bundled/qc-helper/docs/extension/_meta.ts +9 -0
- package/bundled/qc-helper/docs/extension/extension-releasing.md +204 -0
- package/bundled/qc-helper/docs/extension/getting-started-extensions.md +299 -0
- package/bundled/qc-helper/docs/extension/introduction.md +338 -0
- package/bundled/qc-helper/docs/features/_meta.ts +19 -0
- package/bundled/qc-helper/docs/features/approval-mode.md +263 -0
- package/bundled/qc-helper/docs/features/arena.md +218 -0
- package/bundled/qc-helper/docs/features/channels/_meta.ts +7 -0
- package/bundled/qc-helper/docs/features/channels/dingtalk.md +134 -0
- package/bundled/qc-helper/docs/features/channels/overview.md +336 -0
- package/bundled/qc-helper/docs/features/channels/plugins.md +87 -0
- package/bundled/qc-helper/docs/features/channels/telegram.md +120 -0
- package/bundled/qc-helper/docs/features/channels/weixin.md +106 -0
- package/bundled/qc-helper/docs/features/checkpointing.md +77 -0
- package/bundled/qc-helper/docs/features/commands.md +312 -0
- package/bundled/qc-helper/docs/features/headless.md +318 -0
- package/bundled/qc-helper/docs/features/hooks.md +720 -0
- package/bundled/qc-helper/docs/features/language.md +139 -0
- package/bundled/qc-helper/docs/features/lsp.md +417 -0
- package/bundled/qc-helper/docs/features/mcp.md +281 -0
- package/bundled/qc-helper/docs/features/sandbox.md +241 -0
- package/bundled/qc-helper/docs/features/scheduled-tasks.md +139 -0
- package/bundled/qc-helper/docs/features/skills.md +289 -0
- package/bundled/qc-helper/docs/features/sub-agents.md +515 -0
- package/bundled/qc-helper/docs/features/token-caching.md +29 -0
- package/bundled/qc-helper/docs/ide-integration/_meta.ts +4 -0
- package/bundled/qc-helper/docs/ide-integration/ide-companion-spec.md +182 -0
- package/bundled/qc-helper/docs/ide-integration/ide-integration.md +144 -0
- package/bundled/qc-helper/docs/integration-github-action.md +241 -0
- package/bundled/qc-helper/docs/integration-jetbrains.md +81 -0
- package/bundled/qc-helper/docs/integration-vscode.md +39 -0
- package/bundled/qc-helper/docs/integration-zed.md +72 -0
- package/bundled/qc-helper/docs/overview.md +64 -0
- package/bundled/qc-helper/docs/quickstart.md +273 -0
- package/bundled/qc-helper/docs/reference/_meta.ts +3 -0
- package/bundled/qc-helper/docs/reference/keyboard-shortcuts.md +72 -0
- package/bundled/qc-helper/docs/support/Uninstall.md +42 -0
- package/bundled/qc-helper/docs/support/_meta.ts +6 -0
- package/bundled/qc-helper/docs/support/tos-privacy.md +112 -0
- package/bundled/qc-helper/docs/support/troubleshooting.md +123 -0
- package/bundled/review/SKILL.md +261 -0
- package/cli.js +298314 -244746
- package/locales/de.js +358 -7
- package/locales/en.js +347 -7
- package/locales/ja.js +347 -7
- package/locales/pt.js +353 -7
- package/locales/ru.js +348 -7
- package/locales/zh.js +333 -7
- package/package.json +12 -7
- package/sandbox-macos-permissive-open.sb +3 -1
- package/vendor/tree-sitter/tree-sitter-bash.wasm +0 -0
- package/vendor/tree-sitter/tree-sitter.wasm +0 -0
- package/CHANGELOG.md +0 -77
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<div align="center">
|
|
2
2
|
|
|
3
|
-
[](https://www.npmjs.com/package/@mmmbuto/qwen-code-termux)
|
|
4
4
|
[](./LICENSE)
|
|
5
5
|
[](https://nodejs.org/)
|
|
6
6
|
[](https://www.npmjs.com/package/@mmmbuto/qwen-code-termux)
|
|
@@ -16,102 +16,235 @@
|
|
|
16
16
|
|
|
17
17
|
</div>
|
|
18
18
|
|
|
19
|
-
|
|
20
|
-
This repository/package is a **Termux-first build** that keeps upstream behavior, while fixing the parts that commonly break on Android/Termux (notably PTY and a few runtime quirks).
|
|
19
|
+
> 🎉 **News (2026-04-06)**: Termux Edition v0.14.0 is here! Full upstream v0.14.0 sync with Channels support, Cron scheduling, and Qwen3.6-Plus. TTS notifications, full upstream sync, and a streamlined install experience on Android.
|
|
21
20
|
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-

|
|
21
|
+
Qwen Code is an open-source AI agent for the terminal, optimized for [Qwen3-Coder](https://github.com/QwenLM/Qwen3-Coder).
|
|
22
|
+
This **Termux Edition** fork keeps upstream behaviour while fixing what breaks on Android/Termux.
|
|
26
23
|
|
|
27
24
|
## Why a Termux Edition?
|
|
28
25
|
|
|
29
|
-
Upstream Qwen Code targets macOS/Linux/Windows. On Android/Termux, installs
|
|
26
|
+
Upstream Qwen Code targets macOS/Linux/Windows. On Android/Termux, installs fail due to
|
|
27
|
+
native dependency issues (PTY, node-gyp) and environment quirks.
|
|
30
28
|
|
|
31
|
-
Termux Edition
|
|
29
|
+
Termux Edition fixes:
|
|
32
30
|
|
|
33
|
-
- **Android PTY support** via `@mmmbuto/pty-termux-utils`
|
|
34
|
-
- **Termux runtime patches** (polyfills
|
|
35
|
-
- **Termux-safe install** (
|
|
36
|
-
- **
|
|
31
|
+
- **Android PTY support** via `@mmmbuto/pty-termux-utils`
|
|
32
|
+
- **Termux runtime patches** (base64 polyfills, character encoding)
|
|
33
|
+
- **Termux-safe install** (skips husky + sandbox bundle on npm install)
|
|
34
|
+
- **TTS Notifications** — speak completion/alerts via `termux-tts-speak`
|
|
35
|
+
- **Tested on-device** — see [test-reports/](test-reports/)
|
|
37
36
|
|
|
38
37
|
## Installation (Termux / Android)
|
|
39
38
|
|
|
40
|
-
|
|
39
|
+
```bash
|
|
40
|
+
# Requires: Termux (F-Droid), Node.js 20+
|
|
41
|
+
npm install -g @mmmbuto/qwen-code-termux@latest
|
|
42
|
+
qwen --version
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
**Requirements:**
|
|
46
|
+
|
|
47
|
+
- [Termux (F-Droid)](https://f-droid.org/packages/com.termux/) — Google Play version has issues
|
|
48
|
+
- Node.js 20+ (`pkg install nodejs-lts`)
|
|
49
|
+
- `termux-api` package (optional, for TTS): `pkg install termux-api`
|
|
41
50
|
|
|
42
|
-
|
|
43
|
-
|
|
51
|
+
> **Not on Termux?** Use upstream instead:
|
|
52
|
+
> `npm install -g @qwen-code/qwen-code@latest`
|
|
53
|
+
|
|
54
|
+
## Installation (Linux / macOS / Windows)
|
|
55
|
+
|
|
56
|
+
For non-Termux platforms, use the official upstream:
|
|
44
57
|
|
|
45
58
|
```bash
|
|
46
|
-
|
|
47
|
-
|
|
59
|
+
# Linux / macOS
|
|
60
|
+
bash -c "$(curl -fsSL https://qwen-code-assets.oss-cn-hangzhou.aliyuncs.com/installation/install-qwen.sh)"
|
|
61
|
+
|
|
62
|
+
# Windows (Admin CMD)
|
|
63
|
+
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
64
|
```
|
|
49
65
|
|
|
50
|
-
|
|
66
|
+
Or via Homebrew:
|
|
51
67
|
|
|
52
|
-
|
|
53
|
-
|
|
68
|
+
```bash
|
|
69
|
+
brew install qwen-code
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
## Quick Start
|
|
54
73
|
|
|
55
74
|
```bash
|
|
56
|
-
|
|
75
|
+
cd your-project/
|
|
76
|
+
qwen
|
|
77
|
+
|
|
78
|
+
# Then inside the session:
|
|
79
|
+
/help
|
|
80
|
+
/auth
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
On first use, you'll be prompted to sign in. Run `/auth` anytime to switch auth method.
|
|
84
|
+
|
|
85
|
+
Example prompts:
|
|
86
|
+
|
|
87
|
+
```text
|
|
88
|
+
What does this project do?
|
|
89
|
+
Explain the codebase structure.
|
|
90
|
+
Help me refactor this function.
|
|
91
|
+
Generate unit tests for this module.
|
|
57
92
|
```
|
|
58
93
|
|
|
59
|
-
|
|
94
|
+
## Authentication
|
|
95
|
+
|
|
96
|
+
Two methods — API-KEY is recommended for headless/Termux environments.
|
|
97
|
+
|
|
98
|
+
### API-KEY (recommended)
|
|
99
|
+
|
|
100
|
+
Set up `~/.qwen/settings.json`:
|
|
101
|
+
|
|
102
|
+
```json
|
|
103
|
+
{
|
|
104
|
+
"modelProviders": {
|
|
105
|
+
"openai": [
|
|
106
|
+
{
|
|
107
|
+
"id": "qwen3.6-plus",
|
|
108
|
+
"name": "qwen3.6-plus",
|
|
109
|
+
"baseUrl": "https://dashscope.aliyuncs.com/compatible-mode/v1",
|
|
110
|
+
"description": "Qwen3-Coder via Dashscope",
|
|
111
|
+
"envKey": "DASHSCOPE_API_KEY"
|
|
112
|
+
}
|
|
113
|
+
]
|
|
114
|
+
},
|
|
115
|
+
"env": {
|
|
116
|
+
"DASHSCOPE_API_KEY": "sk-your-key"
|
|
117
|
+
},
|
|
118
|
+
"security": {
|
|
119
|
+
"auth": {
|
|
120
|
+
"selectedType": "openai"
|
|
121
|
+
}
|
|
122
|
+
},
|
|
123
|
+
"model": {
|
|
124
|
+
"name": "qwen3.6-plus"
|
|
125
|
+
}
|
|
126
|
+
}
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
### Qwen OAuth
|
|
60
130
|
|
|
61
131
|
```bash
|
|
62
|
-
|
|
63
|
-
|
|
132
|
+
qwen
|
|
133
|
+
/auth
|
|
134
|
+
# Complete browser flow
|
|
64
135
|
```
|
|
65
136
|
|
|
66
|
-
|
|
137
|
+
> OAuth requires a browser — not available over SSH/headless. Use API-KEY instead.
|
|
138
|
+
|
|
139
|
+
## Usage
|
|
140
|
+
|
|
141
|
+
### Interactive mode
|
|
67
142
|
|
|
68
143
|
```bash
|
|
69
|
-
qwen
|
|
70
|
-
|
|
71
|
-
qwen /help # Commands
|
|
72
|
-
qwen /auth # Authentication
|
|
144
|
+
qwen
|
|
145
|
+
# Use @ to reference files: @src/main.ts
|
|
73
146
|
```
|
|
74
147
|
|
|
75
|
-
|
|
148
|
+
### Headless mode
|
|
76
149
|
|
|
77
|
-
|
|
78
|
-
-
|
|
79
|
-
|
|
80
|
-
- **Config**: [docs/users/configuration.md](docs/users/configuration.md)
|
|
150
|
+
```bash
|
|
151
|
+
qwen -p "your question"
|
|
152
|
+
```
|
|
81
153
|
|
|
82
|
-
|
|
154
|
+
### Session commands
|
|
83
155
|
|
|
84
|
-
|
|
156
|
+
| Command | Description |
|
|
157
|
+
| ----------- | ------------------------------- |
|
|
158
|
+
| `/help` | Available commands |
|
|
159
|
+
| `/clear` | Clear history |
|
|
160
|
+
| `/compress` | Compress history to save tokens |
|
|
161
|
+
| `/stats` | Session info |
|
|
162
|
+
| `/bug` | Submit bug report |
|
|
163
|
+
| `/exit` | Quit |
|
|
85
164
|
|
|
86
|
-
|
|
165
|
+
### Keyboard shortcuts
|
|
87
166
|
|
|
88
|
-
|
|
167
|
+
- `Ctrl+C` — Cancel operation
|
|
168
|
+
- `Ctrl+D` — Exit (empty line)
|
|
169
|
+
- `Up/Down` — Command history
|
|
89
170
|
|
|
90
|
-
|
|
171
|
+
## Termux-Specific Features
|
|
91
172
|
|
|
92
|
-
|
|
173
|
+
### TTS Notifications
|
|
93
174
|
|
|
94
|
-
|
|
175
|
+
When a task completes or needs your attention, Qwen Code can speak a notification
|
|
176
|
+
using Android's text-to-speech engine:
|
|
95
177
|
|
|
96
|
-
|
|
178
|
+
```bash
|
|
179
|
+
# Install termux-api for TTS
|
|
180
|
+
pkg install termux-api
|
|
97
181
|
|
|
98
|
-
|
|
182
|
+
# TTS is used automatically by the tts_notification tool
|
|
183
|
+
```
|
|
99
184
|
|
|
100
|
-
|
|
185
|
+
### PTY Support
|
|
101
186
|
|
|
102
|
-
-
|
|
103
|
-
-
|
|
187
|
+
Shell execution uses a PTY (pseudo-terminal) for proper ANSI colour and interactive
|
|
188
|
+
command support. On Termux, PTY deps are auto-installed on first `npm install`.
|
|
104
189
|
|
|
105
|
-
|
|
190
|
+
### Runtime Patches
|
|
191
|
+
|
|
192
|
+
| File | Purpose |
|
|
193
|
+
| --------------------------------------------- | ------------------------------ |
|
|
194
|
+
| `packages/core/src/patches/termux-runtime.ts` | Android base64 polyfill |
|
|
195
|
+
| `scripts/prepare-termux.cjs` | Skip husky + bundle on Termux |
|
|
196
|
+
| `scripts/postinstall.cjs` | Termux install confirmation |
|
|
197
|
+
| `packages/core/src/utils/termux-detect.ts` | `isTermux()` detection utility |
|
|
198
|
+
|
|
199
|
+
## Building from Source
|
|
200
|
+
|
|
201
|
+
```bash
|
|
202
|
+
git clone https://github.com/DioNanos/qwen-code-termux.git
|
|
203
|
+
cd qwen-code-termux
|
|
204
|
+
npm install
|
|
205
|
+
npm run build
|
|
206
|
+
npm run bundle
|
|
207
|
+
|
|
208
|
+
# Install globally
|
|
209
|
+
npm install -g
|
|
210
|
+
```
|
|
211
|
+
|
|
212
|
+
See [docs/developers/BUILDING.md](docs/developers/BUILDING.md) for full details.
|
|
106
213
|
|
|
107
|
-
|
|
214
|
+
## Configuration
|
|
215
|
+
|
|
216
|
+
| File | Scope | Description |
|
|
217
|
+
| ----------------------- | ------- | ----------------------------- |
|
|
218
|
+
| `~/.qwen/settings.json` | User | Global settings (recommended) |
|
|
219
|
+
| `.qwen/settings.json` | Project | Project-level overrides |
|
|
220
|
+
|
|
221
|
+
See the [authentication guide](https://qwenlm.github.io/qwen-code-docs/en/users/configuration/auth/) for all options.
|
|
222
|
+
|
|
223
|
+
> **Security note:** Never commit API keys to version control.
|
|
224
|
+
|
|
225
|
+
## Troubleshooting
|
|
226
|
+
|
|
227
|
+
- [Qwen Code docs](https://qwenlm.github.io/qwen-code-docs/en/users/support/troubleshooting/)
|
|
228
|
+
- From the CLI: run `/bug` for a bug report template
|
|
229
|
+
- [Test reports](test-reports/) — Termux-specific test results
|
|
230
|
+
|
|
231
|
+
## Ecosystem
|
|
232
|
+
|
|
233
|
+
- [**AionUi**](https://github.com/iOfficeAI/AionUi) — Modern GUI for Qwen Code
|
|
234
|
+
- [**Gemini CLI Desktop**](https://github.com/Piebald-AI/gemini-cli-desktop) — Cross-platform desktop UI
|
|
235
|
+
|
|
236
|
+
## Connect
|
|
237
|
+
|
|
238
|
+
- [Discord](https://discord.gg/RN7tqZCeDK)
|
|
239
|
+
- [Dingtalk](https://qr.dingtalk.com/action/joingroup?code=v1,k1,+FX6Gf/ZDlTahTIRi8AEQhIaBlqykA0j+eBKKdhLeAE=&_dt_no_comment=1&origin=1)
|
|
240
|
+
|
|
241
|
+
## Acknowledgments
|
|
108
242
|
|
|
109
|
-
|
|
243
|
+
This project is based on [Google Gemini CLI](https://github.com/google-gemini/gemini-cli) and
|
|
244
|
+
[Qwen Code](https://github.com/QwenLM/qwen-code). We acknowledge and appreciate the excellent
|
|
245
|
+
work of both teams. This fork focuses on Termux/Android compatibility and Termux-specific
|
|
246
|
+
features.
|
|
110
247
|
|
|
111
248
|
## License
|
|
112
249
|
|
|
113
|
-
|
|
114
|
-
Apache License 2.0 (upstream Qwen Code)<br>
|
|
115
|
-
Termux-port maintenance by Davide A. Guglielmi<br>
|
|
116
|
-
See [LICENSE](./LICENSE) for details and upstream terms.<br>
|
|
117
|
-
Made in Italy 🇮🇹
|
|
250
|
+
Apache-2.0 — see [LICENSE](./LICENSE)
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: loop
|
|
3
|
+
description: Create a recurring loop that runs a prompt on a schedule. Usage - /loop 5m check the build, /loop check the PR every 30m, /loop run tests (defaults to 10m). /loop list to show jobs, /loop clear to cancel all.
|
|
4
|
+
allowedTools:
|
|
5
|
+
- cron_create
|
|
6
|
+
- cron_list
|
|
7
|
+
- cron_delete
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# /loop — schedule a recurring prompt
|
|
11
|
+
|
|
12
|
+
## Subcommands
|
|
13
|
+
|
|
14
|
+
If the input (after stripping the `/loop` prefix) is exactly one of these keywords, run the subcommand instead of scheduling:
|
|
15
|
+
|
|
16
|
+
- **`list`** — call CronList and display the results. Done.
|
|
17
|
+
- **`clear`** — call CronList, then call CronDelete for every job returned. Confirm how many were cancelled. Done.
|
|
18
|
+
|
|
19
|
+
Otherwise, parse the input below into `[interval] <prompt…>` and schedule it with CronCreate.
|
|
20
|
+
|
|
21
|
+
## Parsing (in priority order)
|
|
22
|
+
|
|
23
|
+
1. **Leading token**: if the first whitespace-delimited token matches `^\d+[smhd]$` (e.g. `5m`, `2h`), that's the interval; the rest is the prompt.
|
|
24
|
+
2. **Trailing "every" clause**: otherwise, if the input ends with `every <N><unit>` or `every <N> <unit-word>` (e.g. `every 20m`, `every 5 minutes`, `every 2 hours`), extract that as the interval and strip it from the prompt. Only match when what follows "every" is a time expression — `check every PR` has no interval.
|
|
25
|
+
3. **Default**: otherwise, interval is `10m` and the entire input is the prompt.
|
|
26
|
+
|
|
27
|
+
If the resulting prompt is empty, show usage `/loop [interval] <prompt>` and stop — do not call CronCreate.
|
|
28
|
+
|
|
29
|
+
Examples:
|
|
30
|
+
|
|
31
|
+
- `5m /babysit-prs` → interval `5m`, prompt `/babysit-prs` (rule 1)
|
|
32
|
+
- `check the deploy every 20m` → interval `20m`, prompt `check the deploy` (rule 2)
|
|
33
|
+
- `run tests every 5 minutes` → interval `5m`, prompt `run tests` (rule 2)
|
|
34
|
+
- `check the deploy` → interval `10m`, prompt `check the deploy` (rule 3)
|
|
35
|
+
- `check every PR` → interval `10m`, prompt `check every PR` (rule 3 — "every" not followed by time)
|
|
36
|
+
- `5m` → empty prompt → show usage
|
|
37
|
+
|
|
38
|
+
## Interval → cron
|
|
39
|
+
|
|
40
|
+
Supported suffixes: `s` (seconds, rounded up to nearest minute, min 1), `m` (minutes), `h` (hours), `d` (days). Convert:
|
|
41
|
+
|
|
42
|
+
| Interval pattern | Cron expression | Notes |
|
|
43
|
+
| ----------------- | ---------------------- | ----------------------------------------- |
|
|
44
|
+
| `Nm` where N ≤ 59 | `*/N * * * *` | every N minutes |
|
|
45
|
+
| `Nm` where N ≥ 60 | `0 */H * * *` | round to hours (H = N/60, must divide 24) |
|
|
46
|
+
| `Nh` where N ≤ 23 | `0 */N * * *` | every N hours |
|
|
47
|
+
| `Nd` | `0 0 */N * *` | every N days at midnight local |
|
|
48
|
+
| `Ns` | treat as `ceil(N/60)m` | cron minimum granularity is 1 minute |
|
|
49
|
+
|
|
50
|
+
**If the interval doesn't cleanly divide its unit** (e.g. `7m` → `*/7 * * * *` gives uneven gaps at :56→:00; `90m` → 1.5h which cron can't express), pick the nearest clean interval and tell the user what you rounded to before scheduling.
|
|
51
|
+
|
|
52
|
+
## Action
|
|
53
|
+
|
|
54
|
+
1. Call CronCreate with:
|
|
55
|
+
- `cron`: the expression from the table above
|
|
56
|
+
- `prompt`: the parsed prompt from above, verbatim (slash commands are passed through unchanged)
|
|
57
|
+
- `recurring`: `true`
|
|
58
|
+
2. Briefly confirm: what's scheduled, the cron expression, the human-readable cadence, that recurring tasks auto-expire after 3 days, and that they can cancel sooner with CronDelete (include the job ID).
|
|
59
|
+
3. **Then immediately execute the parsed prompt now** — don't wait for the first cron fire. If it's a slash command, invoke it via the Skill tool; otherwise act on it directly.
|
|
60
|
+
|
|
61
|
+
## Input
|
|
@@ -0,0 +1,151 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: qc-helper
|
|
3
|
+
description: Answer any question about Qwen Code usage, features, configuration, and troubleshooting by referencing the official user documentation. Also helps users view or modify their settings.json. Invoke with `/qc-helper` followed by a question, e.g. `/qc-helper how do I configure MCP servers?` or `/qc-helper change approval mode to yolo`.
|
|
4
|
+
allowedTools:
|
|
5
|
+
- read_file
|
|
6
|
+
- edit_file
|
|
7
|
+
- grep_search
|
|
8
|
+
- glob
|
|
9
|
+
- read_many_files
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
# Qwen Code Helper
|
|
13
|
+
|
|
14
|
+
You are a helpful assistant for **Qwen Code** — an AI coding agent for the terminal. Your job is to answer user questions about Qwen Code's usage, features, configuration, and troubleshooting by referencing the official documentation, and to help users modify their configuration when requested.
|
|
15
|
+
|
|
16
|
+
## How to Find Documentation
|
|
17
|
+
|
|
18
|
+
The official user documentation is available in the `docs/` subdirectory **relative to this skill's directory**. Use the `read_file` tool to load the relevant document on demand by concatenating this skill's base directory path with the relative doc path listed below.
|
|
19
|
+
|
|
20
|
+
> **Example**: If the user asks about MCP servers, read `docs/features/mcp.md` (relative to this skill's directory).
|
|
21
|
+
|
|
22
|
+
---
|
|
23
|
+
|
|
24
|
+
## Documentation Index
|
|
25
|
+
|
|
26
|
+
Use this index to locate the right document for the user's question. Load only the docs that are relevant — do not read everything at once.
|
|
27
|
+
|
|
28
|
+
### Getting Started
|
|
29
|
+
|
|
30
|
+
| Topic | Doc Path |
|
|
31
|
+
| ----------------- | ------------------------- |
|
|
32
|
+
| Product overview | `docs/overview.md` |
|
|
33
|
+
| Quick start guide | `docs/quickstart.md` |
|
|
34
|
+
| Common workflows | `docs/common-workflow.md` |
|
|
35
|
+
|
|
36
|
+
### Configuration
|
|
37
|
+
|
|
38
|
+
| Topic | Doc Path |
|
|
39
|
+
| ----------------------------------------- | --------------------------------------- |
|
|
40
|
+
| Settings reference (all config keys) | `docs/configuration/settings.md` |
|
|
41
|
+
| Authentication setup | `docs/configuration/auth.md` |
|
|
42
|
+
| Model providers (OpenAI-compatible, etc.) | `docs/configuration/model-providers.md` |
|
|
43
|
+
| .qwenignore file | `docs/configuration/qwen-ignore.md` |
|
|
44
|
+
| Themes | `docs/configuration/themes.md` |
|
|
45
|
+
| Memory | `docs/configuration/memory.md` |
|
|
46
|
+
| Trusted folders | `docs/configuration/trusted-folders.md` |
|
|
47
|
+
|
|
48
|
+
### Features
|
|
49
|
+
|
|
50
|
+
| Topic | Doc Path |
|
|
51
|
+
| ------------------------------------------- | -------------------------------- |
|
|
52
|
+
| Approval mode (plan/default/auto_edit/yolo) | `docs/features/approval-mode.md` |
|
|
53
|
+
| MCP (Model Context Protocol) | `docs/features/mcp.md` |
|
|
54
|
+
| Skills system | `docs/features/skills.md` |
|
|
55
|
+
| Sub-agents | `docs/features/sub-agents.md` |
|
|
56
|
+
| Sandbox / security | `docs/features/sandbox.md` |
|
|
57
|
+
| Slash commands | `docs/features/commands.md` |
|
|
58
|
+
| Headless / non-interactive mode | `docs/features/headless.md` |
|
|
59
|
+
| LSP integration | `docs/features/lsp.md` |
|
|
60
|
+
| Checkpointing | `docs/features/checkpointing.md` |
|
|
61
|
+
| Token caching | `docs/features/token-caching.md` |
|
|
62
|
+
| Language / i18n | `docs/features/language.md` |
|
|
63
|
+
| Arena mode | `docs/features/arena.md` |
|
|
64
|
+
|
|
65
|
+
### IDE Integration
|
|
66
|
+
|
|
67
|
+
| Topic | Doc Path |
|
|
68
|
+
| ----------------------- | -------------------------------------------- |
|
|
69
|
+
| VS Code integration | `docs/integration-vscode.md` |
|
|
70
|
+
| Zed IDE integration | `docs/integration-zed.md` |
|
|
71
|
+
| JetBrains integration | `docs/integration-jetbrains.md` |
|
|
72
|
+
| GitHub Actions | `docs/integration-github-action.md` |
|
|
73
|
+
| IDE companion spec | `docs/ide-integration/ide-companion-spec.md` |
|
|
74
|
+
| IDE integration details | `docs/ide-integration/ide-integration.md` |
|
|
75
|
+
|
|
76
|
+
### Extensions
|
|
77
|
+
|
|
78
|
+
| Topic | Doc Path |
|
|
79
|
+
| ------------------------------- | ---------------------------------------------- |
|
|
80
|
+
| Extension introduction | `docs/extension/introduction.md` |
|
|
81
|
+
| Getting started with extensions | `docs/extension/getting-started-extensions.md` |
|
|
82
|
+
| Releasing extensions | `docs/extension/extension-releasing.md` |
|
|
83
|
+
|
|
84
|
+
### Reference & Support
|
|
85
|
+
|
|
86
|
+
| Topic | Doc Path |
|
|
87
|
+
| -------------------------- | -------------------------------------- |
|
|
88
|
+
| Keyboard shortcuts | `docs/reference/keyboard-shortcuts.md` |
|
|
89
|
+
| Troubleshooting | `docs/support/troubleshooting.md` |
|
|
90
|
+
| Uninstall guide | `docs/support/Uninstall.md` |
|
|
91
|
+
| Terms of service & privacy | `docs/support/tos-privacy.md` |
|
|
92
|
+
|
|
93
|
+
---
|
|
94
|
+
|
|
95
|
+
## Configuration Quick Reference
|
|
96
|
+
|
|
97
|
+
When the user asks about configuration, the primary reference is `docs/configuration/settings.md`. Here is a quick orientation:
|
|
98
|
+
|
|
99
|
+
### Config File Locations & Priority
|
|
100
|
+
|
|
101
|
+
| Level | Path | Description |
|
|
102
|
+
| ------- | ------------------------------------------------------------ | -------------------------------------- |
|
|
103
|
+
| User | `~/.qwen/settings.json` | Personal global config |
|
|
104
|
+
| Project | `<project>/.qwen/settings.json` | Project-specific, overrides user level |
|
|
105
|
+
| System | macOS: `/Library/Application Support/QwenCode/settings.json` | Admin-level config |
|
|
106
|
+
|
|
107
|
+
**Priority** (highest to lowest): CLI args > env vars > system settings > project settings > user settings > defaults
|
|
108
|
+
|
|
109
|
+
**Format**: JSON with Comments (supports `//` and `/* */`), with environment variable interpolation (`$VAR` or `${VAR}`)
|
|
110
|
+
|
|
111
|
+
### Common Config Categories
|
|
112
|
+
|
|
113
|
+
| Category | Key Config Keys | Reference |
|
|
114
|
+
| ------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
|
115
|
+
| Permissions | `permissions.allow/ask/deny` | `docs/configuration/settings.md`, `docs/features/approval-mode.md` |
|
|
116
|
+
| MCP Servers | `mcpServers.*`, `mcp.*` | `docs/configuration/settings.md`, `docs/features/mcp.md` |
|
|
117
|
+
| Tool Approval | `tools.approvalMode` | `docs/configuration/settings.md`, `docs/features/approval-mode.md` |
|
|
118
|
+
| Model | `model.name`, `modelProviders` | `docs/configuration/settings.md`, `docs/configuration/model-providers.md` |
|
|
119
|
+
| General/UI | `general.*`, `ui.*`, `ide.*`, `output.*` | `docs/configuration/settings.md` |
|
|
120
|
+
| Context | `context.*` | `docs/configuration/settings.md` |
|
|
121
|
+
| Advanced | `hooks`, `env`, `webSearch`, `security`, `privacy`, `telemetry`, `advanced.*` | `docs/configuration/settings.md` |
|
|
122
|
+
|
|
123
|
+
---
|
|
124
|
+
|
|
125
|
+
## Workflow
|
|
126
|
+
|
|
127
|
+
### Answering Questions
|
|
128
|
+
|
|
129
|
+
1. **Identify the topic** from the user's question using the Documentation Index above
|
|
130
|
+
2. **Use `read_file`** to load the relevant doc(s) — only load what you need
|
|
131
|
+
3. **Provide a clear, concise answer** grounded in the documentation content
|
|
132
|
+
4. If the docs don't cover the question, say so honestly and suggest where to look
|
|
133
|
+
|
|
134
|
+
### Helping with Configuration Changes
|
|
135
|
+
|
|
136
|
+
When the user wants to modify their configuration:
|
|
137
|
+
|
|
138
|
+
1. **Read the relevant doc** to understand the config key, its type, allowed values, and defaults
|
|
139
|
+
2. **Ask which config level** to modify if not specified: user (`~/.qwen/settings.json`) or project (`.qwen/settings.json`)
|
|
140
|
+
3. **Use `read_file`** to check the current content of the target settings file
|
|
141
|
+
4. **Use `edit_file`** to apply the change with correct JSON syntax
|
|
142
|
+
5. **After every configuration change**, you MUST remind the user:
|
|
143
|
+
|
|
144
|
+
> **Note: Most configuration changes require restarting Qwen Code (`/exit` then re-launch) to take effect.** Only a few settings (like `permissions`) are picked up dynamically.
|
|
145
|
+
|
|
146
|
+
### Important Notes
|
|
147
|
+
|
|
148
|
+
- Always ground your answers in the actual documentation content — do not guess or fabricate config keys
|
|
149
|
+
- When showing config examples, use JSONC format with comments for clarity
|
|
150
|
+
- If a question spans multiple topics (e.g., "How do I set up MCP with sandbox?"), read both relevant docs
|
|
151
|
+
- For migration questions from other tools (Claude Code, Gemini CLI, etc.), check `docs/configuration/settings.md` for equivalent config keys
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
export default {
|
|
2
|
+
'Getting started': {
|
|
3
|
+
type: 'separator',
|
|
4
|
+
title: 'Getting started', // Title is optional
|
|
5
|
+
},
|
|
6
|
+
overview: 'Overview',
|
|
7
|
+
quickstart: 'QuickStart',
|
|
8
|
+
'common-workflow': 'Command Workflows',
|
|
9
|
+
'Outside of the terminal': {
|
|
10
|
+
type: 'separator',
|
|
11
|
+
title: 'Outside of the terminal', // Title is optional
|
|
12
|
+
},
|
|
13
|
+
'integration-vscode': 'Visual Studio Code',
|
|
14
|
+
'integration-zed': 'Zed IDE',
|
|
15
|
+
'integration-jetbrains': 'JetBrains IDEs',
|
|
16
|
+
'integration-github-action': 'Github Actions',
|
|
17
|
+
'Code with Qwen Code': {
|
|
18
|
+
type: 'separator',
|
|
19
|
+
title: 'Code with Qwen Code', // Title is optional
|
|
20
|
+
},
|
|
21
|
+
features: 'Features',
|
|
22
|
+
configuration: 'Configuration',
|
|
23
|
+
extension: 'Extension',
|
|
24
|
+
reference: 'Reference',
|
|
25
|
+
support: 'Support',
|
|
26
|
+
// need refine
|
|
27
|
+
'ide-integration': {
|
|
28
|
+
display: 'hidden',
|
|
29
|
+
},
|
|
30
|
+
};
|