ai-team-rules
v0.3.8
Published
Set up consistent team rules for vibe coding across Claude, Codex, and Cursor.
Downloads
119
Maintainers
Readme
ai-team-rules
这是一个帮助团队在 Claude、Codex、Cursor 中快速统一协作规则的包。 既适用于新项目快速接入,也适用于已运营项目的重构与整理。 即使采用完全 AI Native 的 vibe coding,也能先稳定项目规则、文档结构和通用工作方式。 无需额外设置,只需执行命令,即可按全局或项目范围自动生成适配 Claude/Codex 的目录与文档。
包含的 pack:
- AI 基础规则
- 安全/Harness 规则
- Git 工作流
- React + TypeScript
- react/ts 规则包含 clean code 规范与常用目录结构,参考了 Vercel、Toss、Kakao 等高质量 React 实践。
- Spring Boot
- NestJS
- Spring Boot 与 NestJS 也包含 clean code 规范与 boilerplate 风格目录结构。
- 文档结构规则(
docs,/ai-instructions)- 该规则整理了 Claude 与 Codex 官方文档中推荐的
CLAUDE.md/AGENTS.md编写方式。通过该 skill 可以节省 context 与 token 成本。无论你是否已有文档,都可以借助该 skill 进行规范化整理。
- 该规则整理了 Claude 与 Codex 官方文档中推荐的
规则内容可在此直接查看 => Consis Rules Directory
Install
npm install -g ai-team-rulesQuick Start
# ex) react-ts & /ai-instructions setting (default: claude)
npx ai-team-rules react-ts --auto
# codex
npx ai-team-rules react-ts --auto --tool codex
# /ai-instructions setting
npx ai-team-rules docs* react-ts
react-ts 不仅是样式规则,还包含目录结构、状态管理、渲染安全与重构标准。
无论是新项目建立基线,还是旧项目渐进式整理,都可以保持同一套规则一致落地。
其中也包含来自 Vercel、Toss、Kakao 等高质量代码实践的规则与模式。
* 执行 docs(/ai-instructions) 时的流程
- 仅在根
CLAUDE.md添加指针 - 完整规则保存到
.claude/rules/react-ts.md - 自动应用
docspack(包含/ai-instructions) - 自动创建所需目录/文件
应用到 Codex:
Codex 没有官方 rules 文件夹概念,因此规则会以 managed block 方式写入 AGENTS.md。
如果项目中已存在根 CLAUDE.md 与子目录 CLAUDE.md,应用 Codex 时根 AGENTS.md 会保持摘要指针,详细规则通过 CLAUDE 文档层级引用。
Backend Packs
npx ai-team-rules spring-boot --auto
npx ai-team-rules nestjs --auto别名:
npx ai-team-rules spring --auto
npx ai-team-rules nest --autoCommands
npx ai-team-rules <pack>
npx ai-team-rules apply <pack>
npx ai-team-rules list
npx ai-team-rules show <pack>Options
| 选项 | 说明 | 默认值 |
| --- | --- | --- |
| --auto | 为所选 pack 自动追加 docs | off |
| --tool <tool> | claude, codex, cursor, all | claude |
| --scope <scope> | project, global | pack 默认值 |
| --project-path <path> | 应用目标项目路径 | 当前路径 |
| --source-url <url> | 远程 packs.json URL | 默认 Directory URL |
Packs
| Pack | Scope | 说明 |
| --- | --- | --- |
| common | global | AI 基础规则 + 安全标准 + Git 工作流 |
| security | global | 前端/通用/AI 工具安全 |
| git-workflow | global | 提交信息 + PR/分支规则 |
| safety | global | 破坏性命令、Git、日志暴露安全 |
| react-ts | project | React + TypeScript 常驻规则 |
| spring-boot | project | Spring Boot 常驻规则 |
| nestjs | project | NestJS 常驻规则 |
| docs | project | 根文档路由 + AI 文档结构 skill |
Aliases
| 别名 | pack |
| --- | --- |
| base | common |
| security-standards | security |
| git, git-flow | git-workflow |
| harness, harness-safety | safety |
| react, react-typescript | react-ts |
| spring | spring-boot |
| nest | nestjs |
| document, documents, ai-instructions | docs |
