@mmmbuto/qwen-code-termux 0.13.1-termux → 0.14.1-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.
Files changed (79) hide show
  1. package/README.md +66 -157
  2. package/bundled/loop/SKILL.md +61 -0
  3. package/bundled/qc-helper/SKILL.md +151 -0
  4. package/bundled/qc-helper/docs/_meta.ts +30 -0
  5. package/bundled/qc-helper/docs/common-workflow.md +571 -0
  6. package/bundled/qc-helper/docs/configuration/_meta.ts +10 -0
  7. package/bundled/qc-helper/docs/configuration/auth.md +366 -0
  8. package/bundled/qc-helper/docs/configuration/memory.md +0 -0
  9. package/bundled/qc-helper/docs/configuration/model-providers.md +542 -0
  10. package/bundled/qc-helper/docs/configuration/qwen-ignore.md +55 -0
  11. package/bundled/qc-helper/docs/configuration/settings.md +664 -0
  12. package/bundled/qc-helper/docs/configuration/themes.md +160 -0
  13. package/bundled/qc-helper/docs/configuration/trusted-folders.md +61 -0
  14. package/bundled/qc-helper/docs/extension/_meta.ts +9 -0
  15. package/bundled/qc-helper/docs/extension/extension-releasing.md +204 -0
  16. package/bundled/qc-helper/docs/extension/getting-started-extensions.md +299 -0
  17. package/bundled/qc-helper/docs/extension/introduction.md +338 -0
  18. package/bundled/qc-helper/docs/features/_meta.ts +20 -0
  19. package/bundled/qc-helper/docs/features/approval-mode.md +263 -0
  20. package/bundled/qc-helper/docs/features/arena.md +218 -0
  21. package/bundled/qc-helper/docs/features/channels/_meta.ts +7 -0
  22. package/bundled/qc-helper/docs/features/channels/dingtalk.md +134 -0
  23. package/bundled/qc-helper/docs/features/channels/overview.md +336 -0
  24. package/bundled/qc-helper/docs/features/channels/plugins.md +87 -0
  25. package/bundled/qc-helper/docs/features/channels/telegram.md +120 -0
  26. package/bundled/qc-helper/docs/features/channels/weixin.md +106 -0
  27. package/bundled/qc-helper/docs/features/checkpointing.md +77 -0
  28. package/bundled/qc-helper/docs/features/commands.md +381 -0
  29. package/bundled/qc-helper/docs/features/followup-suggestions.md +109 -0
  30. package/bundled/qc-helper/docs/features/headless.md +318 -0
  31. package/bundled/qc-helper/docs/features/hooks.md +720 -0
  32. package/bundled/qc-helper/docs/features/language.md +139 -0
  33. package/bundled/qc-helper/docs/features/lsp.md +417 -0
  34. package/bundled/qc-helper/docs/features/mcp.md +281 -0
  35. package/bundled/qc-helper/docs/features/sandbox.md +241 -0
  36. package/bundled/qc-helper/docs/features/scheduled-tasks.md +139 -0
  37. package/bundled/qc-helper/docs/features/skills.md +289 -0
  38. package/bundled/qc-helper/docs/features/sub-agents.md +515 -0
  39. package/bundled/qc-helper/docs/features/token-caching.md +29 -0
  40. package/bundled/qc-helper/docs/ide-integration/_meta.ts +4 -0
  41. package/bundled/qc-helper/docs/ide-integration/ide-companion-spec.md +182 -0
  42. package/bundled/qc-helper/docs/ide-integration/ide-integration.md +144 -0
  43. package/bundled/qc-helper/docs/integration-github-action.md +241 -0
  44. package/bundled/qc-helper/docs/integration-jetbrains.md +81 -0
  45. package/bundled/qc-helper/docs/integration-vscode.md +39 -0
  46. package/bundled/qc-helper/docs/integration-zed.md +72 -0
  47. package/bundled/qc-helper/docs/overview.md +65 -0
  48. package/bundled/qc-helper/docs/quickstart.md +273 -0
  49. package/bundled/qc-helper/docs/reference/_meta.ts +3 -0
  50. package/bundled/qc-helper/docs/reference/keyboard-shortcuts.md +72 -0
  51. package/bundled/qc-helper/docs/support/Uninstall.md +42 -0
  52. package/bundled/qc-helper/docs/support/_meta.ts +6 -0
  53. package/bundled/qc-helper/docs/support/tos-privacy.md +112 -0
  54. package/bundled/qc-helper/docs/support/troubleshooting.md +123 -0
  55. package/bundled/review/SKILL.md +261 -0
  56. package/{dist/cli.js → cli.js} +91028 -57660
  57. package/locales/de.js +1976 -0
  58. package/locales/en.js +2016 -0
  59. package/locales/ja.js +1467 -0
  60. package/locales/pt.js +1966 -0
  61. package/locales/ru.js +1973 -0
  62. package/locales/zh.js +1820 -0
  63. package/package.json +33 -119
  64. package/scripts/postinstall.cjs +12 -0
  65. package/dist/bundled/review/SKILL.md +0 -123
  66. /package/{dist/sandbox-macos-permissive-closed.sb → sandbox-macos-permissive-closed.sb} +0 -0
  67. /package/{dist/sandbox-macos-permissive-open.sb → sandbox-macos-permissive-open.sb} +0 -0
  68. /package/{dist/sandbox-macos-permissive-proxied.sb → sandbox-macos-permissive-proxied.sb} +0 -0
  69. /package/{dist/sandbox-macos-restrictive-closed.sb → sandbox-macos-restrictive-closed.sb} +0 -0
  70. /package/{dist/sandbox-macos-restrictive-open.sb → sandbox-macos-restrictive-open.sb} +0 -0
  71. /package/{dist/sandbox-macos-restrictive-proxied.sb → sandbox-macos-restrictive-proxied.sb} +0 -0
  72. /package/{dist/vendor → vendor}/ripgrep/COPYING +0 -0
  73. /package/{dist/vendor → vendor}/ripgrep/arm64-darwin/rg +0 -0
  74. /package/{dist/vendor → vendor}/ripgrep/arm64-linux/rg +0 -0
  75. /package/{dist/vendor → vendor}/ripgrep/x64-darwin/rg +0 -0
  76. /package/{dist/vendor → vendor}/ripgrep/x64-linux/rg +0 -0
  77. /package/{dist/vendor → vendor}/ripgrep/x64-win32/rg.exe +0 -0
  78. /package/{dist/vendor → vendor}/tree-sitter/tree-sitter-bash.wasm +0 -0
  79. /package/{dist/vendor → vendor}/tree-sitter/tree-sitter.wasm +0 -0
package/README.md CHANGED
@@ -7,189 +7,124 @@
7
7
 
8
8
  **An open-source AI agent that lives in your terminal — Termux Edition (Android).**
9
9
 
10
- <a href="https://qwenlm.github.io/qwen-code-docs/zh/users/overview">中文</a> |
11
- <a href="https://qwenlm.github.io/qwen-code-docs/de/users/overview">Deutsch</a> |
12
- <a href="https://qwenlm.github.io/qwen-code-docs/fr/users/overview">français</a> |
13
- <a href="https://qwenlm.github.io/qwen-code-docs/ja/users/overview">日本語</a> |
14
- <a href="https://qwenlm.github.io/qwen-code-docs/ru/users/overview">Русский</a> |
15
- <a href="https://qwenlm.github.io/qwen-code-docs/pt-BR/users/overview">Português (Brasil)</a>
16
-
17
10
  </div>
18
11
 
19
- > 🎉 **News (2026-03-27)**: Termux Edition v0.13.1 is here! TTS notifications,
20
- > full upstream v0.13.1 sync, and a streamlined install experience on Android.
12
+ > News (2026-04-07): `v0.14.1-termux` is rebuilt from upstream `v0.14.1` on a clean history line for the Termux fork.
13
+
14
+ Qwen Code Termux is a clean fork of [QwenLM/qwen-code](https://github.com/QwenLM/qwen-code), rebuilt release-by-release from upstream and patched only where Android/Termux needs different behavior.
15
+
16
+ ## Why a Termux fork?
21
17
 
22
- Qwen Code is an open-source AI agent for the terminal, optimized for [Qwen3-Coder](https://github.com/QwenLM/Qwen3-Coder).
23
- This **Termux Edition** fork keeps upstream behaviour while fixing what breaks on Android/Termux.
18
+ Upstream targets desktop Unix and Windows first. On Android/Termux, the main breakpoints are:
24
19
 
25
- ## Why a Termux Edition?
20
+ - PTY availability on ARM64
21
+ - install-time scripts that are fine on desktop but noisy on Termux
22
+ - attention/notification workflows that are useful on mobile
26
23
 
27
- Upstream Qwen Code targets macOS/Linux/Windows. On Android/Termux, installs fail due to
28
- native dependency issues (PTY, node-gyp) and environment quirks.
24
+ This fork keeps upstream behavior as close as possible while adding:
29
25
 
30
- Termux Edition fixes:
26
+ - Android ARM64 PTY fallback via `@mmmbuto/node-pty-android-arm64`
27
+ - optional `tts_notification` tool backed by `termux-tts-speak`
28
+ - Termux environment detection for runtime-specific behavior
29
+ - release docs and test suites intended to be run directly inside Termux
31
30
 
32
- - **Android PTY support** via `@mmmbuto/pty-termux-utils`
33
- - **Termux runtime patches** (base64 polyfills, character encoding)
34
- - **Termux-safe install** (skips husky + sandbox bundle on npm install)
35
- - **TTS Notifications** — speak completion/alerts via `termux-tts-speak`
36
- - **Tested on-device** — see [test-reports/](test-reports/)
31
+ ## Installation
37
32
 
38
- ## Installation (Termux / Android)
33
+ ### Termux / Android
39
34
 
40
35
  ```bash
41
- # Requires: Termux (F-Droid), Node.js 20+
36
+ pkg install nodejs-lts
37
+ pkg install termux-api # optional, only for TTS
38
+
42
39
  npm install -g @mmmbuto/qwen-code-termux@latest
43
40
  qwen --version
44
41
  ```
45
42
 
46
- **Requirements:**
47
-
48
- - [Termux (F-Droid)](https://f-droid.org/packages/com.termux/) — Google Play version has issues
49
- - Node.js 20+ (`pkg install nodejs-lts`)
50
- - `termux-api` package (optional, for TTS): `pkg install termux-api`
43
+ Requirements:
51
44
 
52
- > **Not on Termux?** Use upstream instead:
53
- > `npm install -g @qwen-code/qwen-code@latest`
45
+ - [Termux from F-Droid](https://f-droid.org/packages/com.termux/)
46
+ - Node.js 20+
47
+ - `termux-api` only if you want TTS notifications
54
48
 
55
- ## Installation (Linux / macOS / Windows)
49
+ ### Non-Termux platforms
56
50
 
57
- For non-Termux platforms, use the official upstream:
51
+ Use upstream:
58
52
 
59
53
  ```bash
60
- # Linux / macOS
61
- bash -c "$(curl -fsSL https://qwen-code-assets.oss-cn-hangzhou.aliyuncs.com/installation/install-qwen.sh)"
62
-
63
- # Windows (Admin CMD)
64
- curl -fsSL -o %TEMP%\install-qwen.bat https://qwen-code-assets.oss-cn-hangzhou.aliyuncs.com/installation/install-qwen.bat && %TEMP%\install-qwen.bat
65
- ```
66
-
67
- Or via Homebrew:
68
-
69
- ```bash
70
- brew install qwen-code
54
+ npm install -g @qwen-code/qwen-code@latest
71
55
  ```
72
56
 
73
57
  ## Quick Start
74
58
 
75
59
  ```bash
76
- cd your-project/
60
+ cd your-project
77
61
  qwen
78
-
79
- # Then inside the session:
80
- /help
81
- /auth
82
62
  ```
83
63
 
84
- On first use, you'll be prompted to sign in. Run `/auth` anytime to switch auth method.
64
+ Useful first commands:
85
65
 
86
- Example prompts:
87
-
88
- ```text
89
- What does this project do?
90
- Explain the codebase structure.
91
- Help me refactor this function.
92
- Generate unit tests for this module.
93
- ```
66
+ - `/help`
67
+ - `/auth`
68
+ - `/model`
94
69
 
95
70
  ## Authentication
96
71
 
97
- Two methods API-KEY is recommended for headless/Termux environments.
98
-
99
- ### API-KEY (recommended)
72
+ For headless or Termux-heavy workflows, API-key auth is the practical default.
100
73
 
101
- Set up `~/.qwen/settings.json`:
74
+ Example `~/.qwen/settings.json`:
102
75
 
103
76
  ```json
104
77
  {
105
78
  "modelProviders": {
106
79
  "openai": [
107
80
  {
108
- "id": "qwen3.5-plus",
109
- "name": "qwen3.5-plus",
110
- "baseUrl": "https://dashscope.aliyuncs.com/compatible-mode/v1"
81
+ "id": "qwen3.6-plus",
82
+ "name": "qwen3.6-plus",
83
+ "baseUrl": "https://dashscope.aliyuncs.com/compatible-mode/v1",
84
+ "description": "Qwen via DashScope OpenAI-compatible API",
85
+ "envKey": "DASHSCOPE_API_KEY"
111
86
  }
112
87
  ]
113
88
  },
114
89
  "env": {
115
90
  "DASHSCOPE_API_KEY": "sk-your-key"
116
91
  },
117
- "security": { "auth": { "selectedType": "openai" } },
118
- "model": { "name": "qwen3.5-plus" }
92
+ "security": {
93
+ "auth": {
94
+ "selectedType": "openai"
95
+ }
96
+ },
97
+ "model": {
98
+ "name": "qwen3.6-plus"
99
+ }
119
100
  }
120
101
  ```
121
102
 
122
- ### Qwen OAuth
103
+ OAuth still works where a browser is available, but API-key auth is the safer recommendation on Termux and over SSH.
123
104
 
124
- ```bash
125
- qwen
126
- /auth
127
- # Complete browser flow
128
- ```
129
-
130
- > OAuth requires a browser — not available over SSH/headless. Use API-KEY instead.
105
+ ## Termux-specific features
131
106
 
132
- ## Usage
107
+ ### TTS notifications
133
108
 
134
- ### Interactive mode
109
+ If `termux-api` is installed, the fork exposes a `tts_notification` tool that can speak short alerts:
135
110
 
136
111
  ```bash
137
- qwen
138
- # Use @ to reference files: @src/main.ts
112
+ termux-tts-speak "Qwen Code Termux ready"
139
113
  ```
140
114
 
141
- ### Headless mode
115
+ ### PTY fallback
142
116
 
143
- ```bash
144
- qwen -p "your question"
145
- ```
117
+ The fork keeps upstream PTY loading first, then falls back to `@mmmbuto/node-pty-android-arm64` for Android ARM64.
146
118
 
147
- ### Session commands
119
+ ### Release testing from Termux
148
120
 
149
- | Command | Description |
150
- | ----------- | ------------------------------- |
151
- | `/help` | Available commands |
152
- | `/clear` | Clear history |
153
- | `/compress` | Compress history to save tokens |
154
- | `/stats` | Session info |
155
- | `/bug` | Submit bug report |
156
- | `/exit` | Quit |
121
+ Run the documented Termux release checks from:
157
122
 
158
- ### Keyboard shortcuts
123
+ - [docs/developers/BUILDING.md](docs/developers/BUILDING.md)
124
+ - [test-reports/README.md](test-reports/README.md)
125
+ - [test-reports/suites/latest/termux.md](test-reports/suites/latest/termux.md)
159
126
 
160
- - `Ctrl+C` Cancel operation
161
- - `Ctrl+D` — Exit (empty line)
162
- - `Up/Down` — Command history
163
-
164
- ## Termux-Specific Features
165
-
166
- ### TTS Notifications
167
-
168
- When a task completes or needs your attention, Qwen Code can speak a notification
169
- using Android's text-to-speech engine:
170
-
171
- ```bash
172
- # Install termux-api for TTS
173
- pkg install termux-api
174
-
175
- # TTS is used automatically by the tts_notification tool
176
- ```
177
-
178
- ### PTY Support
179
-
180
- Shell execution uses a PTY (pseudo-terminal) for proper ANSI colour and interactive
181
- command support. On Termux, PTY deps are auto-installed on first `npm install`.
182
-
183
- ### Runtime Patches
184
-
185
- | File | Purpose |
186
- | --------------------------------------------- | ------------------------------ |
187
- | `packages/core/src/patches/termux-runtime.ts` | Android base64 polyfill |
188
- | `scripts/prepare-termux.cjs` | Skip husky + bundle on Termux |
189
- | `scripts/postinstall.cjs` | Termux install confirmation |
190
- | `packages/core/src/utils/termux-detect.ts` | `isTermux()` detection utility |
191
-
192
- ## Building from Source
127
+ ## Building from source
193
128
 
194
129
  ```bash
195
130
  git clone https://github.com/DioNanos/qwen-code-termux.git
@@ -197,47 +132,21 @@ cd qwen-code-termux
197
132
  npm install
198
133
  npm run build
199
134
  npm run bundle
200
-
201
- # Install globally
202
- npm install -g
203
135
  ```
204
136
 
205
- See [docs/developers/BUILDING.md](docs/developers/BUILDING.md) for full details.
206
-
207
- ## Configuration
208
-
209
- | File | Scope | Description |
210
- | ----------------------- | ------- | ----------------------------- |
211
- | `~/.qwen/settings.json` | User | Global settings (recommended) |
212
- | `.qwen/settings.json` | Project | Project-level overrides |
213
-
214
- See the [authentication guide](https://qwenlm.github.io/qwen-code-docs/en/users/configuration/auth/) for all options.
215
-
216
- > **Security note:** Never commit API keys to version control.
137
+ See [docs/developers/BUILDING.md](docs/developers/BUILDING.md) for the fork-specific notes.
217
138
 
218
139
  ## Troubleshooting
219
140
 
220
- - [Qwen Code docs](https://qwenlm.github.io/qwen-code-docs/en/users/support/troubleshooting/)
221
- - From the CLI: run `/bug` for a bug report template
222
- - [Test reports](test-reports/) Termux-specific test results
223
-
224
- ## Ecosystem
225
-
226
- - [**AionUi**](https://github.com/iOfficeAI/AionUi) — Modern GUI for Qwen Code
227
- - [**Gemini CLI Desktop**](https://github.com/Piebald-AI/gemini-cli-desktop) — Cross-platform desktop UI
228
-
229
- ## Connect
230
-
231
- - [Discord](https://discord.gg/RN7tqZCeDK)
232
- - [Dingtalk](https://qr.dingtalk.com/action/joingroup?code=v1,k1,+FX6Gf/ZDlTahTIRi8AEQhIaBlqykA0j+eBKKdhLeAE=&_dt_no_comment=1&origin=1)
141
+ - If you are not on Termux, install upstream instead of this fork.
142
+ - If shell execution is broken on Android, verify the PTY dependency is present.
143
+ - If TTS does nothing, install `termux-api` and check `termux-tts-speak`.
144
+ - For release validation, use the Termux suite in [test-reports/suites/latest/termux.md](test-reports/suites/latest/termux.md).
233
145
 
234
146
  ## Acknowledgments
235
147
 
236
- This project is based on [Google Gemini CLI](https://github.com/google-gemini/gemini-cli) and
237
- [Qwen Code](https://github.com/QwenLM/qwen-code). We acknowledge and appreciate the excellent
238
- work of both teams. This fork focuses on Termux/Android compatibility and Termux-specific
239
- features.
148
+ This fork is based on [Qwen Code](https://github.com/QwenLM/qwen-code) and exists to keep a release-quality Termux track with minimal divergence from upstream.
240
149
 
241
150
  ## License
242
151
 
243
- Apache-2.0 — see [LICENSE](./LICENSE)
152
+ Apache-2.0
@@ -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
+ };