@studyllm/resume-preview 3.2.0 → 3.2.2

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 (3) hide show
  1. package/README.en.md +84 -65
  2. package/README.md +86 -64
  3. package/package.json +1 -1
package/README.en.md CHANGED
@@ -33,13 +33,9 @@ The module and interface inventory lives in [`docs/api-list.md`](docs/api-list.m
33
33
 
34
34
  ## 🚀 Quick Start
35
35
 
36
- > **Release status**: the npm package `@studyllm/resume-preview` is **published**.
37
- > Install it globally with `npm install -g @studyllm/resume-preview`; the plugin's `npx`
38
- > launcher is `npx -y @studyllm/resume-preview`. You can also clone the repository
39
- > `studyllm/resume-preview`, run `npm install && npm run build`, and wire it up with
40
- > the `.mcp.json` below.
36
+ The npm package `@studyllm/resume-preview` **is published**. Pick one of the three routes below — **except the plugin route, the other two need the npm package installed first**.
41
37
 
42
- **Plugin install (recommended)**
38
+ ### Route 1: Claude Code plugin (recommended)
43
39
 
44
40
  > **Type in Claude Code** — the two lines below are slash commands, not shell commands.
45
41
 
@@ -48,41 +44,103 @@ The module and interface inventory lives in [`docs/api-list.md`](docs/api-list.m
48
44
  /plugin install resume-preview@resume-preview
49
45
  ```
50
46
 
51
- Then restart Claude Code to activate the plugin.
47
+ Then restart Claude Code to activate the plugin. The MCP server is configured automatically — run `/mcp` in Claude Code and check that `resume-preview` shows up in the server list.
52
48
 
53
- **Install from source**
49
+ (The plugin launches the package through `npx`, so this route needs **no** global install.)
50
+
51
+ ### Route 2: Other MCP clients (Cursor / Codex / Windsurf / Cline / Gemini CLI …)
52
+
53
+ This server is optimized for Claude Code, but it works with any MCP-compatible client.
54
+
55
+ **Step 1 · Install it globally (required)**
54
56
 
55
57
  ```bash
56
- git clone https://github.com/studyllm/resume-preview.git
57
- cd resume-preview
58
- npm install && npm run build && npm install -g .
58
+ npm install -g @studyllm/resume-preview
59
59
  ```
60
60
 
61
- After a local checkout, connect it with a `.mcp.json` like this:
61
+ > ⚠️ **Do not skip this step.** The client launches the server through the `resume-preview` command on your PATH — without the package installed, the client reports "cannot connect" no matter how the configuration looks.
62
+
63
+ Check that the command really made it onto your PATH:
64
+
65
+ ```bash
66
+ resume-preview -v # should print a version like 3.2.1
67
+ ```
68
+
69
+ **Step 2 · Write the MCP configuration**
70
+
71
+ The configuration is the same for every client — add this to the client's MCP configuration file:
72
+
73
+ > **Your client's MCP configuration**
62
74
 
63
75
  ```json
64
76
  {
65
77
  "mcpServers": {
66
78
  "resume-preview": {
67
- "command": "node",
68
- "args": ["build/index.js"]
79
+ "command": "resume-preview"
69
80
  }
70
81
  }
71
82
  }
72
83
  ```
73
84
 
74
- **Verify the installation**
85
+ <details>
86
+ <summary><strong>Where each client keeps its configuration</strong></summary>
87
+
88
+ - **Codex** — `~/.codex/mcp_settings.json`
89
+ - **Cursor** — `.cursor/mcp.json`, or Settings (Cmd/Ctrl + ,) → MCP Servers
90
+ - **VSCode with [Cline extension](https://github.com/cline/cline)** — Settings (Cmd/Ctrl + ,) → search for "Cline MCP" → MCP Settings JSON
91
+ - **Windsurf** — macOS `~/Library/Application Support/Windsurf/mcp.json`; Linux `~/.config/windsurf/mcp.json`; Windows `%APPDATA%\Windsurf\mcp.json`
92
+ - **Gemini CLI** — `~/.gemini/mcp.json`
93
+
94
+ Every other MCP-compatible client uses the same configuration.
75
95
 
76
- Plugin install: the MCP server is configured automatically — just run `/mcp` in Claude Code and check that `resume-preview` shows up in the server list.
96
+ </details>
77
97
 
78
- Install from source: register it manually and check:
98
+ Three clients can also be configured from the command line:
79
99
 
80
100
  ```bash
81
101
  claude mcp add --scope user resume-preview resume-preview
102
+ codex mcp add resume-preview resume-preview
103
+ gemini config mcp add resume-preview --command resume-preview
104
+ ```
105
+
106
+ **Step 3 · Verify**
107
+
108
+ The client should now show `resume-preview` as connected. To check with Claude Code:
109
+
110
+ ```bash
82
111
  claude mcp list
83
112
  ```
84
113
 
85
- You should see `resume-preview: resume-preview - ✓ Connected`
114
+ It should print `resume-preview: resume-preview - ✓ Connected`.
115
+
116
+ **Note:** Some clients may require the full path to the executable:
117
+
118
+ - Find the path: `which resume-preview` (Unix/macOS) or `where resume-preview` (Windows)
119
+ - Use absolute path in config: `"command": "/path/to/resume-preview"`
120
+
121
+ ### Route 3: Install from source
122
+
123
+ ```bash
124
+ git clone https://github.com/studyllm/resume-preview.git
125
+ cd resume-preview
126
+ npm install && npm run build && npm install -g .
127
+ ```
128
+
129
+ After a local checkout, connect it with a `.mcp.json` like this (an absolute path is recommended):
130
+
131
+ ```json
132
+ {
133
+ "mcpServers": {
134
+ "resume-preview": {
135
+ "command": "node",
136
+ "args": ["/path/to/resume-preview/build/index.js"]
137
+ }
138
+ }
139
+ }
140
+ ```
141
+
142
+ That last `npm install -g .` also puts the `resume-preview` command on your PATH, so the
143
+ `"command": "resume-preview"` configuration from route 2 works just as well.
86
144
 
87
145
  ## 💡 Usage
88
146
 
@@ -161,51 +219,6 @@ A section that is missing from the content is left out of the page — it is nev
161
219
 
162
220
  The headings follow the resume's own `locale`, not the browser's: `en` gives the headings above, `zh-CN` gives 自我评价 / 工作经历 / 项目经历 / 教育经历 / 专业技能 / 其他. The exported document always comes out in the language you set, no matter who opens it.
163
221
 
164
- ## 🔌 Other MCP Client Configurations
165
-
166
- This server is optimized for Claude Code, but it works with any MCP-compatible client.
167
-
168
- The configuration is the same for every client — add this to the client's MCP configuration file:
169
-
170
- > **Your client's MCP configuration**
171
-
172
- ```json
173
- {
174
- "mcpServers": {
175
- "resume-preview": {
176
- "command": "resume-preview"
177
- }
178
- }
179
- }
180
- ```
181
-
182
- <details>
183
- <summary><strong>Where each client keeps its configuration</strong></summary>
184
-
185
- - **Codex** — `~/.codex/mcp_settings.json`
186
- - **Cursor** — `.cursor/mcp.json`, or Settings (Cmd/Ctrl + ,) → MCP Servers
187
- - **VSCode with [Cline extension](https://github.com/cline/cline)** — Settings (Cmd/Ctrl + ,) → search for "Cline MCP" → MCP Settings JSON
188
- - **Windsurf** — macOS `~/Library/Application Support/Windsurf/mcp.json`; Linux `~/.config/windsurf/mcp.json`; Windows `%APPDATA%\Windsurf\mcp.json`
189
- - **Gemini CLI** — `~/.gemini/mcp.json`
190
-
191
- Every other MCP-compatible client uses the same configuration.
192
-
193
- </details>
194
-
195
- Two clients can also be configured from the command line:
196
-
197
- ```bash
198
- codex mcp add resume-preview resume-preview
199
- gemini config mcp add resume-preview --command resume-preview
200
- ```
201
-
202
- The command `resume-preview` should be available in your PATH after installation.
203
-
204
- **Note:** Some clients may require the full path to the executable:
205
-
206
- - Find the path: `which resume-preview` (Unix/macOS) or `where resume-preview` (Windows)
207
- - Use absolute path in config: `"command": "/path/to/resume-preview"`
208
-
209
222
  ## 🎯 Live Reload
210
223
 
211
224
  1. **First render:** the resume opens in the browser at `http://localhost:3737/resume/<slug>`
@@ -260,13 +273,19 @@ npm start
260
273
 
261
274
  **The server is not connecting:**
262
275
 
276
+ The usual cause is **not installing the package globally** — the client cannot find the `resume-preview` command on your PATH:
277
+
263
278
  ```bash
264
- # Check if the server is installed
279
+ # Check that the command is installed and runs
265
280
  resume-preview -v
266
281
 
267
- # Reinstall if needed
282
+ # Install it if it is missing or does not run
268
283
  npm install -g @studyllm/resume-preview
284
+ ```
285
+
286
+ On Windows, also make sure npm's global directory (`%APPDATA%\npm` by default) is on your PATH. Use `where resume-preview` to find the absolute path and put it straight into the client configuration.
269
287
 
288
+ ```bash
270
289
  # Verify the MCP configuration
271
290
  claude mcp list
272
291
  ```
package/README.md CHANGED
@@ -33,12 +33,9 @@ MIT 许可证,兼容任何 MCP 客户端。
33
33
 
34
34
  ## 🚀 快速开始
35
35
 
36
- > **发布状态**:npm 包 `@studyllm/resume-preview` **已发布**。
37
- > 全局安装:`npm install -g @studyllm/resume-preview`;插件的 `npx` 启动方式为
38
- > `npx -y @studyllm/resume-preview`。也可克隆源码仓库 `studyllm/resume-preview` 后执行
39
- > `npm install && npm run build`,再按下面的 `.mcp.json` 接入 MCP 客户端。
36
+ npm 包 `@studyllm/resume-preview` **已发布**。下面三条路挑一条 —— **除了插件那条,另外两条都要先装 npm 包**。
40
37
 
41
- **插件安装(推荐)**
38
+ ### 方式一:Claude Code 插件(推荐)
42
39
 
43
40
  > **在 Claude Code 中输入** —— 下面两条是斜杠命令,不是 shell 命令。
44
41
 
@@ -47,41 +44,104 @@ MIT 许可证,兼容任何 MCP 客户端。
47
44
  /plugin install resume-preview@resume-preview
48
45
  ```
49
46
 
50
- 然后重启 Claude Code 以激活插件。
47
+ 然后重启 Claude Code 以激活插件。MCP 服务会自动配置好:在 Claude Code 里运行 `/mcp`,确认服务列表里出现 `resume-preview` 就行。
51
48
 
52
- **从源码安装**
49
+ (插件是用 `npx` 拉起这个包的,所以这一条路**不需要**你手动全局安装。)
50
+
51
+ ### 方式二:其他 MCP 客户端(Cursor / Codex / Windsurf / Cline / Gemini CLI …)
52
+
53
+ 这个服务是为 Claude Code 优化的,但任何兼容 MCP 的客户端都能用。
54
+
55
+ **第 1 步 · 全局安装(必做)**
53
56
 
54
57
  ```bash
55
- git clone https://github.com/studyllm/resume-preview.git
56
- cd resume-preview
57
- npm install && npm run build && npm install -g .
58
+ npm install -g @studyllm/resume-preview
58
59
  ```
59
60
 
60
- 本地检出后,用这样一份 `.mcp.json` 接入 MCP 客户端:
61
+ > ⚠️ **这一步不能跳。** 客户端是靠 PATH 上的 `resume-preview` 命令拉起服务的 —— 没装的话,
62
+ > 客户端连配置都对,也只会报「连接不上」。
63
+
64
+ 装完确认命令确实进了 PATH:
65
+
66
+ ```bash
67
+ resume-preview -v # 应输出类似 3.2.1 的版本号
68
+ ```
69
+
70
+ **第 2 步 · 写 MCP 配置**
71
+
72
+ 配置内容对所有客户端都一样 —— 把下面这段加进客户端的 MCP 配置文件:
73
+
74
+ > **客户端的 MCP 配置**
61
75
 
62
76
  ```json
63
77
  {
64
78
  "mcpServers": {
65
79
  "resume-preview": {
66
- "command": "node",
67
- "args": ["build/index.js"]
80
+ "command": "resume-preview"
68
81
  }
69
82
  }
70
83
  }
71
84
  ```
72
85
 
73
- **验证安装**
86
+ <details>
87
+ <summary><strong>各客户端的配置文件位置</strong></summary>
74
88
 
75
- 插件安装:MCP 服务会自动配置好,只需在 Claude Code 中运行 `/mcp`,确认服务列表里出现 `resume-preview`。
89
+ - **Codex** — `~/.codex/mcp_settings.json`
90
+ - **Cursor** — `.cursor/mcp.json`,或设置界面(Cmd/Ctrl + ,)→ MCP Servers
91
+ - **VSCode + [Cline 插件](https://github.com/cline/cline)** — 设置(Cmd/Ctrl + ,)→ 搜索 "Cline MCP" → MCP Settings JSON
92
+ - **Windsurf** — macOS `~/Library/Application Support/Windsurf/mcp.json`;Linux `~/.config/windsurf/mcp.json`;Windows `%APPDATA%\Windsurf\mcp.json`
93
+ - **Gemini CLI** — `~/.gemini/mcp.json`
76
94
 
77
- 从源码安装:需要手动注册并核对:
95
+ 其余兼容 MCP 的客户端也用上面那份标准配置。
96
+
97
+ </details>
98
+
99
+ 有三个客户端可以直接用命令行配置:
78
100
 
79
101
  ```bash
80
102
  claude mcp add --scope user resume-preview resume-preview
103
+ codex mcp add resume-preview resume-preview
104
+ gemini config mcp add resume-preview --command resume-preview
105
+ ```
106
+
107
+ **第 3 步 · 验证**
108
+
109
+ 客户端里应当能看到 `resume-preview` 已连接。用 Claude Code 核对的话:
110
+
111
+ ```bash
81
112
  claude mcp list
82
113
  ```
83
114
 
84
- 你应当看到 `resume-preview: resume-preview - ✓ Connected`
115
+ 会显示 `resume-preview: resume-preview - ✓ Connected`。
116
+
117
+ **注意:** 有些客户端要的是可执行文件的完整路径:
118
+
119
+ - 查路径:`which resume-preview`(Unix/macOS)或 `where resume-preview`(Windows)
120
+ - 在配置里用绝对路径:`"command": "/path/to/resume-preview"`
121
+
122
+ ### 方式三:从源码安装
123
+
124
+ ```bash
125
+ git clone https://github.com/studyllm/resume-preview.git
126
+ cd resume-preview
127
+ npm install && npm run build && npm install -g .
128
+ ```
129
+
130
+ 本地检出后,用这样一份 `.mcp.json` 接入 MCP 客户端(路径建议写绝对路径):
131
+
132
+ ```json
133
+ {
134
+ "mcpServers": {
135
+ "resume-preview": {
136
+ "command": "node",
137
+ "args": ["/path/to/resume-preview/build/index.js"]
138
+ }
139
+ }
140
+ }
141
+ ```
142
+
143
+ 最后那条 `npm install -g .` 会把 `resume-preview` 命令也装进 PATH,所以方式二里那份
144
+ `"command": "resume-preview"` 的配置同样适用。
85
145
 
86
146
  ## 💡 使用
87
147
 
@@ -160,51 +220,6 @@ claude mcp list
160
220
 
161
221
  标题跟随简历自身的 `locale`,而不是浏览器的:`zh-CN` 就是上面这些标题,`en` 则是 Summary → Experience → Projects → Education → Skills → Extras。导出的文档始终是你设定的那个语言,与谁打开它无关。
162
222
 
163
- ## 🔌 其他 MCP 客户端配置
164
-
165
- 这个服务是为 Claude Code 优化的,但任何兼容 MCP 的客户端都能用。
166
-
167
- 配置内容对所有客户端都是一样的 —— 把下面这段加进客户端的 MCP 配置文件:
168
-
169
- > **客户端的 MCP 配置**
170
-
171
- ```json
172
- {
173
- "mcpServers": {
174
- "resume-preview": {
175
- "command": "resume-preview"
176
- }
177
- }
178
- }
179
- ```
180
-
181
- <details>
182
- <summary><strong>各客户端的配置文件位置</strong></summary>
183
-
184
- - **Codex** — `~/.codex/mcp_settings.json`
185
- - **Cursor** — `.cursor/mcp.json`,或设置界面(Cmd/Ctrl + ,)→ MCP Servers
186
- - **VSCode + [Cline 插件](https://github.com/cline/cline)** — 设置(Cmd/Ctrl + ,)→ 搜索 "Cline MCP" → MCP Settings JSON
187
- - **Windsurf** — macOS `~/Library/Application Support/Windsurf/mcp.json`;Linux `~/.config/windsurf/mcp.json`;Windows `%APPDATA%\Windsurf\mcp.json`
188
- - **Gemini CLI** — `~/.gemini/mcp.json`
189
-
190
- 其余兼容 MCP 的客户端也用上面那份标准配置。
191
-
192
- </details>
193
-
194
- 有两个客户端可以直接用命令行配置:
195
-
196
- ```bash
197
- codex mcp add resume-preview resume-preview
198
- gemini config mcp add resume-preview --command resume-preview
199
- ```
200
-
201
- 安装之后,`resume-preview` 命令应当已经在你的 PATH 里。
202
-
203
- **注意:** 有些客户端要的是可执行文件的完整路径:
204
-
205
- - 查路径:`which resume-preview`(Unix/macOS)或 `where resume-preview`(Windows)
206
- - 在配置里用绝对路径:`"command": "/path/to/resume-preview"`
207
-
208
223
  ## 🎯 实时刷新
209
224
 
210
225
  1. **首次渲染:** 在浏览器打开 `http://localhost:3737/resume/<slug>`
@@ -259,13 +274,20 @@ npm start
259
274
 
260
275
  **服务连不上:**
261
276
 
277
+ 最常见的原因是**没做全局安装** —— 客户端在 PATH 上找不到 `resume-preview` 命令:
278
+
262
279
  ```bash
263
- # 确认服务已安装
280
+ # 确认命令已安装且能运行
264
281
  resume-preview -v
265
282
 
266
- # 需要的话重装
283
+ # 没有或跑不起来,就装上
267
284
  npm install -g @studyllm/resume-preview
285
+ ```
286
+
287
+ Windows 上还要确认 npm 的全局目录(默认 `%APPDATA%\npm`)在 PATH 里。用 `where resume-preview`
288
+ 查到绝对路径后,直接把它填进客户端配置即可。
268
289
 
290
+ ```bash
269
291
  # 核对 MCP 配置
270
292
  claude mcp list
271
293
  ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@studyllm/resume-preview",
3
- "version": "3.2.0",
3
+ "version": "3.2.2",
4
4
  "description": "MCP server for previewing and exporting resumes in Claude Code",
5
5
  "main": "build/index.js",
6
6
  "type": "module",