docs: beginner-friendly install guide — plain-language steps per app, FAQ for non-technical users
Browse files
README.md
CHANGED
|
@@ -65,16 +65,81 @@ agentlens install
|
|
| 65 |
| Windsurf | 规则文件 | `.windsurfrules` | — |
|
| 66 |
| GitHub Copilot | 规则文件 | `.github/copilot-instructions.md` | — |
|
| 67 |
|
| 68 |
-
## 安装
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 69 |
|
| 70 |
```bash
|
| 71 |
-
#
|
| 72 |
-
|
| 73 |
|
| 74 |
-
#
|
| 75 |
-
|
|
|
|
|
|
|
|
|
|
| 76 |
```
|
| 77 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 78 |
## 设计原则
|
| 79 |
|
| 80 |
- **纯本地**:无服务器、无账号、无遥测,代码永远不出你的机器
|
|
|
|
| 65 |
| Windsurf | 规则文件 | `.windsurfrules` | — |
|
| 66 |
| GitHub Copilot | 规则文件 | `.github/copilot-instructions.md` | — |
|
| 67 |
|
| 68 |
+
## 安装(给不懂 Agent 插件的人看)
|
| 69 |
+
|
| 70 |
+
### 先说人话:这是什么?
|
| 71 |
+
|
| 72 |
+
你平时用 Claude Code、Cursor 这些「AI 编程助手」写代码。每个助手都有自己的"规矩文件"(告诉 AI 该怎么干活),格式还不一样。AgentLens 做两件事:
|
| 73 |
+
|
| 74 |
+
1. **搬规矩**:把你在 Cursor 里调教好的规矩,一键搬到 Claude Code,不用重写
|
| 75 |
+
2. **查代码**:AI 写的代码它帮你体检,揪出安全漏洞和低级错误
|
| 76 |
+
|
| 77 |
+
### 三种用法,选一个就行
|
| 78 |
+
|
| 79 |
+
**用法一:什么都不装,直接问 AI(最简单)**
|
| 80 |
+
|
| 81 |
+
如果你已经在用任何一个 AI 编程助手,把这句话发给它:
|
| 82 |
+
|
| 83 |
+
> 我装了 AgentLens,帮我扫描一下当前项目的 Agent 配置
|
| 84 |
+
|
| 85 |
+
如果它回复"没找到 AgentLens 工具",说明你还没接入,看下面「用法二」。
|
| 86 |
+
|
| 87 |
+
**用法二:一键接入(推荐)**
|
| 88 |
+
|
| 89 |
+
打开终端(Mac 按 `Cmd+空格` 输入"终端"),粘贴这一行,回车:
|
| 90 |
+
|
| 91 |
+
```bash
|
| 92 |
+
node ~/Downloads/mimo/agentlens/dist/cli/index.js install
|
| 93 |
+
```
|
| 94 |
+
|
| 95 |
+
它会自动检测你电脑上装了哪些 AI 工具(Claude Code、Cursor、Codex、ZCode、WorkBuddy、MiMo Desktop),把 AgentLens 装进它们的设置里。
|
| 96 |
+
|
| 97 |
+
**装完重启对应 App**(完全退出再打开,Mac 按 `Cmd+Q`),就能在对话里直接问 AI 使用了。
|
| 98 |
+
|
| 99 |
+
**用法三:单独用(不需要任何 AI 助手)**
|
| 100 |
+
|
| 101 |
+
终端里直接用:
|
| 102 |
|
| 103 |
```bash
|
| 104 |
+
# 扫描项目里有哪些 Agent 配置
|
| 105 |
+
node ~/Downloads/mimo/agentlens/dist/cli/index.js scan --path ~/你的项目
|
| 106 |
|
| 107 |
+
# 把 Cursor 的规矩搬到 Claude Code
|
| 108 |
+
node ~/Downloads/mimo/agentlens/dist/cli/index.js move --from cursor --to claude --path ~/你的项目
|
| 109 |
+
|
| 110 |
+
# 给代码做体检
|
| 111 |
+
node ~/Downloads/mimo/agentlens/dist/cli/index.js check src/index.js --path ~/你的项目
|
| 112 |
```
|
| 113 |
|
| 114 |
+
### 各 App 接入后长什么样
|
| 115 |
+
|
| 116 |
+
| App | 接入后你会看到什么 | 怎么触发 |
|
| 117 |
+
|---|---|---|
|
| 118 |
+
| **Claude Code** | 设置 → MCP 里有 `agentlens`;输入框敲 `/agentlens` 也能用 | 直接说"用 agentlens 扫描项目" |
|
| 119 |
+
| **Cursor** | 设置 → MCP 里有 `agentlens`;装 `.vsix` 后左侧多一个 AgentLens 面板 | 命令面板 `Cmd+Shift+P` 输入 AgentLens |
|
| 120 |
+
| **Codex** | 启动后工具列表里有 agentlens;敲 `/agentlens` | 直接说"用 agentlens 扫描" |
|
| 121 |
+
| **ZCode** | 设置 → MCP 里有 `agentlens`;敲 `/agentlens` | 同上 |
|
| 122 |
+
| **WorkBuddy** | 设置 → MCP 里有 `agentlens`;敲 `/agentlens` | 同上 |
|
| 123 |
+
| **MiMo Desktop** | 设置 → MCP 里有 `agentlens`;敲 `/agentlens` | 同上 |
|
| 124 |
+
| **DSH(DeepSeek Harness)** | 输入框「完全访问」旁边多一个「🩺 体检」按钮;设置页多一个「AgentLens 迁移」面板 | 点按钮 |
|
| 125 |
+
|
| 126 |
+
### 常见问题
|
| 127 |
+
|
| 128 |
+
**Q:装完没反应?**
|
| 129 |
+
完全退出 App 再重开(不是关窗口,是退出进程:Mac 按 `Cmd+Q`)。MCP 配置是启动时加载的。
|
| 130 |
+
|
| 131 |
+
**Q:提示找不到 npx / node?**
|
| 132 |
+
说明你的电脑没装 Node.js。去 https://nodejs.org 下载安装(选 LTS 版本),装完重开终端再试。
|
| 133 |
+
|
| 134 |
+
**Q:会不会上传我的代码?**
|
| 135 |
+
不会。AgentLens 完全在你电脑本地运行,不联网、无账号、无遥测。
|
| 136 |
+
|
| 137 |
+
**Q:迁移会删掉原来的规矩文件吗?**
|
| 138 |
+
不会。只往目标 Agent 写新文件,源文件原样保留。
|
| 139 |
+
|
| 140 |
+
**Q:体检结果里的 🔴 是什么?**
|
| 141 |
+
🔴 高危(安全漏洞,必须修)、🟡 警告(可能有 bug,建议修)、⚪ 提示(风格问题)。
|
| 142 |
+
|
| 143 |
## 设计原则
|
| 144 |
|
| 145 |
- **纯本地**:无服务器、无账号、无遥测,代码永远不出你的机器
|