playbook/playbook.toml.example

73 lines
3.6 KiB
Plaintext
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# playbook.toml (example)
#
# 本配置文件用于部署 Playbook 到目标项目,支持两种模式:
# - subtree 模式:已通过 git subtree 将 Playbook 引入项目
# - snapshot 模式:从外部 clone 的 Playbook 安装快照到项目
#
# 配置节规则:
# - 配置节存在即启用该功能
# - 如果不填 project_root默认使用配置文件所在目录
[playbook]
# project_root = "." # 可选:目标项目根目录(默认为配置文件所在目录)
# playbook_root = "docs/standards/playbook" # 项目内 Playbook 根目录(相对于 project_root
# install_mode = "subtree" # subtree: 通过 git subtree 引入 | snapshot: 从外部安装快照
# claude_md = "CLAUDE.md" # 可选CLAUDE.md 位置(默认自动检测:根目录 → .claude/
# ============================================================================
# 项目模板同步
# ============================================================================
[sync_rules]
# 同步 AGENT_RULES.md
# force = false # 覆盖已有文件
# no_backup = false # 跳过备份
# date = "2026-04-22" # 替换 {{DATE}}
[sync_memory_bank]
# 同步 memory-bank/ 目录
# ⚠️ 只更新框架提供的文件,项目新增的文件不会被删除
# ⚠️ force=true 会覆盖已填写的项目信息(会先自动备份)
# project_name = "MyProject" # 替换 {{PROJECT_NAME}}
# force = false # 覆盖已有文件(会先备份)
# no_backup = false # 跳过备份
# date = "2026-04-22" # 替换 {{DATE}}
[sync_prompts]
# 同步 docs/prompts/ 目录
# 只更新框架提供的文件,项目新增的文件不会被删除
# force = false # 覆盖已有文件(会先备份)
# no_backup = false # 跳过备份
# date = "2026-04-22" # 替换 {{DATE}}
# ============================================================================
# 语言规范同步
# ============================================================================
[sync_standards]
# 同步语言规范到 .agents/<lang>/ 和 .gitattributes
# langs = ["tsl", "cpp", "typescript"] # 必填:要同步的语言
# gitattr_mode = "append" # append(补全缺失) | overwrite(覆盖) | block(插入块) | skip(跳过)
# no_backup = false # 跳过备份(.agents/.gitattributes
# ============================================================================
# Skills 安装
# ============================================================================
[install_skills]
# 安装 skills 到本机平台目录
# mode = "list" # list: 指定 skills | all: 全部安装
# skills = ["brainstorming"] # mode=list 时必填
# agents_home = "~/.agents" # Codex CLI 用 "~/.agents"Claude Code 用 "~/.claude"
# skill_link = "~/.claude" # 可选:在此目录下创建 skills/ 软链接指向 agents_home/skills/
# no_backup = false # 跳过备份,直接删除旧 skill 后重装
# ============================================================================
# 其他工具
# ============================================================================
[format_md]
# Markdown 格式化
# tool = "prettier" # 仅支持 prettier
# globs = ["**/*.md"] # 可选:默认全量 Markdown