📝 docs(templates): update README for Claude Code and current features
- Add CLAUDE.md and AGENT_RULES.local.md to framework templates (A class) - Move AGENT_RULES.local.md from C class to A class (auto-created now) - Add CLAUDE.md to deployed directory structure - Expand config table with all actions and options - Add CLAUDE.md auto-detection note - Update codex/skills reference to mention thirdparty/ - Update last-modified date Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
parent
4ac86729d7
commit
223a7974b0
|
|
@ -53,7 +53,9 @@ templates/
|
|||
|
||||
```
|
||||
AGENT_RULES.md
|
||||
AGENT_RULES.local.md # 首次自动创建(空模板)
|
||||
AGENTS.md(区块更新)
|
||||
CLAUDE.md(自动检测/创建,注入 @AGENTS.md)
|
||||
docs/prompts/system/*.md # 框架提供
|
||||
docs/prompts/coding/*.md # 框架提供
|
||||
docs/prompts/meta/*.md # 框架提供
|
||||
|
|
@ -75,12 +77,13 @@ memory-bank/
|
|||
### 项目私有(C类,不部署)
|
||||
|
||||
```
|
||||
AGENT_RULES.local.md # 项目私有规则
|
||||
docs/plans/ # 项目实施计划
|
||||
docs/prompts/custom/ # 项目自定义提示词
|
||||
docs/prompts/**/* # 项目新增的文件不会被删除
|
||||
```
|
||||
|
||||
> `AGENT_RULES.local.md` 由 `[sync_rules]` 首次自动创建(空模板),后续由项目维护,不会被覆盖。
|
||||
|
||||
### 参考资料(D类,不部署到项目根)
|
||||
|
||||
```
|
||||
|
|
@ -123,17 +126,21 @@ python <deploy_root>/scripts/playbook.py -config playbook.toml
|
|||
|
||||
### 配置节说明
|
||||
|
||||
| 配置节 | 部署内容 | 选项 |
|
||||
| -------------------- | -------------- | ----------------------- |
|
||||
| `[sync_rules]` | AGENT_RULES.md | `force` |
|
||||
| `[sync_memory_bank]` | memory-bank/ | `project_name`, `force` |
|
||||
| `[sync_prompts]` | docs/prompts/ | `force` |
|
||||
| 配置节 | 部署内容 | 选项 |
|
||||
| -------------------- | --------------------------------- | --------------------------------- |
|
||||
| `[sync_rules]` | AGENT_RULES.md + .local.md | `force`, `no_backup`, `date` |
|
||||
| `[sync_memory_bank]` | memory-bank/ | `project_name`, `force`, `no_backup`, `date` |
|
||||
| `[sync_prompts]` | docs/prompts/ | `force`, `no_backup`, `date` |
|
||||
| `[sync_standards]` | .agents/\<lang\>/ | `langs`, `gitattr_mode`, `no_backup` |
|
||||
| `[install_skills]` | ~/.agents/skills/ 或 ~/.claude/skills/ | `mode`, `skills`, `agents_home`, `skill_link`, `no_backup` |
|
||||
|
||||
- **配置节存在即启用**:只写需要同步的配置节
|
||||
- **AGENTS.md**:始终按区块更新(`<!-- playbook:xxx:start/end -->`),不受配置节控制
|
||||
- **CLAUDE.md**:自动检测/创建,注入 `@AGENTS.md` / `@AGENT_RULES.md`
|
||||
- **force**:默认 false,已存在则跳过;设为 true 时覆盖框架文件(会先备份)
|
||||
- **no_backup**:默认 false;设为 true 时跳过备份直接覆盖
|
||||
- **不删除项目文件**:只更新框架提供的文件,项目新增的文件不会被删除
|
||||
- **占位符替换**:自动替换 `{{DATE}}`、`{{PLAYBOOK_SCRIPTS}}` 等
|
||||
- **占位符替换**:自动替换 `{{DATE}}`、`{{PROJECT_NAME}}`、`{{PLAYBOOK_SCRIPTS}}`
|
||||
|
||||
### 典型场景
|
||||
|
||||
|
|
@ -158,9 +165,10 @@ force = true
|
|||
|
||||
```text
|
||||
project/
|
||||
├── AGENTS.md # 路由中心(主入口)
|
||||
├── AGENTS.md # 路由中心(Codex 入口)
|
||||
├── AGENT_RULES.md # 执行流程
|
||||
├── AGENT_RULES.local.md # 项目私有规则(可选,手动维护)
|
||||
├── AGENT_RULES.local.md # 项目私有规则(自动创建,项目维护)
|
||||
├── CLAUDE.md # Claude Code 入口(自动注入 @AGENTS.md)
|
||||
├── memory-bank/ # 项目上下文
|
||||
│ ├── project-brief.md
|
||||
│ ├── tech-stack.md
|
||||
|
|
@ -299,7 +307,7 @@ python scripts/playbook.py -config playbook.toml
|
|||
```text
|
||||
playbook/
|
||||
├── rulesets/ # 语言级硬规则 → 部署到 .agents/
|
||||
├── codex/skills/ # 按需加载的技能
|
||||
├── codex/skills/ # 按需加载的技能(thirdparty/ 为第三方同步)
|
||||
├── docs/ # 权威静态文档
|
||||
├── templates/ # 本目录:项目架构模板 → 部署到 memory-bank/ 等
|
||||
└── scripts/
|
||||
|
|
@ -320,4 +328,4 @@ python <deploy_root>/scripts/playbook.py -config playbook.toml
|
|||
|
||||
---
|
||||
|
||||
**最后更新**:2026-01-26
|
||||
**最后更新**:2026-05-18
|
||||
|
|
|
|||
Loading…
Reference in New Issue