@protolabsai/proto 0.14.0
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 +203 -0
- package/README.md +286 -0
- package/dist/bundled/adversarial-verification/SKILL.md +98 -0
- package/dist/bundled/brainstorming/SKILL.md +171 -0
- package/dist/bundled/coding-agent-standards/SKILL.md +67 -0
- package/dist/bundled/dispatching-parallel-agents/SKILL.md +193 -0
- package/dist/bundled/executing-plans/SKILL.md +77 -0
- package/dist/bundled/finishing-a-development-branch/SKILL.md +213 -0
- package/dist/bundled/loop/SKILL.md +61 -0
- package/dist/bundled/qc-helper/SKILL.md +151 -0
- package/dist/bundled/qc-helper/docs/_meta.ts +30 -0
- package/dist/bundled/qc-helper/docs/common-workflow.md +571 -0
- package/dist/bundled/qc-helper/docs/configuration/_meta.ts +10 -0
- package/dist/bundled/qc-helper/docs/configuration/auth.md +366 -0
- package/dist/bundled/qc-helper/docs/configuration/memory.md +0 -0
- package/dist/bundled/qc-helper/docs/configuration/model-providers.md +542 -0
- package/dist/bundled/qc-helper/docs/configuration/qwen-ignore.md +55 -0
- package/dist/bundled/qc-helper/docs/configuration/settings.md +652 -0
- package/dist/bundled/qc-helper/docs/configuration/themes.md +160 -0
- package/dist/bundled/qc-helper/docs/configuration/trusted-folders.md +61 -0
- package/dist/bundled/qc-helper/docs/extension/_meta.ts +9 -0
- package/dist/bundled/qc-helper/docs/extension/extension-releasing.md +121 -0
- package/dist/bundled/qc-helper/docs/extension/getting-started-extensions.md +299 -0
- package/dist/bundled/qc-helper/docs/extension/introduction.md +303 -0
- package/dist/bundled/qc-helper/docs/features/_meta.ts +18 -0
- package/dist/bundled/qc-helper/docs/features/approval-mode.md +263 -0
- package/dist/bundled/qc-helper/docs/features/arena.md +218 -0
- package/dist/bundled/qc-helper/docs/features/checkpointing.md +77 -0
- package/dist/bundled/qc-helper/docs/features/commands.md +312 -0
- package/dist/bundled/qc-helper/docs/features/headless.md +318 -0
- package/dist/bundled/qc-helper/docs/features/hooks.md +343 -0
- package/dist/bundled/qc-helper/docs/features/language.md +139 -0
- package/dist/bundled/qc-helper/docs/features/lsp.md +453 -0
- package/dist/bundled/qc-helper/docs/features/mcp.md +281 -0
- package/dist/bundled/qc-helper/docs/features/sandbox.md +241 -0
- package/dist/bundled/qc-helper/docs/features/scheduled-tasks.md +139 -0
- package/dist/bundled/qc-helper/docs/features/skills.md +289 -0
- package/dist/bundled/qc-helper/docs/features/sub-agents.md +307 -0
- package/dist/bundled/qc-helper/docs/features/token-caching.md +29 -0
- package/dist/bundled/qc-helper/docs/ide-integration/_meta.ts +4 -0
- package/dist/bundled/qc-helper/docs/ide-integration/ide-companion-spec.md +182 -0
- package/dist/bundled/qc-helper/docs/ide-integration/ide-integration.md +144 -0
- package/dist/bundled/qc-helper/docs/integration-github-action.md +241 -0
- package/dist/bundled/qc-helper/docs/integration-jetbrains.md +81 -0
- package/dist/bundled/qc-helper/docs/integration-vscode.md +39 -0
- package/dist/bundled/qc-helper/docs/integration-zed.md +72 -0
- package/dist/bundled/qc-helper/docs/overview.md +64 -0
- package/dist/bundled/qc-helper/docs/quickstart.md +273 -0
- package/dist/bundled/qc-helper/docs/reference/_meta.ts +4 -0
- package/dist/bundled/qc-helper/docs/reference/keyboard-shortcuts.md +72 -0
- package/dist/bundled/qc-helper/docs/reference/sdk-api.md +524 -0
- package/dist/bundled/qc-helper/docs/support/Uninstall.md +42 -0
- package/dist/bundled/qc-helper/docs/support/_meta.ts +6 -0
- package/dist/bundled/qc-helper/docs/support/tos-privacy.md +112 -0
- package/dist/bundled/qc-helper/docs/support/troubleshooting.md +123 -0
- package/dist/bundled/receiving-code-review/SKILL.md +226 -0
- package/dist/bundled/requesting-code-review/SKILL.md +115 -0
- package/dist/bundled/review/SKILL.md +123 -0
- package/dist/bundled/subagent-driven-development/SKILL.md +292 -0
- package/dist/bundled/subagent-driven-development/code-quality-reviewer-prompt.md +27 -0
- package/dist/bundled/subagent-driven-development/implementer-prompt.md +113 -0
- package/dist/bundled/subagent-driven-development/spec-reviewer-prompt.md +61 -0
- package/dist/bundled/systematic-debugging/SKILL.md +305 -0
- package/dist/bundled/test-driven-development/SKILL.md +396 -0
- package/dist/bundled/using-git-worktrees/SKILL.md +223 -0
- package/dist/bundled/using-superpowers/SKILL.md +117 -0
- package/dist/bundled/verification-before-completion/SKILL.md +147 -0
- package/dist/bundled/writing-plans/SKILL.md +159 -0
- package/dist/bundled/writing-skills/SKILL.md +716 -0
- package/dist/cli.js +483432 -0
- package/dist/sandbox-macos-permissive-closed.sb +32 -0
- package/dist/sandbox-macos-permissive-open.sb +27 -0
- package/dist/sandbox-macos-permissive-proxied.sb +37 -0
- package/dist/sandbox-macos-restrictive-closed.sb +93 -0
- package/dist/sandbox-macos-restrictive-open.sb +96 -0
- package/dist/sandbox-macos-restrictive-proxied.sb +98 -0
- package/dist/vendor/ripgrep/COPYING +3 -0
- package/dist/vendor/ripgrep/arm64-darwin/rg +0 -0
- package/dist/vendor/ripgrep/arm64-linux/rg +0 -0
- package/dist/vendor/ripgrep/x64-darwin/rg +0 -0
- package/dist/vendor/ripgrep/x64-linux/rg +0 -0
- package/dist/vendor/ripgrep/x64-win32/rg.exe +0 -0
- package/dist/vendor/tree-sitter/tree-sitter-bash.wasm +0 -0
- package/dist/vendor/tree-sitter/tree-sitter.wasm +0 -0
- package/package.json +143 -0
|
@@ -0,0 +1,213 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: finishing-a-development-branch
|
|
3
|
+
description: Use when implementation is complete, all tests pass, and you need to decide how to integrate the work - guides completion of development work by presenting structured options for merge, PR, or cleanup
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Finishing a Development Branch
|
|
7
|
+
|
|
8
|
+
## Overview
|
|
9
|
+
|
|
10
|
+
Guide completion of development work by presenting clear options and handling chosen workflow.
|
|
11
|
+
|
|
12
|
+
**Core principle:** Verify tests → Present options → Execute choice → Clean up.
|
|
13
|
+
|
|
14
|
+
**Announce at start:** "I'm using the finishing-a-development-branch skill to complete this work."
|
|
15
|
+
|
|
16
|
+
## The Process
|
|
17
|
+
|
|
18
|
+
### Step 1: Verify Tests
|
|
19
|
+
|
|
20
|
+
**Before presenting options, verify tests pass:**
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
# Run project's test suite
|
|
24
|
+
npm test / cargo test / pytest / go test ./...
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
**If tests fail:**
|
|
28
|
+
|
|
29
|
+
```
|
|
30
|
+
Tests failing (<N> failures). Must fix before completing:
|
|
31
|
+
|
|
32
|
+
[Show failures]
|
|
33
|
+
|
|
34
|
+
Cannot proceed with merge/PR until tests pass.
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
Stop. Don't proceed to Step 2.
|
|
38
|
+
|
|
39
|
+
**If tests pass:** Continue to Step 2.
|
|
40
|
+
|
|
41
|
+
### Step 2: Determine Base Branch
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
# Try common base branches
|
|
45
|
+
git merge-base HEAD main 2>/dev/null || git merge-base HEAD master 2>/dev/null
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
Or ask: "This branch split from main - is that correct?"
|
|
49
|
+
|
|
50
|
+
### Step 3: Present Options
|
|
51
|
+
|
|
52
|
+
Present exactly these 4 options:
|
|
53
|
+
|
|
54
|
+
```
|
|
55
|
+
Implementation complete. What would you like to do?
|
|
56
|
+
|
|
57
|
+
1. Merge back to <base-branch> locally
|
|
58
|
+
2. Push and create a Pull Request
|
|
59
|
+
3. Keep the branch as-is (I'll handle it later)
|
|
60
|
+
4. Discard this work
|
|
61
|
+
|
|
62
|
+
Which option?
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
**Don't add explanation** - keep options concise.
|
|
66
|
+
|
|
67
|
+
### Step 4: Execute Choice
|
|
68
|
+
|
|
69
|
+
#### Option 1: Merge Locally
|
|
70
|
+
|
|
71
|
+
```bash
|
|
72
|
+
# Switch to base branch
|
|
73
|
+
git checkout <base-branch>
|
|
74
|
+
|
|
75
|
+
# Pull latest
|
|
76
|
+
git pull
|
|
77
|
+
|
|
78
|
+
# Merge feature branch
|
|
79
|
+
git merge <feature-branch>
|
|
80
|
+
|
|
81
|
+
# Verify tests on merged result
|
|
82
|
+
<test command>
|
|
83
|
+
|
|
84
|
+
# If tests pass
|
|
85
|
+
git branch -d <feature-branch>
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
Then: Cleanup worktree (Step 5)
|
|
89
|
+
|
|
90
|
+
#### Option 2: Push and Create PR
|
|
91
|
+
|
|
92
|
+
```bash
|
|
93
|
+
# Push branch
|
|
94
|
+
git push -u origin <feature-branch>
|
|
95
|
+
|
|
96
|
+
# Create PR
|
|
97
|
+
gh pr create --title "<title>" --body "$(cat <<'EOF'
|
|
98
|
+
## Summary
|
|
99
|
+
<2-3 bullets of what changed>
|
|
100
|
+
|
|
101
|
+
## Test Plan
|
|
102
|
+
- [ ] <verification steps>
|
|
103
|
+
EOF
|
|
104
|
+
)"
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
Then: Cleanup worktree (Step 5)
|
|
108
|
+
|
|
109
|
+
#### Option 3: Keep As-Is
|
|
110
|
+
|
|
111
|
+
Report: "Keeping branch <name>. Worktree preserved at <path>."
|
|
112
|
+
|
|
113
|
+
**Don't cleanup worktree.**
|
|
114
|
+
|
|
115
|
+
#### Option 4: Discard
|
|
116
|
+
|
|
117
|
+
**Confirm first:**
|
|
118
|
+
|
|
119
|
+
```
|
|
120
|
+
This will permanently delete:
|
|
121
|
+
- Branch <name>
|
|
122
|
+
- All commits: <commit-list>
|
|
123
|
+
- Worktree at <path>
|
|
124
|
+
|
|
125
|
+
Type 'discard' to confirm.
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
Wait for exact confirmation.
|
|
129
|
+
|
|
130
|
+
If confirmed:
|
|
131
|
+
|
|
132
|
+
```bash
|
|
133
|
+
git checkout <base-branch>
|
|
134
|
+
git branch -D <feature-branch>
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
Then: Cleanup worktree (Step 5)
|
|
138
|
+
|
|
139
|
+
### Step 5: Cleanup Worktree
|
|
140
|
+
|
|
141
|
+
**For Options 1, 2, 4:**
|
|
142
|
+
|
|
143
|
+
Check if in worktree:
|
|
144
|
+
|
|
145
|
+
```bash
|
|
146
|
+
git worktree list | grep $(git branch --show-current)
|
|
147
|
+
```
|
|
148
|
+
|
|
149
|
+
If yes:
|
|
150
|
+
|
|
151
|
+
```bash
|
|
152
|
+
git worktree remove <worktree-path>
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
**For Option 3:** Keep worktree.
|
|
156
|
+
|
|
157
|
+
## Quick Reference
|
|
158
|
+
|
|
159
|
+
| Option | Merge | Push | Keep Worktree | Cleanup Branch |
|
|
160
|
+
| ---------------- | ----- | ---- | ------------- | -------------- |
|
|
161
|
+
| 1. Merge locally | ✓ | - | - | ✓ |
|
|
162
|
+
| 2. Create PR | - | ✓ | ✓ | - |
|
|
163
|
+
| 3. Keep as-is | - | - | ✓ | - |
|
|
164
|
+
| 4. Discard | - | - | - | ✓ (force) |
|
|
165
|
+
|
|
166
|
+
## Common Mistakes
|
|
167
|
+
|
|
168
|
+
**Skipping test verification**
|
|
169
|
+
|
|
170
|
+
- **Problem:** Merge broken code, create failing PR
|
|
171
|
+
- **Fix:** Always verify tests before offering options
|
|
172
|
+
|
|
173
|
+
**Open-ended questions**
|
|
174
|
+
|
|
175
|
+
- **Problem:** "What should I do next?" → ambiguous
|
|
176
|
+
- **Fix:** Present exactly 4 structured options
|
|
177
|
+
|
|
178
|
+
**Automatic worktree cleanup**
|
|
179
|
+
|
|
180
|
+
- **Problem:** Remove worktree when might need it (Option 2, 3)
|
|
181
|
+
- **Fix:** Only cleanup for Options 1 and 4
|
|
182
|
+
|
|
183
|
+
**No confirmation for discard**
|
|
184
|
+
|
|
185
|
+
- **Problem:** Accidentally delete work
|
|
186
|
+
- **Fix:** Require typed "discard" confirmation
|
|
187
|
+
|
|
188
|
+
## Red Flags
|
|
189
|
+
|
|
190
|
+
**Never:**
|
|
191
|
+
|
|
192
|
+
- Proceed with failing tests
|
|
193
|
+
- Merge without verifying tests on result
|
|
194
|
+
- Delete work without confirmation
|
|
195
|
+
- Force-push without explicit request
|
|
196
|
+
|
|
197
|
+
**Always:**
|
|
198
|
+
|
|
199
|
+
- Verify tests before offering options
|
|
200
|
+
- Present exactly 4 options
|
|
201
|
+
- Get typed confirmation for Option 4
|
|
202
|
+
- Clean up worktree for Options 1 & 4 only
|
|
203
|
+
|
|
204
|
+
## Integration
|
|
205
|
+
|
|
206
|
+
**Called by:**
|
|
207
|
+
|
|
208
|
+
- **subagent-driven-development** (Step 7) - After all tasks complete
|
|
209
|
+
- **executing-plans** (Step 5) - After all batches complete
|
|
210
|
+
|
|
211
|
+
**Pairs with:**
|
|
212
|
+
|
|
213
|
+
- **using-git-worktrees** - Cleans up worktree created by that skill
|
|
@@ -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
|
+
};
|