create-coding-agent-kit
v0.1.0
Published
Install shared rules, skills, and entry files for AI coding assistants.
Downloads
131
Maintainers
Readme
AI 兼容开发模板(Rules + Skills)
快速安装
在目标项目根目录执行:
npx create-coding-agent-kit常用参数:
npx create-coding-agent-kit --dry-run
npx create-coding-agent-kit --force
npx create-coding-agent-kit --target ./my-project--dry-run:只预览将要写入的文件,不实际创建。--force:覆盖目标项目中已存在的同名文件。--target:指定安装目录,默认是当前命令执行目录。
这个项目解决什么痛点
在 AI 辅助开发中,团队经常会在不同模型或工具之间切换(如 Codex/GPT、Claude Code、Cursor、Copilot)。
一旦切换,rules 和 skills 往往需要重复迁移、改路径、改入口、改加载方式,带来额外成本和协作摩擦。
这个模板的目标是:提供一套统一、可复用的 rules + skills 存放与发现规范,让你在切换模型时尽量不再反复配置。
模板定位
该模板为多种 AI 编程助手(Codex/GPT、Claude Code、Cursor、Copilot 生态)提供统一的 rules 与 skills 发现方式,并支持 rules 自动扩展。
目录结构
package.json:npm 包与 CLI 入口配置bin/create-coding-agent-kit.js:安装模板到目标项目的命令行脚本templates/base/:实际写入业务项目的模板内容templates/base/RULES.md:通用根入口templates/base/.ai/rules/:共享规则来源(支持新增规则自动纳入)templates/base/.ai/rules/RULES_INDEX.md:规则索引与加载约定templates/base/.ai/skills/:共享项目本地技能目录(支持单文件技能与目录技能包)templates/base/AGENTS.md:Codex/GPT 类入口templates/base/CLAUDE.md:Claude Code 入口templates/base/.cursor/rules/project-rules.mdc:Cursor 规则入口templates/base/.github/copilot-instructions.md:Copilot/GPT 生态入口
模板安装到业务项目后,业务项目内的结构仍是:
AGENTS.md
CLAUDE.md
RULES.md
.ai/
rules/
skills/
.cursor/
rules/
project-rules.mdc
.github/
copilot-instructions.mdRules 工作机制(可扩展)
- 入口文件统一指向
.ai/rules/base-rules.md。 - 基础规则要求读取
.ai/rules/RULES_INDEX.md。 - 然后自动扫描
.ai/rules/*.md(排除base-rules.md、RULES_INDEX.md)并按文件名顺序加载。 - 因此你在
.ai/rules/新增规则文件后,理论上无需改入口即可被识别。
Skills 工作机制(支持技能包)
- 统一技能目录为
.ai/skills/。 - 技能通过
.ai/skills/SKILLS.md建索引并按需加载。 - 支持两种技能形态:
- 单文件技能:
xxx.md - 目录技能包:
<skill-dir>/SKILL.md+scripts/+assets/+references/
- 单文件技能:
- 每个技能入口文档都必须包含 YAML 元信息,至少包含:
namedescriptionversionentrytype
如何新增规则
- 在
.ai/rules/下新增*.md文件。 - 建议使用数字前缀(如
50-xxx.md)控制顺序。 - 如需更强可控性,可在
RULES_INDEX.md更新“当前内置规则”列表。
如何新增技能
- 简单场景:在
.ai/skills/下新增*.md并登记到SKILLS.md。 - 复杂场景:新建目录技能包(含
SKILL.md与scripts/)并登记到SKILLS.md。 - 技能入口文档必须包含 YAML 元信息。
- 目录规范见
.ai/skills/README.md。
