Workspace Review

🧹 OpenClaw 工作区结构合规审计

development-tools榜 #3

自动化审查 OpenClaw 工作区结构合规性,检测文件越界、敏感数据泄露及语义索引错位,适合定期自检维护。

收藏
6.4k
安装
2.8k
版本
1.1.0
CLS 安全扫描中
预计需要 3 分钟...

使用说明

核心用法

workspace-review 是一个面向 OpenClaw 生态的自审计技能,通过 8 步结构化检查确保工作区文件符合既定约定。执行时自动扫描 ~/.openclaw/workspace/ 目录,验证核心文件(AGENTS.md、SOUL.md、USER.md、IDENTITY.md、TOOLS.md 等)的存在性与位置正确性,检查内容职责边界是否发生「范围蔓延」,并审核内存文件的卫生状况(格式规范、去重、敏感数据隔离)。

关键特色在于向量搜索对齐检查:明确指出仅 MEMORY.mdmemory/**/*.md 被语义索引,强制要求参考文档必须置于 memory/ 而非 docs/,避免关键信息因路径错误而「不可搜索」。此外包含 Git 隐私审查(禁止推送到公共远程)、文件大小管控(启动加载文件行数上限)、skills 目录合规性等专项检测。

显著优点

  • 约定即代码:将抽象的「最佳实践」转化为可执行的 bash 检查清单,降低人为遗漏
  • 语义搜索 aware:独特关注向量索引路径问题,解决 AI 助手「找不到自己写的文档」的痛点
  • 隐私优先设计:内置 Git 远程检查与敏感文件扫描,防止工作区意外泄露
  • 渐进式治理:支持周期性运行(weekly/heartbeat)与触发式运行双模式,灵活嵌入工作流

潜在局限

  • 生态绑定深:完全依赖 OpenClaw 目录结构与文件命名约定,迁移成本较高
  • 被动检测为主:发现问题后依赖人工修复,无自动纠正能力
  • 行数阈值主观:500/200/100 等数字为经验值,未必适配所有团队规模
  • bash 依赖:部分检查假设 Unix-like 环境,Windows 兼容性未明确

适合人群

  • 使用 OpenClaw 框架的 AI 助手维护者
  • 多会话长周期运行的 agent 运维人员
  • 对「可搜索记忆」有强需求的知识管理场景

常规风险

  • 误报可能:自定义扩展文件可能被标记为「rogue files」
  • 检查盲点:无法检测语义层面的内容重复(仅检查文件名/位置)
  • 凭证残留:虽有敏感数据提醒,但无自动扫描密钥模式功能,仍需配合 .gitignore 人工审查

安全解读

核心功能

workspace-review 是一个面向 OpenClaw 生态的工作区结构审计 Skill,提供系统化的自检能力,确保本地工作区文件遵循标准约定,避免配置漂移。

审查流程

该 Skill 设计了 8 步递进式审查机制:

1. Structure Check — 验证 AGENTS.md、SOUL.md、USER.md、IDENTITY.md、TOOLS.md 等必需文件的存在性与位置正确性
2. File Purpose Audit — 检查文件职责单一性,防止内容越界(如 SOUL.md 混入任务清单)

3. Memory Hygiene — 审查日志命名规范(YYYY-MM-DD.md)、MEMORY.md 策展质量、敏感数据隔离

4. Vector Search Alignment — 关键约束:仅 MEMORY.mdmemory/**/*.md 支持语义检索,docs/ 目录内容不可搜索

5. Git Status — 强调工作区 PRIVATE 属性,禁止推送到公开远程,检查 .gitignore 配置

6. Rogue Files Check — 识别重复功能文件、错误存放的凭证、非标准目录

7. Size Check — 控制启动文件体积(AGENTS.md <500 行、IDENTITY.md <50 行等),优化 Token 消耗

8. Skills Check — 验证 skills/ 目录内各 Skill 的元数据完整性与去重

显著优点

  • 约定即文档:将 OpenClaw 最佳实践编码为可执行的检查清单
  • 渐进式治理:区分 REQUIRED/OPTIONAL 文件,支持从最小配置到完整工作流的平滑扩展
  • 语义检索感知:明确区分可搜索与不可搜索的存储路径,避免关键信息"隐形"
  • Token 效率意识:通过文件体积限制,防止启动上下文膨胀
  • 零外部依赖:纯本地文件系统操作,无网络请求、无第三方依赖

潜在局限

  • T3 来源可信度:本地项目,无公开 GitHub 仓库可供验证,需用户自行审查代码
  • 启发式检测局限:API Key 检测模式(grep -r -l "sk-")可能产生误报
  • 路径遍历风险:脚本接受 $1 参数作为工作区路径,缺乏输入验证
  • 人工决策依赖:输出为结构化报告,修复动作需用户手动执行

适用人群

  • OpenClaw 重度用户,需要维护长期记忆工作区
  • 多项目并行的开发者,担心配置文件混乱漂移
  • 对 AI Agent 上下文管理有精细化要求的进阶用户

安全风险

安全认证报告显示综合得分 92/100,评级 A。主要风险点为 T3 来源(本地项目无可验证公开来源),而非代码本身。所有操作为只读文件系统访问,无数据外泄、无敏感信息收集、无危险函数调用。

建议:在受控环境首次运行,确认脚本行为符合预期后再纳入常规维护流程。

Workspace Review 内容

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