jishubuddy 0.2.9 → 0.3.1

package/README.md

@@ -1,21 +1,34 @@
 # JishuBuddy
 
-JishuBuddy 是一个本地高效运行、确定性优先的智能小伙伴。
+> 面向 AI 硬件开发的编程 Agent<br>
+> A coding agent for AI hardware development
 
-![JishuBuddy](https://unpkg.com/jishubuddy@0.2.9/splash.png)
+![JishuBuddy](https://unpkg.com/jishubuddy@0.3.1/splash.png)
 
-## 特性概览
+**像使用 AI 助手一样简单，像专业工程工具一样深入。**
 
-- 自定义全屏 TUI：流式 Markdown、多行输入、会话管理、搜索和 Right Rail。
-- 模型与凭据：支持多种模型服务与凭据配置方式。
-- 工具：文件、Bash、MCP、Web Search、Remote SSH Bash 和有状态 Serial Connection。
-- 安全交互：Project Trust、危险 Bash 审核和受限 Plan 模式。
-- 记忆：支持长期记忆和可重建的 Session Search 索引。
-- 自动化：Headless 单轮执行、Deep Research 和本机 AG-UI Server。
-- 个性化：Profile 级 Personality 和用户维护的 SOUL.md。
-- TUI 与 AG-UI Server ready 后默认启用低频产品 Telemetry；TUI 还会异步提示可用更新。
+**As easy as an AI assistant. As capable as a professional engineering tool.**
 
-## 安装
+JishuBuddy 是一款本地运行的编程 Agent，适用于开发板、机器人、具身智能
+设备和边缘计算设备。它提供仿真接入、模型部署、SSH、串口和真机调试能力。
+
+JishuBuddy is an easy-to-use coding agent built for AI hardware development,
+with simulation, deployment, SSH, serial, and on-device debugging workflows.
+
+**代码 / Code**
+理解、开发、构建
+
+**↓**
+
+**仿真 / Simulation**
+运行、分析、验证
+
+**↓**
+
+**真机 / Device**
+连接、部署、调试
+
+## 安装 / Installation
 
 支持的平台：
 
@@ -23,7 +36,17 @@ JishuBuddy 是一个本地高效运行、确定性优先的智能小伙伴。
 - Apple Silicon macOS
 - Linux x64
 
-需要 Node.js 22 或更高版本（npm 随 Node.js 一起安装）。
+需要 Node.js 22 或更高版本（npm 随 Node.js 一起安装）。普通用户不需要
+安装 Bun。
+
+Supported platforms:
+
+- Linux ARM64
+- Apple Silicon macOS
+- Linux x64
+
+Node.js 22 or later is required. npm is included with Node.js. Bun is not
+required for normal installation.
 
 从 npm 公共仓库安装：
 
@@ -31,48 +54,155 @@ JishuBuddy 是一个本地高效运行、确定性优先的智能小伙伴。
 npm install -g jishubuddy
 ```
 
-此入口包会自动选择并安装与当前系统匹配的预编译原生平台包。
+入口包会自动选择并安装与当前系统匹配的预编译原生平台包。
+
+The entry package automatically installs the prebuilt native package matching
+the current system.
 
-升级到最新版：
+启动：
 
 ```bash
-jishubuddy update
+jishubuddy
 ```
 
-该命令从 npm 公共仓库查询并安装稳定最新版；TUI 启动检查只提示，不会自动安装。
+首次启动后，使用 `/login` 配置凭据，再使用 `/model` 选择模型。
 
-为获得完整且更快的文件补全和文本搜索，建议安装 `fd` 和 `ripgrep`。
+After launching, run `/login` to configure credentials and `/model` to select
+a model.
 
-Debian：
+升级到最新稳定版本：
 
 ```bash
-sudo apt install fd-find ripgrep
+jishubuddy update
 ```
 
-macOS（Homebrew）：
+该命令从 npm 公共仓库查询并安装稳定最新版。TUI 启动检查只提示，不会自动
+安装。
+
+The command queries the public npm registry and installs the latest stable
+release. The TUI only reports available updates.
+
+为获得完整且更快的文件补全和文本搜索，建议安装 `fd` 和 `ripgrep`。
 
 ```bash
+# Debian
+sudo apt install fd-find ripgrep
+
+# macOS (Homebrew)
 brew install fd ripgrep
 ```
 
-## 使用 TUI
-
-启动终端界面：
+## 使用 / Usage
 
 ```bash
+# 启动全屏 TUI
 jishubuddy
+
+# 执行单轮任务
+jishubuddy run -p "Analyze this AI hardware project"
+
+# 启动 AG-UI Server
+jishubuddy server
 ```
 
-首次使用时，可输入 `/hotkeys` 查看快捷键，输入 `/help` 查看命令，输入 `/quit` 退出。通常需要
-先使用 `/login` 配置凭据，再输入 `/model` 选择模型；随后输入问题并按 Enter 提交。
+任务示例：
+
+```text
+启动项目的仿真环境，运行模型并分析结果。
+把模型部署到开发板，然后检查运行日志。
+持续观察串口输出，出现异常后分析原因。
+比较模型在仿真环境和真实设备上的运行结果。
+```
+
+Example tasks:
+
+```text
+Start the project simulator, run the model, and analyze the result.
+Deploy the model to the development board and inspect the runtime logs.
+Monitor the serial output and analyze the next failure.
+Compare model behavior in simulation and on the physical device.
+```
+
+## 核心能力 / Core Capabilities
+
+### 简单易用的编程 Agent
+
+理解和修改代码，运行命令，构建、测试并分析错误。
+
+### 从仿真到真机
+
+接入项目已有仿真器，并继续完成真机部署和验证。
+
+### 连接真实设备
+
+通过 SSH 操作 Linux 设备，通过有状态串口连接开发板。
+
+### 专业工具与长期上下文
+
+使用 Bash 和 MCP 连接外部工具，并积累项目、模型和设备信息。
+
+## 为 AI 硬件开发而增强 / Built for AI Hardware
+
+面向 AI 开发板、机器人、具身智能设备、边缘计算设备、智能摄像头、传感器
+终端和 AI 硬件原型，不绑定特定芯片或指令集。
+
+Built for development boards, robots, embodied AI systems, edge devices, smart
+cameras, sensors, and AI hardware prototypes without locking the workflow to
+one processor architecture.
+
+## 从仿真到真机 / Simulation to Hardware
+
+1. 理解项目、模型和设备目标
+2. 启动项目已有的仿真环境
+3. 运行模型或控制逻辑并分析结果
+4. 连接开发板或真实设备
+5. 部署模型并读取设备日志
+6. 比较仿真和真机结果
+7. 修改代码或配置并重新验证
+
+同一个 Agent 贯穿仿真验证、真机部署和现场调试。
+
+The same agent session continues from simulation through deployment and
+on-device debugging.
+
+## 完整能力 / Full Capabilities
+
+| 能力 / Capability | 说明 / Description |
+| --- | --- |
+| Coding Agent | 代码理解、修改、构建、测试和错误分析 |
+| Simulation | 调用项目已有仿真器、测试框架和命令行工具 |
+| Model Deployment | 准备模型、检查环境、部署应用并验证结果 |
+| SSH & Serial | 连接远程 Linux 设备和有状态串口会话 |
+| Log Analysis | 联合分析代码、终端输出、串口日志和设备状态 |
+| MCP | 连接外部工具，也可自行接入搜索服务查询资料 |
+| Persistent Context | 积累项目、设备、模型和调试上下文 |
+| Automation | 全屏 TUI、Headless 和 AG-UI |
+
+## 适用人群 / Who Is It For?
+
+- 在开发板和边缘设备上部署与调试模型的 AI 硬件开发者
+- 处理模型、控制程序、仿真器和真机的机器人与具身智能开发者
+- 使用 SSH、串口、命令行和设备日志的嵌入式工程师
+- 将模型从工作站迁移到真实设备的算法与模型工程师
+- 开发 AI 硬件原型和产品化设备的团队
+
+## 模型与凭据 / Models and Credentials
+
+支持 API Key、GitHub Copilot 和 OpenAI-compatible providers。
+
+Supports API keys, GitHub Copilot, and OpenAI-compatible providers.
+
+## 许可证 / License
+
+JishuBuddy 使用
+[Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0)。
 
-## 隐私与许可
+JishuBuddy is licensed under the
+[Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0).
 
-TUI 与 AG-UI Server 会把固定产品 ID、版本、SHA-256 假名设备指纹、OS/CPU、board/model 和
-activation/heartbeat 时间发送到 `https://aijishu.com/jishushell/check-update`。不发送 prompt、
-回复、Session、凭据或文件路径；heartbeat 最多每四小时一次，状态保存在
-`<agentDir>/telemetry/state.json`。启动前设置
-`JISHUBUDDY_TELEMETRY_DISABLED=true` 或 `1` 可关闭。
+随包第三方材料的来源、修改方式和许可证见
+[第三方许可与声明](https://unpkg.com/jishubuddy@0.3.1/THIRD_PARTY_NOTICES.md)。
 
-Web Search 随包数据资产的来源、修改方式和许可证见
-[第三方许可与声明](https://unpkg.com/jishubuddy@0.2.9/THIRD_PARTY_NOTICES.md)。
+For the sources, modifications, and licenses of bundled third-party materials,
+see the
+[Third-Party Notices](https://unpkg.com/jishubuddy@0.3.1/THIRD_PARTY_NOTICES.md).

package/THIRD_PARTY_NOTICES.md

@@ -1,89 +1,3 @@
-# Web Search 第三方许可与声明
-
-本文记录 JishuBuddy Web Search 随二进制分发的数据资产及运行时必须展示的来源声明。
-这些条款只适用于相应第三方材料，不改变 JishuBuddy 其他代码或内容的许可状态。
-
-## 随包文档目录
-
-### TypeScript Documentation
-
-- 来源：`microsoft/TypeScript-Website@c8170c35bda4811c9516cbb69c39241ae4beb6d9`
-- 许可：[Creative Commons Attribution 4.0 International](https://creativecommons.org/licenses/by/4.0/legalcode)
-- 署名：Microsoft · TypeScript Documentation
-- 修改：只选择英文文档 frontmatter 中的标题、简述和 canonical 路径；对字段执行确定性筛选、纯文本规范化和目录重排，不复制正文、代码或 HTML。
-
-### MDN Web Docs
-
-- 来源：`mdn/content@784cf625ee9f57f6cedbbf220c66ae99e34e8f9b`
-- 许可：[Creative Commons Attribution-ShareAlike 2.5](https://creativecommons.org/licenses/by-sa/2.5/)
-- 署名：Mozilla Contributors · MDN Web Docs
-- 修改：只选择 Web API 顶层、JavaScript Globals 和 HTTP allowlist 中的英文标题、首段摘要与 canonical 路径；去除 Markdown/HTML 显示标记并规范化为纯文本。该派生目录中的 MDN 摘要继续按 CC BY-SA 2.5 提供。
-
-### Node.js Documentation
-
-- 来源：`nodejs/node@e68946d95e6e912175b9571e0ef89b0e248a0549`
-- 许可：[Node.js LICENSE](https://github.com/nodejs/node/blob/e68946d95e6e912175b9571e0ef89b0e248a0549/LICENSE)
-- 署名：Copyright Node.js contributors. All rights reserved.
-- 修改：只选择顶层 API 文档的标题、首段摘要与 canonical 路径，并规范化为只读检索目录。
-
-Node.js 相关材料的 MIT 许可声明：
-
-> Permission is hereby granted, free of charge, to any person obtaining a copy
-> of this software and associated documentation files (the "Software"), to
-> deal in the Software without restriction, including without limitation the
-> rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
-> sell copies of the Software, and to permit persons to whom the Software is
-> furnished to do so, subject to the following conditions:
->
-> The above copyright notice and this permission notice shall be included in
-> all copies or substantial portions of the Software.
->
-> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-> FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
-> IN THE SOFTWARE.
-
-### Bun Documentation
-
-- 来源：`oven-sh/bun@b7a0431032129d74fa4a7e3704eaf57b92fa9136`
-- 许可：[Bun LICENSE](https://github.com/oven-sh/bun/blob/b7a0431032129d74fa4a7e3704eaf57b92fa9136/LICENSE.md)
-- 署名：Oven.sh · Bun contributors
-- 修改：只选择具有显式标题、描述和 canonical 路径的文档元数据，并规范化为只读检索目录。
-
-Bun 文档目录沿用上文 MIT 许可声明。
-
-## 运行时数据声明
-
-使用 NIST NVD 数据时，产品必须展示以下声明：
-
-> This product uses data from the NVD API but is not endorsed or certified by the NVD.
-
-English Wikinews 搜索片段按页面创建时间分别适用 Public Domain、CC BY 2.5 或
-CC BY 4.0。JishuBuddy 保留 `Wikinews` 署名和文章链接，不把最后编辑时间冒充创建时间，
-也不为全部页面伪造统一许可证。
-
-DuckDuckGo HTML 当前只用于单用户、本机、低频 Beta。项目尚未取得机器集成的书面许可，
-不得把当前实现扩大为转售搜索服务、大规模自动化或正式对外发行依据。
-
-Exa 托管 MCP 可能由 `web_search_exa` 显式调用，也可能在 `web_search` 的
-`sourcePolicy=preferred` 查询失败或为空时自动兜底。自动路径按不同查询指纹计数，默认
-每个 Session agent loop 最多 3 条、可配置为 1～10 条，相同查询不会重复外呼。
-两种方式都会让 Exa 看到公开 query 与调用方 IP；BYOK 还会发送 `x-api-key`。Exa 的
-公开隐私政策说明普通 Query Data 可用于产品改进以及模型训练或微调，Zero Data
-Retention 需要 Enterprise 安排。该结果保持独立、不缓存、不融合，也不产生可供
-`web_fetch` 使用的 `resultId`。
-
-AnySearch 是模型可显式调用的零 Key Beta，也是 Exa 额度、限流、认证、结果校验或服务
-故障后的自动最终兜底。自动资格绑定同 Session、同 agent loop 的同一查询，且受上述
-不同查询总上限约束。自动路径会把同一公开 query 与调用方 IP 发送给 AnySearch；正式
-政策说明 query 前 100 字符和 API 调用元数据可保留 12 个月。正式发行、转售或大规模
-自动化前必须重新确认其 API 结果展示、商业分发与批量使用边界。
-
----
-
 # Telemetry 第三方许可与声明
 
 JishuBuddy 的 Telemetry 实现基于以下上游源码：

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jishubuddy",
-  "version": "0.2.9",
+  "version": "0.3.1",
   "description": "JishuBuddy",
   "license": "Apache-2.0",
   "type": "module",
@@ -18,9 +18,9 @@
     "splash.png"
   ],
   "optionalDependencies": {
-    "jishubuddy-linux-x64": "0.2.9",
-    "jishubuddy-linux-arm64": "0.2.9",
-    "jishubuddy-darwin-arm64": "0.2.9"
+    "jishubuddy-linux-x64": "0.3.1",
+    "jishubuddy-linux-arm64": "0.3.1",
+    "jishubuddy-darwin-arm64": "0.3.1"
   },
   "publishConfig": {
     "access": "public",