Skip to content

Installation Verification

wangliang edited this page Jul 25, 2026 · 2 revisions

安装验证

确认你的 ai-coding-ok 安装完整且正确。


快速验证

在项目根目录运行验证脚本:

# 如果你将 ai-coding-ok 克隆到了 ~/tools/ai-coding-ok
bash ~/tools/ai-coding-ok/scripts/verify.sh .

# 或者从 ai-coding-ok 仓库目录
bash /path/to/ai-coding-ok/scripts/verify.sh

退出码含义

退出码 含义 操作
0 ✅ 完美——所有文件齐全,无占位符残留 无需操作
1 ❌ 缺少文件——某些必需文件不存在 重新运行安装脚本
2 ⚠️ 占位符未填充——文件中仍有 {{...}} 重新粘贴 customize-prompt.md(Copilot)或重新运行 install ai-coding-ok(Claude Code)

手动检查清单

逐项检查以下文件是否存在:

核心文件

  • AGENTS.md — 第一行为 <!-- ai-coding-ok: v4.1.0 -->
  • CLAUDE.md — 包含 @AGENTS.md 导入

Agent 规范

  • .github/agent/system-prompt.md
  • .github/agent/coding-standards.md
  • .github/agent/workflows.md
  • .github/agent/prompt-templates.md

记忆文件

  • .github/agent/memory/project-memory.md — 已填入你的项目信息
  • .github/agent/memory/decisions-log.md — 至少有一条 ADR-001
  • .github/agent/memory/task-history.md — 至少有一条 TASK-001

平台特定

  • .github/copilot-instructions.md — 顶部有 PDCA 强制执行块
  • .cursor/rules/ai-coding-ok.mdc(仅 Cursor)— 有 alwaysApply: true
  • .claude/settings.local.json(仅 Claude Code)— hooks 已配置

CI 与元数据

  • .github/project-metadata.yml
  • .github/PULL_REQUEST_TEMPLATE.md
  • .github/workflows/ci.yml
  • .github/workflows/memory-check.yml

常见验证失败

"缺少 .claude/settings.local.json"

这是正常的——如果安装时项目中没有 .claude/ 目录,则不会配置 hooks。Hooks 是 Claude Code 专属的,Copilot 和 Cursor 不需要。

在 Claude Code 中重新运行 install ai-coding-ok 即可配置 hooks。

"占位符未填充"

定制化步骤未完成。Claude Code 用户重新运行 install ai-coding-ok,Copilot 用户重新粘贴 scripts/customize-prompt.md

"settings.json 中的 hooks 与 settings.local.json 冲突"

当两个文件同时存在时发生。将 hooks 合并到 settings.local.json 中,并从 settings.json 中移除 hooks。详见 Hooks 系统

"缺少 .cursor/rules/ai-coding-ok.mdc"

你安装时用了 --copilot 但需要 --cursor。运行:

bash install.sh --cursor

这会在现有安装之上添加 Cursor 规则文件。


自动化 CI 验证

memory-check.yml 工作流在每次 PR 时运行验证。检查内容:

  • 记忆文件已更新(task-history.md 有新条目)
  • 无占位符泄漏
  • 版本标记一致

详见 CI 集成


下一步

Clone this wiki locally