使用说明
AI Project Rules Generator
Orchestrate professional .cursorrules and AGENTS.md with deterministic JIT skill discovery.
AI项目规则生成器是一种生产级AI代理技能,旨在解决 上下文膨胀 和 特工漂流 在人工智能辅助开发方面。通过利用 确定性JIT(准时制)检索,它会自动从您的本地环境中发现并集成相关的AI技能,而不会使LLM的上下文窗口饱和。
快速入门
给你的项目制定专业的人工智能规则: 克劳德代码 | 双子星命令行工具 | Codex 命令行界面 | 本地安装
运作原理
它从您启动编码代理并要求它生成项目规则的那一刻开始。生成器不会将整个技能文件夹转储到您的上下文窗口中,而是后退并索引本地、全局和远程环境中的可用技能。
一旦它理解了项目的意图(例如前端、后端、UI设计),它就会使用 语义回退 通过模糊匹配动态选择 五大最相关技能.
然后,它将这些编译成高度结构化的 .cursorrules 或 AGENTS.md 文件,为您的AI助手提供自主工作所需的确切约束、设计令牌和架构模式,而不会超出其令牌限制。
安装
安装因线束而异。如果使用多个发电机,请为每个发电机单独安装。
克劳德代码
生成器可以直接通过Claude的插件管理器安装:
/plugin install https://github.com/naravid19/ai-project-rules-generator
双子星命令行工具
通过Gemini的本地扩展管理器全局安装生成器:
gemini extensions install https://github.com/naravid19/ai-project-rules-generator
Codex 命令行界面
通过Codex扩展管理器安装生成器:
codex extensions install https://github.com/naravid19/ai-project-rules-generator
本地安装
如果您更喜欢手动或通过shell脚本直接将生成器安装到您的工作区中:
Linux/macOS:
curl -sL https://raw.githubusercontent.com/naravid19/ai-project-rules-generator/main/setup.sh | bash
Windows(PowerShell):
irm https://raw.githubusercontent.com/naravid19/ai-project-rules-generator/main/setup.ps1 | iex
用法
只需让你的人工智能助手生成规则,它就会自动调用该技能。
基本调用:
“请使用Superpowers方法为此存储库生成项目规则。”
显式调用:
“@SKILL.md,请生成我的项目规则。”
🗺️ 多源技能图谱
您可以从多个范围配置、索引和查询技能: 本地 (项目层面), 全球 (机器级别),以及 远程 (按需克隆的git存储库)。
v1.9.5中的新功能: 发动机功能强大 容错.远程源安全地回退到本地脱机 .cache 如果发生网络超时,则进行复制,确保您的代理在工作流程中永远不会中断。
1.配置 .rulesrc.yaml
skill_sources:
- path: ".agent"
confirmed: true
type: local
source_name: project-local
- path: "https://github.com/obra/superpowers.git"
type: remote
source_name: community-skills
2.运行多源索引器
python scripts/indexer.py --unified --skill-map
这为JIT引擎生成了一个统一的JSON目录和一个人类可读的JSON目录 skill_map.md.
架构和数据流
目录结构
ai-project-rules-generator/
├── SKILL.md # The core autonomous agent workflow instructions
├── scripts/ # Enhanced execution scripts (Mode A)
│ ├── indexer.py # Builds skill_catalog.json and skill_map.md
│ ├── wizard.py # Interacts with rules generation
│ ├── rules_config.py # Configuration parsing logic
│ └── remote_source.py# Git-based remote source caching
├── tests/ # Comprehensive Pytest suite
└── setup.sh / ps1 # Installation scripts
请求的生命周期
- 用户意图:用户要求AI生成规则。
- JIT路由:AI解析
SKILL.md并阅读.rulesrc.yaml. - 多源索引:
scripts/indexer.py将技能聚合和重复数据消除到一个轻量级的JSON目录中。 - 语义匹配:AI使用同义词匹配和精确的单词边界将用户的意图与目录进行交叉引用。
- 规则生成:高保真度
.cursorrules和AGENTS.md根据匹配的前5项技能起草。 - 审计检查:执行日志和决策推理被安全地写入
.agent/logs/.
测试
本项目严格遵守 测试驱动开发(TDD) 并保持跨容错和核心特征的稳健测试覆盖率。
确保你有 pytest 安装后,运行测试套件:
# Run all tests natively
py -m pytest tests/ -v
# Run with coverage
py -m pytest tests/ --cov=scripts --cov-report=term-missing
故障排除
- 特工炫耀不正确的技能:确保AI正确调用技能。在提示中明确提及技能文件:
"Using @SKILL.md, regenerate the project rules. Strictly adhere to the JIT Retrieval constraint." - 安装脚本失败:确保您使用的是现代终端(Git Bash、WSL或本机macOS终端)。如果
curl缺少,请手动下载文件。 - 缓存发现错误:确保您正在跑步
v1.9.5或稍后。早期版本存在一个问题,即远程技能被克隆到.cache被索引器跳过。
许可证
根据MIT许可证分发。看 LICENSE 了解更多信息。