copilot.tools 1.0.0 → 1.0.1
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 +36 -122
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -9,7 +9,7 @@ Cross-platform — works on Windows, macOS, and Linux.
|
|
|
9
9
|
## What's inside
|
|
10
10
|
|
|
11
11
|
```
|
|
12
|
-
copilot.
|
|
12
|
+
copilot.tools/
|
|
13
13
|
├── _list_sessions.js # Internal: reads Copilot session database
|
|
14
14
|
├── package.json # npm package config
|
|
15
15
|
├── tools-install.js # Cross-platform installer (copies skills globally)
|
|
@@ -29,7 +29,7 @@ copilot.history/
|
|
|
29
29
|
1. Open a terminal (Windows PowerShell, Command Prompt, macOS Terminal, or Linux shell).
|
|
30
30
|
2. Run:
|
|
31
31
|
```bash
|
|
32
|
-
npm install -g copilot.
|
|
32
|
+
npm install -g copilot.tools
|
|
33
33
|
```
|
|
34
34
|
|
|
35
35
|
### Verify Installation
|
|
@@ -106,86 +106,6 @@ An interactive code-teaching quiz that randomly selects real snippets from your
|
|
|
106
106
|
- **Spec** (`teach me spec`) — Spec-to-code traceability using office docs as source.
|
|
107
107
|
- **BA-Gates** (`teach me ba`) — BA documentation quality analysis (ambiguity, AC completeness, edge case coverage).
|
|
108
108
|
|
|
109
|
-
**Examples:**
|
|
110
|
-
- `/teach-me` — Standard code quiz, passive mode
|
|
111
|
-
- `/teach-me level 4` — Difficulty 4, standard theme
|
|
112
|
-
- `/teach-me python interactive` — Python code, edit mode
|
|
113
|
-
- `/teach-me solid` — SOLID anti-pattern restoration, passive
|
|
114
|
-
- `/teach-me spec interactive` — Spec↔code traceability, edit mode
|
|
115
|
-
- `/teach-me ba level 2` — BA documentation quality, difficulty 2
|
|
116
|
-
|
|
117
|
-
**Mid-session commands:** `hint` · `skip` · `next` · `level 3` · `easier` · `harder` · `interactive` · `passive` · `done` · `stop`
|
|
118
|
-
|
|
119
|
-
**Difficulty levels:**
|
|
120
|
-
|
|
121
|
-
| Level | Line range | What you'll face |
|
|
122
|
-
|-------|-----------|-------────────|
|
|
123
|
-
| 1 | 5–15 | Straight-line logic, if/else, basic function calls |
|
|
124
|
-
| 2 | 8–20 | Loops, list/dict operations, simple try/except |
|
|
125
|
-
| 3 | 12–30 | Comprehensions, decorators, with statements, multiple branches |
|
|
126
|
-
| 4 | 18–45 | Generators, async/await, descriptors, threading, closures |
|
|
127
|
-
| 5 | 25–55 | Metaclasses, complex async patterns, multi-threading, architectural glue |
|
|
128
|
-
|
|
129
|
-
**In SOLID theme:** the model rewrites code with deliberate anti-patterns (STUPID, WET, god objects, tight coupling), presents the degraded code, and you restore good design.
|
|
130
|
-
|
|
131
|
-
**In Spec theme:** the model scans your office documents (`.docx`, `.pptx`, `.xlsx`) and source code, then quizzes you on the correlation between them. Each round randomly picks one direction — either "what code implements this spec?" or "what spec does this code satisfy?"
|
|
132
|
-
|
|
133
|
-
**In BA-Gates theme:** the model analyzes your BA documentation files (`.docx`, `.pptx`, `.xlsx`, `.md`, `.feature`, `.txt`) against three quality gates: **Ambiguity**, **Acceptance Criteria Completeness**, and **Edge Case Coverage**. You identify which gates a fragment violates and describe the developer impact.
|
|
134
|
-
|
|
135
|
-
## Requirements
|
|
136
|
-
|
|
137
|
-
- **Node.js** (version 14 or later) — for the installer and session history lookup
|
|
138
|
-
- **VS Code** (latest version)
|
|
139
|
-
- **GitHub Copilot extension** — installed and authenticated
|
|
140
|
-
- **LLM credits/API key** — configured in your Copilot settings (enterprise or personal)
|
|
141
|
-
|
|
142
|
-
## Troubleshooting
|
|
143
|
-
|
|
144
|
-
### Skills not showing up in Copilot
|
|
145
|
-
|
|
146
|
-
1. Verify installation: Check that `~/.copilot/skills/` exists with 4 subdirectories.
|
|
147
|
-
2. Restart VS Code completely (not just the Copilot chat panel).
|
|
148
|
-
3. In Copilot chat, type `/` to see if skills appear in autocomplete.
|
|
149
|
-
|
|
150
|
-
### `/history` shows "No sessions found"
|
|
151
|
-
|
|
152
|
-
This is normal for a fresh Copilot install. Start a new chat session in Copilot, then run `/history` again — it will show the new session.
|
|
153
|
-
|
|
154
|
-
### `/teach-me` can't find code in my project
|
|
155
|
-
|
|
156
|
-
Make sure your project files are open in the VS Code workspace. The quiz needs access to the actual code files to select snippets.
|
|
157
|
-
|
|
158
|
-
## Contact & License
|
|
159
|
-
|
|
160
|
-
Developer: [species8472](mailto:swyuri@yahoo.com)
|
|
161
|
-
|
|
162
|
-
Copyright © 2026 Celestial Consulting Ltd. Licensed under the [GNU Affero General Public License v3.0](LICENSE).
|
|
163
|
-
repos — especially folders full of Office documents (`.docx`, `.pptx`, `.xlsx`,
|
|
164
|
-
`.pdf`) that an AI agent is about to edit. Before every file modification,
|
|
165
|
-
snapshot saves a timestamped copy into `_snapshots/` so you can always get back
|
|
166
|
-
to the pre-AI version:
|
|
167
|
-
|
|
168
|
-
```
|
|
169
|
-
report.docx → _snapshots/report.2026-06-21_14-30-00.docx
|
|
170
|
-
```
|
|
171
|
-
|
|
172
|
-
If the workspace already has a `.git` directory, snapshot politely declines —
|
|
173
|
-
Git already has your back.
|
|
174
|
-
|
|
175
|
-
### `//teach-me`
|
|
176
|
-
An interactive code-teaching quiz that randomly selects real snippets from your
|
|
177
|
-
current project. Two independent dimensions across five difficulty levels:
|
|
178
|
-
|
|
179
|
-
**Response mode** (how you answer):
|
|
180
|
-
- **Passive** (default) — Describe your answer in the console.
|
|
181
|
-
- **Interactive** (`teach me interactive`) — Edit the actual file, say `done`.
|
|
182
|
-
|
|
183
|
-
**Content theme** (what it's about):
|
|
184
|
-
- **Standard** (default) — Code comprehension or line reconstruction.
|
|
185
|
-
- **SOLID** (`teach me solid`) — Anti-pattern detection and design restoration.
|
|
186
|
-
- **Spec** (`teach me spec`) — Spec-to-code traceability using office docs as source.
|
|
187
|
-
- **BA-Gates** (`teach me ba`) — BA documentation quality analysis (ambiguity, AC completeness, edge case coverage).
|
|
188
|
-
|
|
189
109
|
| Trigger | Response | Theme | What happens |
|
|
190
110
|
|---------|----------|-------|-------------|
|
|
191
111
|
| `teach me` | passive | standard | Present code; you explain it |
|
|
@@ -197,8 +117,7 @@ current project. Two independent dimensions across five difficulty levels:
|
|
|
197
117
|
| `teach me ba` | passive | ba-gates | BA doc fragment; you identify quality gate violations |
|
|
198
118
|
| `teach me ba interactive` | interactive | ba-gates | BA doc with issues; you edit to fix them |
|
|
199
119
|
|
|
200
|
-
**Triggers:** `teach me` · `quiz me` · `test my knowledge` · `code quiz` ·
|
|
201
|
-
`drill me`
|
|
120
|
+
**Triggers:** `teach me` · `quiz me` · `test my knowledge` · `code quiz` · `drill me`
|
|
202
121
|
|
|
203
122
|
**Modifiers (combine freely):**
|
|
204
123
|
|
|
@@ -223,46 +142,41 @@ current project. Two independent dimensions across five difficulty levels:
|
|
|
223
142
|
| 4 | 18–45 | Generators, `async`/`await`, descriptors, threading, closures |
|
|
224
143
|
| 5 | 25–55 | Metaclasses, complex async patterns, multi-threading, architectural glue |
|
|
225
144
|
|
|
226
|
-
**Mid-round commands:** `hint` (get a nudge) · `skip` (see the answer) ·
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
**
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
(
|
|
235
|
-
restore good design. Files are always restored with `git checkout` after each
|
|
236
|
-
round.
|
|
237
|
-
|
|
238
|
-
In **Spec theme**: the model scans your office documents (`.docx`, `.pptx`,
|
|
239
|
-
`.xlsx`) and source code, then quizzes you on the correlation between them.
|
|
240
|
-
Each round randomly picks one direction — either "what code implements this
|
|
241
|
-
spec?" or "what spec does this code satisfy?" — testing whether you truly
|
|
242
|
-
understand how requirements map to implementation. In interactive mode, you
|
|
243
|
-
edit the code to satisfy the spec; in passive mode, you describe the link.
|
|
244
|
-
|
|
245
|
-
In **BA-Gates theme**: the model runs a two-pass analysis over your BA documentation
|
|
246
|
-
files (`.docx`, `.pptx`, `.xlsx`, `.md`, `.feature`, `.txt`). Pass 1 uses regex
|
|
247
|
-
triage to flag fragments against three quality gates — **Ambiguity**
|
|
248
|
-
(unmeasurable terms, passive states), **Acceptance Criteria Completeness**
|
|
249
|
-
(missing structure, unverifiable outcomes), and **Edge Case Coverage** (missing
|
|
250
|
-
negative scenarios, error states). Pass 2 runs an LLM interpretation per
|
|
251
|
-
fragment at round time to generate quiz material and concrete improvement
|
|
252
|
-
options. You identify which gates a fragment triggers and describe the developer
|
|
253
|
-
impact. On skip or strike-3, the model presents 2–3 domain-specific rewrites per
|
|
254
|
-
issue with a best-fit recommendation.
|
|
255
|
-
|
|
256
|
-
## Want to take this further
|
|
257
|
-
If you've enjoyed using //teach-me and want to audit your entire specification repository and get a formatted report with readiness scores, band distributions, and ranked improvement recommendations, check out our licensed product //spec-analysis. Contact the developer for more info.
|
|
145
|
+
**Mid-round commands:** `hint` (get a nudge) · `skip` (see the answer) · `next` (draw a new snippet) · `level N` · `easier` · `harder` · `interactive` · `passive` · `solid` · `spec` · `ba` · `done` (verify work) · `stop`
|
|
146
|
+
|
|
147
|
+
**At the end** you get a session summary: rounds completed, mode, files covered, what you're strong on, what to review, and a suggested next level.
|
|
148
|
+
|
|
149
|
+
In **SOLID theme**: the model rewrites code with deliberate anti-patterns (STUPID, WET, god objects, tight coupling), presents the degraded code, and you restore good design. Files are always restored with `git checkout` after each round.
|
|
150
|
+
|
|
151
|
+
In **Spec theme**: the model scans your office documents (`.docx`, `.pptx`, `.xlsx`) and source code, then quizzes you on the correlation between them. Each round randomly picks one direction — either "what code implements this spec?" or "what spec does this code satisfy?" — testing whether you truly understand how requirements map to implementation. In interactive mode, you edit the code to satisfy the spec; in passive mode, you describe the link.
|
|
152
|
+
|
|
153
|
+
In **BA-Gates theme**: the model runs a two-pass analysis over your BA documentation files (`.docx`, `.pptx`, `.xlsx`, `.md`, `.feature`, `.txt`). Pass 1 uses regex triage to flag fragments against three quality gates — **Ambiguity** (unmeasurable terms, passive states), **Acceptance Criteria Completeness** (missing structure, unverifiable outcomes), and **Edge Case Coverage** (missing negative scenarios, error states). Pass 2 runs an LLM interpretation per fragment at round time to generate quiz material and concrete improvement options. You identify which gates a fragment triggers and describe the developer impact. On skip or strike-3, the model presents 2–3 domain-specific rewrites per issue with a best-fit recommendation.
|
|
258
154
|
|
|
259
155
|
## Requirements
|
|
260
|
-
- Node.js (for the `codewhale-history` command)
|
|
261
|
-
- [CodeWhale](https://codewhale.net/en/docs) — install from [codewhale.net](https://codewhale.net/en/docs)
|
|
262
|
-
- An API key for your preferred LLM provider (configured in CodeWhale settings)
|
|
263
156
|
|
|
264
|
-
|
|
265
|
-
|
|
157
|
+
- **Node.js** (version 14 or later) — for the installer and session history lookup
|
|
158
|
+
- **VS Code** (latest version)
|
|
159
|
+
- **GitHub Copilot extension** — installed and authenticated
|
|
160
|
+
- **LLM credits/API key** — configured in your Copilot settings (enterprise or personal)
|
|
161
|
+
|
|
162
|
+
## Troubleshooting
|
|
163
|
+
|
|
164
|
+
### Skills not showing up in Copilot
|
|
165
|
+
|
|
166
|
+
1. Verify installation: Check that `~/.copilot/skills/` exists with 4 subdirectories.
|
|
167
|
+
2. Restart VS Code completely (not just the Copilot chat panel).
|
|
168
|
+
3. In Copilot chat, type `/` to see if skills appear in autocomplete.
|
|
169
|
+
|
|
170
|
+
### `/history` shows "No sessions found"
|
|
171
|
+
|
|
172
|
+
This is normal for a fresh Copilot install. Start a new chat session in Copilot, then run `/history` again — it will show the new session.
|
|
173
|
+
|
|
174
|
+
### `/teach-me` can't find code in my project
|
|
175
|
+
|
|
176
|
+
Make sure your project files are open in the VS Code workspace. The quiz needs access to the actual code files to select snippets.
|
|
177
|
+
|
|
178
|
+
## Contact & License
|
|
179
|
+
|
|
180
|
+
Developer: [species8472](mailto:swyuri@yahoo.com)
|
|
266
181
|
|
|
267
|
-
---
|
|
268
182
|
Copyright © 2026 Celestial Consulting Ltd. Licensed under the [GNU Affero General Public License v3.0](LICENSE).
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "copilot.tools",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.1",
|
|
4
4
|
"description": "Copilot skills: /tools, /history, /snapshot, /teach-me — session tracking, file snapshots, interactive code quiz — global install",
|
|
5
5
|
"bin": {
|
|
6
6
|
"copilot-history": "./_list_sessions.js",
|