Tools
Js Agent Healthguard
OpenClaw plugin & CLI: JS_HealthGuard health agent workspace scaffold (init, setup, brief).
Install
npm install js-agent-healthguard
README
# js-agent-healthguard
为 OpenClaw 准备的插件包:一键生成 **JS_HealthGuard**(医疗型赛博龙虾 · Street Medic)健康管理 Agent 工作空间,包含身份说明、用户档案、记忆结构、工具约定与定时任务说明。
## 要求
- Node.js **≥ 18.18**(LTS 推荐)
## 安装
在插件或本地调试目录中:
```bash
npm install js-agent-healthguard
# 或 pnpm / yarn 等价命令
```
开发本仓库时:
```bash
cd js-agent-healthguard
npm install
npm run build
```
## CLI:`healthguard`
全局或本地安装后,可使用 `healthguard` 命令(由 `package.json` 的 `bin` 字段提供)。
```bash
# 在当前目录生成工作空间
npx healthguard init
# 指定目录
npx healthguard init --dir D:\path\to\workspace
# 已存在 AGENTS.md 时强制覆盖(会先备份到 .healthguard-backup/<时间戳>/)
npx healthguard init --force
# 仅列出将写入的路径,不写盘
npx healthguard init --dry-run
# 基于 .healthguard.json 输出「健康管理师」今日简报(本地规则生成,无需联网)
npx healthguard brief --dir D:\path\to\workspace
```
### 生成的文件
| 文件 | 说明 |
|------|------|
| `AGENTS.md` | Agent 身份、语气、边界与协作方式 |
| `USER.md` | 用户健康档案(setup 主要写入目标) |
| `MEMORY.md` | 长期记忆骨架 |
| `TOOLS.md` | 工具使用约定 |
| `HEARTBEAT.md` | 定时任务与检查清单说明 |
| `.healthguard.json` | 机器可读配置(Zod 结构见 `src/config/schema.ts`) |
## 作为库使用
```ts
import { runInit, runBrief } from "js-agent-healthguard";
await runInit({
workspaceRoot: "/path/to/agent-root",
force: false,
});
const { message } = await runBrief({ workspaceRoot: "/path/to/agent-root" });
// message 为健康管理师口吻的今日要点(简体中文)
// OpenClaw 宿主内注册 Agent:使用包内 registerAgentToConfig(api, { ... }),见源码导出
```
## 测试
```bash
npm test
```
## 故障排查
- **提示已存在 AGENTS.md**:属正常幂等保护。若确认要重建,请加 `--force`;原有核心文件会备份到 `.healthguard-backup/` 下带时间戳的子目录。
- **找不到模板**:请确认发布包或仓库根目录下存在 `templates/`(`npm pack` 时由 `package.json` 的 `files` 字段包含)。
- **权限错误**:目标目录需可写;Windows 下注意杀毒或同步盘占用文件。
## 许可证
MIT
## 免责声明
本工具生成的模板内含非医疗建议说明。使用生成内容不构成诊疗行为;急症请就医。
tools
Comments
Sign in to leave a comment