workspace-review

🔍 智能工作空间健康诊断专家

OpenClaw 官方工作空间自审工具,帮助用户检查本地工作空间结构是否符合标准约定,防止配置漂移。

收藏
16.9k
安装
4k
版本
v1.0.2
CLS 安全性认证2026-05-01
点击查看完整报告 >

使用说明

核心用法

workspace-review 是一个面向 OpenClaw 用户的自动化工作空间审计技能,用于定期检查 ~/.openclaw/workspace// 目录下的文件结构是否符合官方约定。用户可通过自然语言指令(如"review workspace"、"audit files"、"check structure")触发,或在每周维护周期自动运行。技能会执行 8 项标准化检查:结构完整性验证、文件用途审计、内存文件卫生检查、向量搜索对齐确认、Git 状态审查、异常文件检测、文件大小控制以及自定义技能合规性验证。

显著优点

1. 预防配置漂移:通过周期性自检,及时发现工作空间结构偏离标准模式的问题,避免长期积累导致维护困难。
2. 安全增强设计:内置 API key 泄露检测功能,主动扫描内存文件中可能存在的敏感凭证,提升用户数据安全意识。

3. 零网络依赖:完全本地运行,所有检查操作均在用户设备上完成,无数据外传风险。

4. 清晰的输出格式:采用结构化的四栏报告(通过项/警告/问题/建议),便于用户快速定位需处理的事项。

5. 渐进式披露理念:技能文档本身即遵循其倡导的设计原则——核心流程简洁明了,详细规范通过引用文档延伸阅读。

潜在缺点与局限性

1. 生态绑定较强:专为 OpenClaw 工作空间设计,对非 OpenClaw 用户或自定义目录结构的用户价值有限。
2. 自动化程度有限:虽提供检查脚本,但修复动作仍需用户手动执行,无法实现一键修复。

3. 判断依赖静态规则:基于固定文件名和目录结构进行校验,难以适应用户合理的个性化扩展需求。

4. 无历史趋势分析:单次审计无法展示工作空间健康度的变化趋势,长期维护效果需用户自行追踪。

适合的目标群体

  • OpenClaw 重度用户:需要维护复杂代理配置和多项目工作空间的专业用户。
  • 团队协作场景:多人共享工作空间规范时,作为一致性检查工具使用。
  • 安全意识较强的用户:重视本地数据治理、希望主动发现凭证泄露风险的用户。
  • 定期维护习惯者:已建立周期性系统检查工作流的用户,可将此技能整合进现有维护周期。

使用风险

1. 误报风险grep -r 扫描 API key 可能产生误报,将合法字符串标记为潜在风险。
2. 脚本环境依赖workspace-status.sh 依赖标准 Linux 命令(find、wc、git 等),在精简容器环境或 Windows 非 WSL 环境下可能运行异常。

3. 权限边界模糊:虽仅需读取权限,但脚本运行时会遍历整个工作空间,若工作空间包含符号链接指向敏感目录,可能意外暴露信息。

4. 无版本回滚机制:技能本身不备份任何配置,用户根据建议修改前需自行确保可恢复性。

安全解读

核心用法

workspace-review 是 OpenClaw 生态的工作空间自检工具,通过结构化审计流程验证 ~/.openclaw/workspace/ 目录是否符合官方约定。当用户要求"review workspace"、"audit files"、"check structure"或进入周期性维护时自动触发。

审计流程覆盖8个维度:
1. 结构检查:验证 AGENTS.md、SOUL.md、USER.md、IDENTITY.md、TOOLS.md 等必需文件存在性

2. 职责审计:确保每个文件单一职责(如 AGENTS.md 只含操作指令,不含个人记忆)

3. 内存卫生:检查日期格式命名、敏感数据泄露、MEMORY.md 与 daily logs 去重

4. 向量索引对齐:确认仅 MEMORY.md 和 memory/*/.md 被索引,避免搜索污染

5. Git 状态:强制私有工作空间原则,禁止推送到公共远程

6. 异常文件扫描:识别重复目的文件、凭证泄露、非标准目录

7. 体积控制:Bootstrap 文件行数上限(AGENTS.md <1000行,SOUL.md <200行等)

8. Skill 合规:检查 skills/ 目录下 SKILL.md 格式与重复技能

显著优点

  • 官方背书:来自 OpenClaw 组织仓库,版本历史完整(v1.0.0→v1.0.2),T2 可信来源
  • 零攻击面:99行 Shell 脚本仅执行 lsfindwc -lgit status,无网络通信、无代码执行
  • 主动防御:内置敏感数据扫描(API keys、passwords、.env 文件),强制 .gitignore 规则
  • 渐进式披露:审计输出分四级(Passing/Warnings/Issues/Recommendations),降低认知负荷
  • 自动化友好:支持 heartbeat 周期触发,与 session-memory 钩子协同实现上下文持久化

潜在局限

  • 只读诊断:仅识别问题不提供自动修复,需用户手动执行整理操作
  • OpenClaw 专属:审计规则深度绑定 OpenClaw 文件命名约定(AGENTS.md/SOUL.md 等),对其他框架零兼容
  • 规模上限:未设计用于超大型工作空间(>10MB 或 >1000 文件),可能产生报告噪音
  • Git 依赖:Git 状态检查需本地安装 git,纯文件系统场景会跳过相关审计

适合人群

  • OpenClaw 长期用户:需维护数月/年积累的工作空间,防止结构腐化
  • 多代理协作者:团队共享 workspace 时确保文件职责边界清晰
  • 安全意识强的开发者:要求本地优先、零外部 API、可审计的工具链
  • 自动化工作流构建者:希望将结构检查纳入 CI 或定时任务的运维人员

常规风险

| 风险类型 | 评估 | 说明 |
|---------|------|------|
| 数据外泄 | 极低 | 纯本地只读操作,认证报告确认零网络流量 |
| 误报干扰 | 低 | 可能将用户故意自定义的文件标记为"rogue files" |
| 权限过度 | 低 | 需读取 ~/.openclaw/workspace/ 全目录,符合声明功能 |
| 维护滞后 | 中 | 若上游约定变更(如新增必需文件),需等待 Skill 更新 |

合规提示:GDPR 数据最小化原则通过认证,但用户应知悉该工具会扫描其工作空间内容——虽不上传,仍建议审查 Skill 权限设置。

workspace-review 内容

references文件夹
scripts文件夹
手动下载zip · 8.9 kB
checklist.mdtext/markdown
请选择文件