Workspace Review

🗂️ 工作空间规范审计与结构自检

面向 OpenClaw 工作空间的自检审计工具,用于验证文件结构、内存管理规范及安全合规性,防止配置漂移。

收藏
13.3k
安装
2.8k
版本
1.0.1
CLS 安全性认证2026-07-09
点击查看完整报告 >

使用说明

核心用法

workspace-review 是一项面向 OpenClaw 生态的结构化审计技能,通过 8 步检查流程确保工作空间符合既定规范。执行时需按顺序验证:1) 核心文件(AGENTS.md/SOUL.md/USER.md/IDENTITY.md/TOOLS.md)的完整性;2) 各文件职责边界(防止内容错位,如 PERSONA 混入技术配置);3) 内存文件命名规范(YYYY-MM-DD.md 格式、敏感数据排查);4) 向量检索对齐(确保参考文档位于可索引的 memory/ 目录);5) Git 安全状态(私有工作空间禁止公共推送、.gitignore 密钥排除);6) 异常文件扫描(清理重复或越权存储的凭证);7) 文件体积控制(启动加载文件需保持精简);8) 本地技能合规性(SKILL.md 格式校验)。

显著优点

  • 系统性覆盖:8 维度检查几乎囊括工作空间运维的所有关键点,降低人工遗漏风险
  • 安全导向:明确禁止 GitHub 推送、强制 .gitignore 密钥排除、敏感数据扫描,契合隐私优先设计
  • 渐进式治理:区分 REQUIRED/optional 文件,允许灵活演进同时守住底线
  • 向量检索优化:明确 memory/ 为唯一索引路径,避免文档"隐形"问题

潜在局限

  • 手动触发依赖:虽建议周期性执行(weekly/heartbeat),但仍需用户或代理主动调用,无自动守护机制
  • 无修复能力:仅生成问题报告(Passing/Warnings/Issues/Recommendations),不附带自动修复脚本
  • 规模瓶颈:line-count 检查阈值(如 AGENTS.md < 1000 行)对超复杂项目可能过于严格
  • 凭证目录耦合:要求凭证统一存放于 ~/.openclaw/credentials/,与特定生态绑定,迁移成本存在

适合人群

  • OpenClaw 长期用户:需维持跨会话记忆一致性者
  • 多项目代理运维者:管理多个工作空间、担心配置漂移的开发者
  • 隐私敏感用户:强调本地优先、拒绝云同步的自主托管场景

常规风险

  • 误报可能:"Rogue Files" 判定依赖人工 flag,可能误删项目特定的合法扩展文件
  • 令牌消耗:HEARTBEAT.md 等文件过大时直接提示 "token burn concern",需持续关注文件膨胀
  • 凭证泄露残留:历史提交中的敏感数据需配合 git-filter-repo 等工具清理,技能本身不提供历史擦除方案

安全解读

核心用法

workspace-review 是一个纯文档型的工作区健康检查工具,专为 OpenClaw 生态系统设计。当用户触发"review workspace"、"audit files"或"check structure"等指令时,系统会执行一套标准化的 8 步审计流程:

1. 结构检查 — 验证 ~/.openclaw/workspace/ 下 8 个标准文件(AGENTS.md、SOUL.md、USER.md 等)的存在性与位置正确性
2. 文件用途审计 — 对照矩阵检查每个文件的"单一职责",标记越界内容(如 SOUL.md 中出现任务列表)

3. 内存卫生 — 审查日期格式命名、敏感信息隔离、MEMORY.md 与日志的去重策略

4. 向量搜索对齐 — 确保可搜索文档位于 memory/ 目录(唯一被索引的路径)

5. Git 状态 — 检查无公共远程配置、.gitignore 完整性、无 lingering 提交

6. 异常文件扫描 — 识别重复用途文件(如 README.md 与 AGENTS.md 并存)、凭证误放位置

7. 体积控制 — 用 wc -l 确保启动加载文件低于 token 阈值(AGENTS.md < 1000 行)

8. 技能合规 — 验证 skills/ 目录中每个 SKILL.md 的前置元数据完整性

审计完成后输出结构化报告:✅ 通过项、⚠️ 警告、❌ 问题、📋 建议四栏分类。

显著优点

  • 零攻击面:纯 Markdown 文档 + Bash 辅助脚本,无网络请求、无动态代码执行 (eval/exec)、无第三方依赖,安全扫描 6 维度全满分
  • 工程纪律驱动:通过"文件单一职责"矩阵和命名规范,强制分离操作指令 (AGENTS.md) 与身份人格 (SOUL.md),避免配置漂移
  • 隐私优先设计:显式警告"工作区 PRIVATE,禁止推送 GitHub",默认排除密钥文件 (.key, .pem, .env)
  • 渐进式披露:核心 SKILL.md 保持精简,详细规范引用至 references/ 目录,兼顾可读性与完整性
  • 语义搜索优化:明确区分 memory/(向量索引)与 docs/(仅参考),避免关键文档无法被 RAG 检索

潜在局限

  • 手动触发依赖:需用户主动发起"review"或周期性自检,无自动定时扫描机制
  • OpenClaw 生态绑定:文件结构、命名约定紧密耦合 OpenClaw 规范,迁移至其他框架需重写
  • 无修复自动化:仅生成问题清单,不自动重命名文件、迁移内容或清理冗余
  • Shell 脚本轻量验证workspace-status.sh 建议添加路径遍历防护(如 ../ 过滤),当前版本依赖环境变量 $HOME 的预设安全性
  • 维护者匿名:SHA256 标识的维护者身份 kn73j544gmytk01hdk0z7yrdf180bka6 为去中心化 ID,无传统组织背书

适合人群

  • 使用 OpenClaw/Claude Code 等 AI 辅助开发环境的工程师
  • 对"AI 长期记忆管理"有洁癖,追求文件系统可审计性的团队
  • 需要在本地私密工作区与公共代码库间严格隔离的隐私敏感用户
  • 希望通过标准化检查清单降低认知负荷,而非依赖直觉的系统性维护者

常规风险

  • 误报清理风险:自动化理解"重复信息"可能误删用户有意保留的多处引用
  • 凭证路径假设:脚本默认凭证位于 ~/.openclaw/credentials/,若用户自定义路径需手动同步
  • Git 配置漂移:"无远程"检查依赖当前仓库状态,子模块或临时调试添加的远程需手动复核
  • Token 经济忽略:虽建议 AGENTS.md < 500 行,但未提供自动截断或分块加载方案,超大文件仍会导致启动成本

Workspace Review 内容

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