Claude Code Installation

Claude Code 安装指南

5 分钟内在你的项目中通过 Claude Code 安装 ai-coding-ok。

---

前置条件

• 已安装 Claude Code
• 一个项目目录（新建或已有）

---

第 1 步：下载 ai-coding-ok

git clone https://github.com/Mark7766/ai-coding-ok ~/ai-coding-ok

只需执行一次，所有项目共用这一份。

---

第 2 步：全局安装 skill

bash ~/ai-coding-ok/install.sh --claude-code

这会将 ai-coding-ok skill 安装到 ~/.claude/skills/ai-coding-ok/。每台机器只需执行一次。

---

第 3 步：在项目中初始化

在任意项目中启动 Claude Code，然后说（记得带一句项目描述）：

安装 ai-coding-ok，我想做一个个人记账工具，记录每天花销和收入

Claude 会检测到触发词并进入 Mode A（安装），读取 skill 中的模板自动复制到项目里。

---

第 4 步：回答一个问题

Claude 会根据你的一句话描述，自动推断技术栈并提问确认：

你的项目	好的描述
个人记账工具	"一个给自己用的每日记账工具，能分类统计每月花销"
团队周报工具	"一个给团队用的周报收集工具，每周五自动提醒提交，汇总后发邮件"
内部 API 服务	"一个管理客户订单的 REST API，后端用 PostgreSQL"

Claude 随后会：

1. 推断你的技术栈、架构、设计原则
2. 替换所有模板文件中的 {{占位符}}
3. 询问源码目录配置（用于 hooks）
4. 初始化第一条任务历史记录

源码目录提示

Claude 还会问：

"你的项目源码目录是什么？（如 src/、lib/，空格分隔多个，默认：src/ tests/）"

这会配置 Claude Code hooks，使其只在你的源码文件变更时触发。

---

第 5 步：检查并确认

Claude 会输出摘要：

✅ 安装完成

已安装文件：
  AGENTS.md、CLAUDE.md、.github/copilot-instructions.md、
  .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、
  .github/agent/memory/task-history.md、
  .github/project-metadata.yml、.github/PULL_REQUEST_TEMPLATE.md、
  .github/ISSUE_TEMPLATE/*、.github/workflows/*、
  .claude/settings.local.json

关键决策：
  - 项目名称：your-project
  - 技术栈：Python 3.12 + FastAPI + SQLite + pytest
  - 设计原则：极简、实用

下一步：打开 AGENTS.md 检查。PDCA 循环已生效。

---

第 6 步：验证

bash ~/ai-coding-ok/scripts/verify.sh

预期输出：

✓ 所有必需文件已就绪。
✓ 无未填充的占位符 — 安装已完全定制化。

详见安装验证。

---

安装后发生了什么

从此刻起，本项目的每次编码任务都会自动：

1. Plan（规划） — 写代码前读取 7 个文件（AGENTS.md + 3 个 agent 规范 + 3 个记忆文件）
2. Do（执行） — 同时写代码和测试
3. Check（检查） — 运行测试，验证无回归
4. Act（记录） — 更新 task-history.md（始终），按需更新 decisions-log.md / project-memory.md

PDCA 循环由五层防御体系强制执行。

---

Claude Code 特有功能

• CLAUDE.md — 自动加载 shim，每次会话开始自动导入 AGENTS.md
• 四重 hooks — SessionStart / UserPromptSubmit / PreToolUse / Stop，五层防御中最强的一层
• settings.local.json — Hook 配置，自动匹配源码目录变更

---

常见问题

"我已经有 AGENTS.md 了"

安装程序会检测冲突并提供三个选项：

1. 覆盖（有风险）
2. 只复制缺失的文件（安全，推荐）
3. 取消

它永远不会静默覆盖已有文件。

"settings.json 与 settings.local.json 冲突"

如果两个文件同时存在，安装程序会警告并建议只保留 settings.local.json 中的 hooks。详见 Hooks 系统。

"我在用 Windows"

使用 install.py 代替 install.sh：

python ~/ai-coding-ok/install.py --claude-code

---

下一步

• 验证安装
• 理解 PDCA 工作流
• 了解三层记忆系统