docs: 同步更新 README/DEVELOPMENT/BUILD 文档与实际代码一致

This commit is contained in:
thzxx
2026-04-16 20:02:35 +08:00
parent a18b04a890
commit b2c3e6eb84
4 changed files with 7 additions and 5 deletions
+1 -1
View File
@@ -378,7 +378,7 @@ metona-ollama-desktop/
- **路径黑名单**:自动屏蔽 `/etc`, `/sys`, `/proc`, `~/.ssh`, `~/.gnupg`
- **写操作白名单**:仅允许用户目录下的写入
- **命令黑名单**`rm -rf /`, `mkfs`, `dd`, `shutdown`, 反弹 shell 检测等
- **用户确认**:写入/删除/命令执行必须用户确认
- **run_command 三模式**:自动执行 / 需确认 / 禁用,用户可随时切换
- **安全提示词注入**:自动向 system prompt 追加工具使用安全规则
### 工作空间安全
+1
View File
@@ -182,6 +182,7 @@ electron-builder 会自动处理所有依赖下载(Electron、NSIS、winCodeSi
- 🔧 除 run_command 外所有工具改为自动执行无需确认
- 🔧 run_command 改为下拉框设置:自动/需确认/禁用三种模式
- 📝 版本号更新至 3.3.2package.json / index.html / README.md / CHANGELOG.md / BUILD.md
- 📝 同步更新 README.md 安全说明、DEVELOPMENT.md 开发规范、index.html 帮助面板
### v3.3.12026-04-16 — metona-ollama-desktop 仓库
+4 -3
View File
@@ -137,7 +137,8 @@ import {
- 所有命令通过 `tool-security.ts``checkCommandAllowed()` 验证
- 命令黑名单:`rm -rf /`, `mkfs`, `dd`, `shutdown`, 反弹 shell 检测等
- 写操作类工具(`write_file`, `delete_file`, `run_command`, `create_directory`)必须用户确认
- `run_command` 支持三种模式(自动/需确认/禁用),用户可随时切换
- 其余 20 个工具均为自动执行,无需用户确认
#### 前端安全
@@ -178,7 +179,7 @@ import {
- 进程结束后通过 `cmd:done` 通知渲染进程,结果回传 AI
- 用户可通过工作空间面板停止按钮终止命令(`cmd:kill`
- 命令执行前经过 `checkCommandAllowed()` 安全检查
- 用户确认后才执行(Agent Loop 的 `needsConfirmation` 机制)
- `run_command` 需确认模式下由用户确认后才执行;自动模式下直接执行
---
@@ -302,5 +303,5 @@ docs: 新增开发规范文档
2. **安全优先**:所有文件/命令操作必须经过安全检查层
3. **日志完整**:关键操作必须记录到执行日志面板
4. **无超时设计**:工作空间相关操作不设超时,由用户控制生命周期
5. **用户确认**写操作类工具必须弹出确认对话框
5. **命令安全**`run_command` 支持三模式切换(自动/需确认/禁用),其余工具自动执行
6. **桌面优先**API 调用必须检查 `bridge.isDesktop`,非桌面环境优雅降级
+1 -1
View File
@@ -350,7 +350,7 @@
<div class="modal-body">
<div class="help-section"><h4>🚀 快速开始</h4><ol><li>确保 Ollama 已启动(默认 <code>http://127.0.0.1:11434</code>,可在设置中修改)</li><li>顶部模型栏选择一个模型,右侧会显示模型能力徽章(🧠 Think / 👁️ Vision / 🔧 Tools</li><li>输入消息,按 <kbd>Enter</kbd> 发送,<kbd>Shift+Enter</kbd> 换行</li></ol></div>
<div class="help-section"><h4>💬 聊天功能</h4><ul><li><strong>流式回复</strong> — 实时打字效果,随时点 ■ 停止</li><li><strong>Think 推理</strong> — 设置中开启,让模型展示深度思考过程(需模型支持,如 Qwen3)</li><li><strong>多模态</strong> — 上传图片,模型需支持 Vision 能力</li><li><strong>文件分析</strong> — 支持 50+ 种文本/代码格式,单文件 ≤500KB,内容以代码块发送给模型</li><li><strong>上下文长度</strong> — 设置中调整 <code>num_ctx</code>,越大记忆越长,消耗显存越多</li></ul></div>
<div class="help-section"><h4>🔧 Tool CallingAI 自主操作)</h4><ul><li>设置中开启后,AI 可以在对话中<strong>自主调用本地工具</strong>,像一个本地 Agent</li><li><strong>20 个工具</strong>:文件读写、目录管理、搜索替换、网页抓取、下载、Git、压缩/解压等</li><li>写入/删除/命令执行等高风险操作会弹出<strong>确认对话框</strong>,你可以批准或拒绝</li><li>危险命令(<code>rm -rf</code><code>mkfs</code>、反弹 shell 等)和系统路径(<code>/etc</code><code>~/.ssh</code> 等)被自动拦截</li><li>工具调用以<strong>可视化卡片</strong>展示状态(pending → running → success/error</li><li>最多自动循环 <strong>10 轮</strong>工具调用,也可随时中断</li><li>⚠️ 需要模型支持 Tool Calling(推荐 Qwen3、Llama 3.1+、Mistral</li></ul></div>
<div class="help-section"><h4>🔧 Tool CallingAI 自主操作)</h4><ul><li>设置中开启后,AI 可以在对话中<strong>自主调用本地工具</strong>,像一个本地 Agent</li><li><strong>21 个工具</strong>:文件读写、目录管理、搜索替换、联网搜索、网页抓取、下载、Git、压缩/解压等</li><li><code>run_command</code>(命令执行)支持三模式切换:自动/需确认/禁用</li><li>危险命令(<code>rm -rf</code><code>mkfs</code>、反弹 shell 等)和系统路径(<code>/etc</code><code>~/.ssh</code> 等)被自动拦截</li><li>工具调用以<strong>可视化卡片</strong>展示状态(pending → running → success/error</li><li>最多自动循环 <strong>10 轮</strong>工具调用,也可随时中断</li><li>⚠️ 需要模型支持 Tool Calling(推荐 Qwen3、Llama 3.1+、Mistral</li></ul></div>
<div class="help-section"><h4>🧠 Agent 记忆系统</h4><ul><li>设置中开启后,AI 从对话中<strong>自动提取关键信息</strong>(事实/偏好/规则),跨会话持续积累</li><li>对话满 <strong>6 条消息</strong>后自动触发记忆提取</li><li>新对话时自动检索相关记忆注入上下文,让 AI "记住"你</li><li>点击顶部 🧠 按钮打开记忆面板:搜索、筛选、编辑、删除</li><li><strong>向量语义搜索</strong>:在设置中选择嵌入模型后,支持语义级别记忆检索(更精准)</li><li>未选择嵌入模型时,使用关键词匹配检索记忆</li><li>记忆存储在本地 IndexedDB,不会上传到任何服务器</li></ul></div>
<div class="help-section"><h4>🖥️ 布局说明</h4><ul><li><strong>左侧面板</strong> — 执行日志,实时显示应用运行日志(连接、模型加载、工具调用等)</li><li><strong>中间区域</strong> — 聊天消息,顶部 Header + 模型栏,底部输入框</li><li><strong>右侧面板</strong> — 工作空间(常驻显示),包含:<ul><li><strong>💻 命令行 Tab</strong> — 终端界面,实时流式输出,支持长时间运行(无超时),单一终端进程</li><li><strong>📁 文件 Tab</strong> — 浏览工作空间目录,点击文件预览内容</li></ul></li><li>工作空间目录可在设置中修改</li></ul></div>
<div class="help-section"><h4>🕐 历史记录</h4><ul><li>所有会话自动保存到本地 IndexedDB</li><li>点击顶部 🕐 按钮查看、搜索、恢复历史会话</li><li>支持导出 Markdown / HTML / TXT / <code>.metona</code> 加密备份</li></ul></div>