Workspace Audit 是一个专为 OpenClaw 工作区设计的零依赖审计工具,用于检测和修复工作区文件中的各类偏差问题。随着工作区的不断演进,文件路径可能断裂、凭据信息变得陈旧、敏感内容意外泄露,甚至出现重复或错位的内容结构。该工具通过自动化检查机制,全面覆盖这些常见但易被忽视的问题点,确保整个工作区的整洁与一致性。它完全基于 Bash 和 Python 标准库构建,无需额外安装任何第三方依赖,可在 macOS 和 Linux 系统上直接运行。无论是日常维护还是定期审查,Workspace Audit 都能显著提升工作区的可管理性和安全性。 该工具的核心价值在于其多维度审计能力,能够同时验证文件结构、内容规范、外部集成状态以及潜在风险。它不仅检查本地文件是否存在异常,还能与 1Password 保险库进行比对,识别出未文档化的凭据项或引用不匹配的情况。此外,它还具备路径完整性检测功能,确保所有在 TOOLS.md 或其他配置文件中声明的脚本、技能文档和资料路径真实存在。这种全方位的监控机制,使得开发者能够在问题扩大前及时发现并纠正错误。 Workspace Audit 的设计理念是轻量、灵活且可扩展。所有脚本均支持环境变量配置,用户可根据实际项目结构调整默认路径或限制阈值。例如,可以通过创建 `audit.conf` 文件来自定义不同类型文件的行数上限(如 MEMORY.md 最多允许 150 行),以适应团队特定的内容管理策略。同时,工具提供了多种运行模式:既可以一次性执行全部四项审计(结构、重复性、路径、1Password 匹配),也可以单独调用某一项检查以聚焦特定问题。这种模块化设计让使用者既能快速获取整体健康报告,也能深入排查具体环节。
核心功能特点
- 零依赖运行:仅使用 Bash 和 Python 标准库,无需 pip 安装即可在主流系统部署
- 多维度审计:涵盖文件结构合规性、超大文件识别、密钥泄露扫描及 git 状态检查
- 1Password 集成校验:自动比对 TOOLS.md 中声明的工具与 1Password 保险库中的实际条目
- 路径完整性验证:确保所有引用路径(如 skills/、scripts/、docs/)在物理磁盘上真实存在
- 重复内容检测:识别跨文件重复的章节标题、角色重叠及凭据外泄到非指定文件
- 可定制化配置:通过 audit.conf 自定义各类型文件的最大行数限制,适应不同项目规模
适用场景
Workspace Audit 特别适合那些需要长期维护和频繁更新的智能代理工作区场景。例如,在一个由多个 AI 技能组成的复杂项目中,每当新增一个技能模块或更新现有脚本时,开发者很容易忘记同步更新 TOOLS.md 文档,导致后续协作中出现混乱。此时,运行 `audit-all.sh` 能立即发现缺失的技能描述或断链的脚本引用,避免因信息断层引发的调试成本。对于依赖 1Password 管理敏感凭据的团队而言,该工具可有效防止新添加的 API 密钥或登录凭证未被记录到官方文档中,从而降低安全审计失败的风险。 另一个典型应用场景是在自动化流水线中集成定期健康检查。许多开发者在 CI/CD 流程中会设置定时任务来监控系统状态,而 Workspace Audit 正好符合这一需求——它返回非零退出码表示发现问题,便于触发告警或阻断部署。比如,可以在 nightly cron job 中执行完整审计,一旦检测到内存文件(MEMORY.md)超过预设行数,则通知责任人进行清理;或者当发现某个技能目录缺少必需的 SKILL.md 元数据时,自动发送提醒邮件。这种主动式防御机制特别适合分布式团队或多代理协同作业环境。 此外,该工具也适用于个人知识库或小型项目的自我管理。许多独立开发者虽然不使用复杂的团队协作平台,但仍希望保持自己的技能清单、记忆库和工具列表井然有序。借助 Workspace Audit,他们可以轻松验证 AGENTS.md 是否包含所有活跃模型,确认 USER.md 中的角色定义是否准确无误,并防止无意中将临时笔记写入不应存放的位置。即使没有接入 1Password,前三类基础审计依然能提供强大的质量控制能力,帮助用户维持高标准的文档实践。
