agent-reader 1.1.6 → 1.1.8

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 (2) hide show
  1. package/README.md +25 -10
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -37,26 +37,32 @@ AI Agent 擅长生成内容,但输出的 Markdown 对普通人不友好。Agen
37
37
 
38
38
  ## 📦 安装
39
39
 
40
+ 需要 Node.js 18+,终端输入 `node -v` 检查,没有去 https://nodejs.org 下载。
41
+
42
+ > AI Agent(如 Claude Code)帮你安装时,请优先使用方式一,避免权限和 PATH 问题。
43
+
44
+ ### 方式一:npx 免安装(推荐,零配置)
45
+
40
46
  ```bash
41
- npm install -g agent-reader
47
+ npx agent-reader doctor # 验证环境
48
+ npx agent-reader open README.md # 立刻看到漂亮网页
42
49
  ```
43
50
 
44
- 不想全局安装?用 npx 直接跑:
51
+ 不需要全局安装,不会遇到权限和 PATH 问题,拿来就用。
52
+
53
+ ### 方式二:全局安装
45
54
 
46
55
  ```bash
47
- npx agent-reader render 你的文件.md
56
+ npm install -g agent-reader
48
57
  ```
49
58
 
50
- 验证:`agent-reader doctor`,全是 ✓ 就装好了。
51
-
52
- 需要 Node.js 18+,终端输入 `node -v` 检查,没有去 https://nodejs.org 下载。
59
+ 安装后验证:`agent-reader doctor`,全是 ✓ 就装好了。
53
60
 
54
61
  > 开发模式:clone 仓库后 `npm install && npm link`
55
62
 
56
- <details>
57
- <summary>⚠️ Mac 遇到权限错误?</summary>
63
+ 遇到问题?以下是两个最常见的坑:
58
64
 
59
- 如果 `npm install -g` 报 `EACCES` 权限错误,有两种解法:
65
+ **权限错误(EACCES)**
60
66
 
61
67
  ```bash
62
68
  # 方法 1:加 sudo(简单粗暴)
@@ -70,7 +76,16 @@ source ~/.zshrc
70
76
  npm install -g agent-reader
71
77
  ```
72
78
 
73
- </details>
79
+ **安装成功但 command not found**
80
+
81
+ npm 全局 bin 目录不在 PATH 中。先查路径,再加到 shell 配置:
82
+
83
+ ```bash
84
+ npm bin -g # 查看 npm 全局 bin 路径
85
+ # 把输出的路径加到 ~/.zshrc 或 ~/.bashrc,例如:
86
+ echo 'export PATH=$(npm bin -g):$PATH' >> ~/.zshrc
87
+ source ~/.zshrc
88
+ ```
74
89
 
75
90
  ---
76
91
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "agent-reader",
3
- "version": "1.1.6",
3
+ "version": "1.1.8",
4
4
  "description": "AI Agent 的文档美化引擎 — 一键把 Markdown 变成漂亮网页、Word、PDF 和幻灯片",
5
5
  "main": "index.js",
6
6
  "directories": {