devcoach 0.3.54
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 +201 -0
- package/README.md +386 -0
- package/assets/SKILL.md +630 -0
- package/assets/static/favicon.svg +3 -0
- package/assets/static/relative-time.js +24 -0
- package/assets/static/style.css +164 -0
- package/assets/static/vendor/alpinejs.min.js +5 -0
- package/assets/static/vendor/flatpickr-dark.min.css +795 -0
- package/assets/static/vendor/flatpickr.min.css +13 -0
- package/assets/static/vendor/flatpickr.min.js +2 -0
- package/assets/static/vendor/highlight.min.js +1232 -0
- package/assets/static/vendor/hljs-dark.min.css +1 -0
- package/assets/static/vendor/hljs-light.min.css +1 -0
- package/assets/static/vendor/htmx.min.js +1 -0
- package/assets/static/vendor/icons/bitbucket.svg +1 -0
- package/assets/static/vendor/icons/github.svg +1 -0
- package/assets/static/vendor/icons/gitlab.svg +1 -0
- package/assets/static/vendor/icons/vscode.svg +41 -0
- package/assets/static/vendor/marked.min.js +6 -0
- package/assets/static/vendor/tailwind.js +83 -0
- package/assets/static/vscode.svg +41 -0
- package/dist/bin.js +580 -0
- package/package.json +69 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright 2026 UltimaPhoenix (https://github.com/UltimaPhoenix)
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,386 @@
|
|
|
1
|
+
# devcoach
|
|
2
|
+
|
|
3
|
+
[](https://www.npmjs.com/package/devcoach)
|
|
4
|
+
[](https://github.com/UltimaPhoenix/dev-coach/actions/workflows/ci.yml)
|
|
5
|
+
[](https://nodejs.org/)
|
|
6
|
+
[](LICENSE)
|
|
7
|
+
|
|
8
|
+
**Progressive technical coaching that lives inside your AI agent.** devcoach connects to Claude Code, Claude Desktop, Cursor, Windsurf, and other MCP-compatible tools. After every task you complete, it delivers a short targeted lesson calibrated to what you already know — no generic tutorials, no repeated topics, nothing to open.
|
|
9
|
+
|
|
10
|
+
Everything runs **locally**. No data leaves your machine. One SQLite file at `~/.devcoach/coaching.db`.
|
|
11
|
+
|
|
12
|
+
> Built on the official [Model Context Protocol TypeScript SDK](https://github.com/modelcontextprotocol/typescript-sdk), Node's embedded `node:sqlite`, [Hono](https://hono.dev) (web dashboard), and [Commander](https://github.com/tj/commander.js) (CLI). Requires **Node.js ≥ 24**.
|
|
13
|
+
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
## How it works
|
|
17
|
+
|
|
18
|
+
```mermaid
|
|
19
|
+
flowchart TD
|
|
20
|
+
A([Task completed]) --> B[Check rate limit]
|
|
21
|
+
B -->|denied| Z([Silent])
|
|
22
|
+
B -->|allowed| D
|
|
23
|
+
|
|
24
|
+
subgraph loop["coaching loop"]
|
|
25
|
+
D[Select topic & depth]
|
|
26
|
+
E[Compose & deliver]
|
|
27
|
+
G[log_lesson]
|
|
28
|
+
end
|
|
29
|
+
|
|
30
|
+
D -->|nothing| Z
|
|
31
|
+
D -->|found| E
|
|
32
|
+
E --> G
|
|
33
|
+
G --> F([Done])
|
|
34
|
+
G -.->|prompts| U(["You: ✅ ❌ ⏭"])
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
→ [Full decision flow: session startup · lesson selection · depth calibration](docs/how-it-works.md)
|
|
38
|
+
|
|
39
|
+
---
|
|
40
|
+
|
|
41
|
+
## Get started in 2 steps
|
|
42
|
+
|
|
43
|
+
### Step 1 — Install
|
|
44
|
+
|
|
45
|
+
| Method | Command | Requirements |
|
|
46
|
+
|--------|---------|--------------|
|
|
47
|
+
| **npx** (no install) | _(used directly in the MCP config below)_ | Node.js ≥ 24 |
|
|
48
|
+
| **npm** (global) | `npm install -g devcoach` | Node.js ≥ 24 |
|
|
49
|
+
| **Desktop Extension** (`.mcpb`) | one-click — see below | Claude Desktop (bundles its own Node) |
|
|
50
|
+
|
|
51
|
+
The recommended path is **npx** — no global install, always the latest version, used directly in your agent's MCP config.
|
|
52
|
+
|
|
53
|
+
<details>
|
|
54
|
+
<summary><strong>Claude Desktop one-click extension</strong> (<code>.mcpb</code>)</summary>
|
|
55
|
+
|
|
56
|
+
Claude Desktop installs devcoach from a single bundle — no Node or terminal needed (it runs on Desktop's
|
|
57
|
+
bundled runtime). Build the bundle and install it:
|
|
58
|
+
|
|
59
|
+
```bash
|
|
60
|
+
npm run mcpb # → dist-mcpb/devcoach-<version>.mcpb
|
|
61
|
+
# Claude Desktop → Settings → Extensions → Install Extension… → pick the .mcpb
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
`npm run mcpb:sign` self-signs it (installs as an *unverified publisher*; a real code-signing cert is
|
|
65
|
+
needed for a verified signature). Prebuilt `.mcpb` releases and a Desktop directory listing are planned.
|
|
66
|
+
|
|
67
|
+
</details>
|
|
68
|
+
|
|
69
|
+
### Step 2 — Connect to your AI agent
|
|
70
|
+
|
|
71
|
+
```bash
|
|
72
|
+
npx -y devcoach install
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
This registers devcoach as an MCP server and sets up automatic lesson delivery. Restart your agent after running.
|
|
76
|
+
|
|
77
|
+
<details>
|
|
78
|
+
<summary><strong>Connect to other agents</strong> (Cursor, Windsurf, Cline, Continue, Zed…)</summary>
|
|
79
|
+
|
|
80
|
+
Add this to your agent's MCP config file:
|
|
81
|
+
|
|
82
|
+
```json
|
|
83
|
+
{
|
|
84
|
+
"mcpServers": {
|
|
85
|
+
"devcoach": {
|
|
86
|
+
"command": "npx",
|
|
87
|
+
"args": ["-y", "devcoach", "mcp"]
|
|
88
|
+
}
|
|
89
|
+
}
|
|
90
|
+
}
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
| Agent | Config file |
|
|
94
|
+
|-------|-------------|
|
|
95
|
+
| **Cursor** | `~/.cursor/mcp.json` |
|
|
96
|
+
| **Windsurf** | `~/.codeium/windsurf/mcp_config.json` |
|
|
97
|
+
| **Cline** (VS Code) | VS Code Settings → `cline.mcpServers` |
|
|
98
|
+
| **Continue.dev** | `~/.continue/config.json` → `mcpServers` |
|
|
99
|
+
| **Zed** | `.zed/settings.json` → `context_servers` |
|
|
100
|
+
|
|
101
|
+
> Stop hooks (automatic lesson delivery after each task) are Claude Code-specific. Other agents have full access to all MCP tools and resources — coaching can be triggered manually or by prompting your agent.
|
|
102
|
+
|
|
103
|
+
</details>
|
|
104
|
+
|
|
105
|
+
<details>
|
|
106
|
+
<summary><strong>Manual setup</strong> (if <code>devcoach install</code> is not available)</summary>
|
|
107
|
+
|
|
108
|
+
#### Claude Code
|
|
109
|
+
|
|
110
|
+
**Option A — via the `claude mcp` CLI (recommended):**
|
|
111
|
+
|
|
112
|
+
```bash
|
|
113
|
+
claude mcp add devcoach npx -- -y devcoach mcp
|
|
114
|
+
|
|
115
|
+
# all projects (user scope)
|
|
116
|
+
claude mcp add --scope user devcoach npx -- -y devcoach mcp
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
**Option B — edit `~/.claude.json` directly:**
|
|
120
|
+
|
|
121
|
+
```json
|
|
122
|
+
{ "mcpServers": { "devcoach": { "type": "stdio", "command": "npx", "args": ["-y", "devcoach", "mcp"] } } }
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
Then add the Stop hooks to `~/.claude/settings.json`:
|
|
126
|
+
|
|
127
|
+
```json
|
|
128
|
+
{
|
|
129
|
+
"hooks": {
|
|
130
|
+
"Stop": [
|
|
131
|
+
{ "hooks": [{ "type": "command", "command": "npx -y devcoach onboard-hook" }] },
|
|
132
|
+
{ "hooks": [{ "type": "command", "command": "npx -y devcoach lesson-ready" }] }
|
|
133
|
+
]
|
|
134
|
+
}
|
|
135
|
+
}
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
> Tip: a global install (`npm i -g devcoach`) lets you drop the `npx -y` prefix and use `devcoach` directly in every command above.
|
|
139
|
+
|
|
140
|
+
#### Claude Desktop
|
|
141
|
+
|
|
142
|
+
Edit the config file for your platform:
|
|
143
|
+
|
|
144
|
+
| Platform | Config file |
|
|
145
|
+
|----------|-------------|
|
|
146
|
+
| macOS | `~/Library/Application Support/Claude/claude_desktop_config.json` |
|
|
147
|
+
| Windows | `%APPDATA%\Claude\claude_desktop_config.json` |
|
|
148
|
+
| Linux | `~/.config/Claude/claude_desktop_config.json` |
|
|
149
|
+
|
|
150
|
+
```json
|
|
151
|
+
{
|
|
152
|
+
"mcpServers": {
|
|
153
|
+
"devcoach": {
|
|
154
|
+
"command": "npx",
|
|
155
|
+
"args": ["-y", "devcoach", "mcp"]
|
|
156
|
+
}
|
|
157
|
+
}
|
|
158
|
+
}
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
#### Claude.ai web (skill copy)
|
|
162
|
+
|
|
163
|
+
Claude.ai does not support MCP servers. Install the coaching instructions as a skill instead:
|
|
164
|
+
|
|
165
|
+
1. Copy the content of [`assets/SKILL.md`](assets/SKILL.md)
|
|
166
|
+
2. Go to **claude.ai → Settings → Custom instructions** (or Skills, depending on your plan)
|
|
167
|
+
3. Paste the content and save
|
|
168
|
+
|
|
169
|
+
This gives claude.ai the coaching behaviour without the MCP tools (lesson logging and profile tracking will not work).
|
|
170
|
+
|
|
171
|
+
> **Keep the skill up to date.** For Claude Code / Claude Desktop, the skill is served automatically via the MCP prompt and is always current. If you copied it manually to Claude.ai, re-paste the latest `SKILL.md` after each devcoach update.
|
|
172
|
+
|
|
173
|
+
</details>
|
|
174
|
+
|
|
175
|
+
---
|
|
176
|
+
|
|
177
|
+
## Onboarding
|
|
178
|
+
|
|
179
|
+
The first time your agent connects to devcoach it detects that your profile isn't set up and walks you through it inline — no separate command needed.
|
|
180
|
+
|
|
181
|
+
### Phase 1 — Choose how to set up your profile
|
|
182
|
+
|
|
183
|
+
```
|
|
184
|
+
devcoach: Your knowledge profile isn't set up yet.
|
|
185
|
+
|
|
186
|
+
Do you have an existing devcoach backup to restore?
|
|
187
|
+
If yes, provide the file path — otherwise I'll help you build your profile from scratch.
|
|
188
|
+
```
|
|
189
|
+
|
|
190
|
+
**Option A — restore from backup:** If you're on a new machine or reinstalling, provide the path to your backup zip and your full profile (knowledge map, lessons, settings) is imported instantly.
|
|
191
|
+
|
|
192
|
+
**Option B — build from scratch:** Choose between automatic detection or a guided conversation.
|
|
193
|
+
|
|
194
|
+
### Phase 2 — Build your profile
|
|
195
|
+
|
|
196
|
+
#### Automatic (recommended)
|
|
197
|
+
|
|
198
|
+
devcoach scans your project files and proposes your stack:
|
|
199
|
+
|
|
200
|
+
```
|
|
201
|
+
I detected these technologies in your project:
|
|
202
|
+
|
|
203
|
+
typescript → confidence 6 (keep? or enter 0–10 to adjust)
|
|
204
|
+
docker → confidence 7 (keep? or enter 0–10 to adjust)
|
|
205
|
+
github_actions → confidence 6 (keep? or enter 0–10 to adjust)
|
|
206
|
+
react → confidence 5 (keep? or enter 0–10 to adjust)
|
|
207
|
+
|
|
208
|
+
Anything I missed? List any tools, languages, or practices you work with regularly.
|
|
209
|
+
```
|
|
210
|
+
|
|
211
|
+
You confirm, adjust scores, or add topics the scan missed. Then devcoach proposes logical groups:
|
|
212
|
+
|
|
213
|
+
```
|
|
214
|
+
Here's how I'd organise these:
|
|
215
|
+
|
|
216
|
+
Languages → typescript, javascript
|
|
217
|
+
Frontend → react, html_css
|
|
218
|
+
DevOps → docker, github_actions
|
|
219
|
+
Databases → postgresql, redis
|
|
220
|
+
|
|
221
|
+
Does this look right? Any changes?
|
|
222
|
+
```
|
|
223
|
+
|
|
224
|
+
#### Guided conversation
|
|
225
|
+
|
|
226
|
+
If you prefer to describe your stack manually, devcoach asks about each technology and your confidence level (1–3 still learning · 4–6 comfortable · 7–9 strong · 10 expert), then saves the profile.
|
|
227
|
+
|
|
228
|
+
### Phase 3 — Profile saved, coaching begins
|
|
229
|
+
|
|
230
|
+
```
|
|
231
|
+
✓ Profile saved — 24 topics across 6 groups.
|
|
232
|
+
|
|
233
|
+
From now on I'll deliver a short lesson after technical tasks,
|
|
234
|
+
calibrated to your current confidence on each topic.
|
|
235
|
+
```
|
|
236
|
+
|
|
237
|
+
That's it. You go back to work. Coaching happens silently in the background.
|
|
238
|
+
|
|
239
|
+
---
|
|
240
|
+
|
|
241
|
+
## Your first lesson
|
|
242
|
+
|
|
243
|
+
You work on a task as normal. After your agent responds, devcoach appends a lesson:
|
|
244
|
+
|
|
245
|
+
```
|
|
246
|
+
You: Refactor this endpoint to handle concurrent requests properly.
|
|
247
|
+
|
|
248
|
+
Agent: [refactors the code, explains the changes]
|
|
249
|
+
|
|
250
|
+
---
|
|
251
|
+
🎓 devcoach · TypeScript · Level: Mid
|
|
252
|
+
|
|
253
|
+
**Promise.allSettled vs Promise.all — don't let one failure sink the batch**
|
|
254
|
+
|
|
255
|
+
Promise.all rejects the moment any promise rejects, and you lose the results of
|
|
256
|
+
the ones that already succeeded. For independent work (fan-out fetches, batch
|
|
257
|
+
writes) that's usually the wrong default.
|
|
258
|
+
|
|
259
|
+
Promise.allSettled always resolves, giving you a status for every promise:
|
|
260
|
+
|
|
261
|
+
const results = await Promise.allSettled(ids.map(fetchUser));
|
|
262
|
+
const ok = results.filter(r => r.status === "fulfilled").map(r => r.value);
|
|
263
|
+
|
|
264
|
+
Use Promise.all when the tasks are genuinely all-or-nothing; reach for
|
|
265
|
+
allSettled when partial success is meaningful and you want to report failures.
|
|
266
|
+
|
|
267
|
+
💡 Senior tip: for coordinated work that *should* cancel siblings on failure,
|
|
268
|
+
an AbortController shared across the requests gives you all-or-nothing with
|
|
269
|
+
prompt cancellation — the structured-concurrency middle ground.
|
|
270
|
+
|
|
271
|
+
Did that land? ✅ know · ❌ don't know · ⏭ skip
|
|
272
|
+
```
|
|
273
|
+
|
|
274
|
+
Responding adjusts your confidence on that topic and shapes future lessons.
|
|
275
|
+
|
|
276
|
+
---
|
|
277
|
+
|
|
278
|
+
## Screenshots
|
|
279
|
+
|
|
280
|
+
| Knowledge map | Lesson history | Settings |
|
|
281
|
+
|:---------------------------------------------------------:|:---:|:---:|
|
|
282
|
+
|  |  |  |
|
|
283
|
+
|
|
284
|
+
---
|
|
285
|
+
|
|
286
|
+
## Web dashboard
|
|
287
|
+
|
|
288
|
+
Open the dashboard at any time to review your progress, edit your profile, or manage settings:
|
|
289
|
+
|
|
290
|
+
```bash
|
|
291
|
+
npx -y devcoach ui # → http://localhost:7860
|
|
292
|
+
```
|
|
293
|
+
|
|
294
|
+
| Page | What you can do |
|
|
295
|
+
|------|-----------------|
|
|
296
|
+
| **Knowledge map** | See all topics with confidence bars; adjust scores directly |
|
|
297
|
+
| **Lessons** | Browse and filter your full lesson history; star lessons to revisit |
|
|
298
|
+
| **Settings** | Change rate limits, import/export your profile, take a backup |
|
|
299
|
+
|
|
300
|
+
Full reference: [docs/web-ui.md](docs/web-ui.md)
|
|
301
|
+
|
|
302
|
+
---
|
|
303
|
+
|
|
304
|
+
## CLI reference
|
|
305
|
+
|
|
306
|
+
The CLI is a secondary interface for querying and managing your coaching data. Everything is also available in the [web dashboard](#web-dashboard). Run `devcoach --help` or `devcoach <command> --help` for full usage.
|
|
307
|
+
|
|
308
|
+
| Command | Description |
|
|
309
|
+
|---------|-------------|
|
|
310
|
+
| `devcoach install` | Register with Claude Code / Claude Desktop |
|
|
311
|
+
| `devcoach profile` | Show your knowledge map with confidence bars |
|
|
312
|
+
| `devcoach stats` | Overview: lesson counts, weakest/strongest topics |
|
|
313
|
+
| `devcoach lessons` | Browse lesson history with filters |
|
|
314
|
+
| `devcoach lesson <id>` | Show a single lesson in full |
|
|
315
|
+
| `devcoach star <id>` | Mark a lesson as starred |
|
|
316
|
+
| `devcoach feedback <id> <know\|dont_know\|clear>` | Record comprehension |
|
|
317
|
+
| `devcoach set max_per_day <n>` | Max lessons per day (default 2) |
|
|
318
|
+
| `devcoach set min_gap_minutes <n>` | Minutes between lessons (default 240) |
|
|
319
|
+
| `devcoach backup [file.zip]` | Export knowledge + lessons + settings |
|
|
320
|
+
| `devcoach restore <file.zip>` | Restore from a backup |
|
|
321
|
+
| `devcoach setup` | Run the onboarding wizard in the terminal |
|
|
322
|
+
| `devcoach ui` | Open the web dashboard |
|
|
323
|
+
|
|
324
|
+
(Prefix with `npx -y` if you haven't installed globally.) Full reference: [docs/cli.md](docs/cli.md)
|
|
325
|
+
|
|
326
|
+
---
|
|
327
|
+
|
|
328
|
+
## Configuration
|
|
329
|
+
|
|
330
|
+
```bash
|
|
331
|
+
devcoach set max_per_day 3 # up to 3 lessons per day
|
|
332
|
+
devcoach set min_gap_minutes 120 # at least 2 hours between lessons
|
|
333
|
+
```
|
|
334
|
+
|
|
335
|
+
Settings are stored in `~/.devcoach/coaching.db`. See [docs/configuration.md](docs/configuration.md) for all options.
|
|
336
|
+
|
|
337
|
+
---
|
|
338
|
+
|
|
339
|
+
## Uninstallation
|
|
340
|
+
|
|
341
|
+
```bash
|
|
342
|
+
npm uninstall -g devcoach # if installed globally (npx: nothing to remove)
|
|
343
|
+
claude mcp remove devcoach # remove from Claude Code
|
|
344
|
+
rm -rf ~/.devcoach # delete all coaching data (back up first: devcoach backup)
|
|
345
|
+
```
|
|
346
|
+
|
|
347
|
+
For Claude Desktop, delete the `devcoach` key from the platform config file (paths in **Manual setup** above). Also remove the two hook entries from `~/.claude/settings.json` → `hooks.Stop`.
|
|
348
|
+
|
|
349
|
+
---
|
|
350
|
+
|
|
351
|
+
## Development
|
|
352
|
+
|
|
353
|
+
```bash
|
|
354
|
+
git clone https://github.com/UltimaPhoenix/dev-coach && cd dev-coach
|
|
355
|
+
npm install
|
|
356
|
+
npm run dev -- mcp # run the MCP server from source
|
|
357
|
+
npm run dev -- ui # run the web dashboard from source
|
|
358
|
+
npm run lint && npm run typecheck && npm test
|
|
359
|
+
npm run build # tsup → dist/bin.js
|
|
360
|
+
npm run mcpb # build the Claude Desktop .mcpb (npm run mcpb:sign to self-sign)
|
|
361
|
+
```
|
|
362
|
+
|
|
363
|
+
- **MCP Inspector:** `npx @modelcontextprotocol/inspector node dist/bin.js mcp`
|
|
364
|
+
- **Stack:** `@modelcontextprotocol/sdk` · `node:sqlite` · Hono · Commander · Zod · Biome · Vitest · tsup
|
|
365
|
+
|
|
366
|
+
### Publishing a release
|
|
367
|
+
|
|
368
|
+
Tag a commit with `v*`:
|
|
369
|
+
|
|
370
|
+
```bash
|
|
371
|
+
git tag v1.2.3 && git push origin v1.2.3
|
|
372
|
+
```
|
|
373
|
+
|
|
374
|
+
CI lints, type-checks, tests (Node 24 & 26), builds, and publishes to npm via **OIDC provenance**
|
|
375
|
+
(`npm publish --provenance`). First-time setup: configure a Trusted Publisher on npmjs.com for the
|
|
376
|
+
`devcoach` package (GitHub Actions, repo `UltimaPhoenix/dev-coach`, workflow `ci.yml`).
|
|
377
|
+
|
|
378
|
+
---
|
|
379
|
+
|
|
380
|
+
## License
|
|
381
|
+
|
|
382
|
+
Copyright 2026 [UltimaPhoenix](https://github.com/UltimaPhoenix)
|
|
383
|
+
|
|
384
|
+
Licensed under the [Apache License, Version 2.0](LICENSE). Free to use, modify, and distribute;
|
|
385
|
+
commercial use and modifications must retain the license, copyright, and attribution notices and state
|
|
386
|
+
any changes. You may not use the `devcoach` name or branding to endorse derived products without permission.
|