AI Project Rules Generator

     

🤖 AI Project Rules Generator

🚀 Orchestrate professional .cursorrules and AGENTS.md with deterministic JIT skill discovery.

Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

Project Overview

Tech Stack

Prerequisites

Getting Started

Usage Guide

Architecture

Available Scripts

Troubleshooting

Roadmap

Contributing

License

项目概述

AI项目规则生成器是一种生产级AI代理技能，旨在解决 上下文块 和 特工漂流 在人工智能辅助开发方面。通过利用 确定性JIT（准时制）检索，它会自动从您的本地环境中发现并集成相关的AI技能，而不会使LLM的上下文窗口饱和。

此存储库提供统一的 SKILL.md 与所有主要代理IDE（Cursor、Claude Code、Antigravity、Gemini CLI、Copilot）兼容的工作流，可无缝生成 .cursorrules 和 AGENTS.md 上下文规则。

主要特点

• 多平台支持：生成与9+平台（Cursor、Claude Code等）兼容的配置。
• 确定性JIT发现：通过语义回退只加载前5个相关技能，而不是将所有内容都转储到上下文窗口中。
• 双模式执行：通过本机LLM推理（零安装模式B）或通过Python启发式（增强模式A）进行操作。
• 子代理驱动：旨在充分利用超级大国框架和Andrej Karpathy的方法论。

______________________________________________________________________

技术栈

• 技能定义：Markdown（YAML Frontmatter+Prompt Engineering）
• 安装脚本：Bash和PowerShell
• 增强的索引：Python 3.10+（可选）
• 目标环境：游标、克劳德代码、反重力IDE、Gemini CLI、OpenCode

______________________________________________________________________

先决条件

在使用此技能之前，请确保您已经：

• 能够读取工作区文件的AI助手（例如，Cursor IDE、Claude Code CLI、Gemini CLI）。
• 本地人 .agent/ 或 .cursor/skills/ 包含技能库的目录。
• curl 和 bash （Linux/macOS）或 PowerShell （Windows）用于安装脚本。

______________________________________________________________________

入门指南

选择最适合您的安全和工作流程要求的安装方法。

选项1：快速安装（推荐）

开始使用我们的自动设置脚本的最快方法。这会将技能直接安装到您当前的目录中。

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

选项2：安全/手动安装

对于在执行前必须检查代码的具有安全意识的企业环境：

Linux/macOS：

curl -sO https://raw.githubusercontent.com/naravid19/ai-project-rules-generator/main/setup.sh
# Inspect setup.sh here
chmod +x setup.sh
./setup.sh

选项3：直接技能整合

如果您更喜欢不执行本地shell脚本的零接触方法：

mkdir -p .agent/generating-project-rules
curl -sL -o .agent/generating-project-rules/SKILL.md https://raw.githubusercontent.com/naravid19/ai-project-rules-generator/main/SKILL.md

______________________________________________________________________

使用指南

只需让你的人工智能助手生成规则，它就会自动调用该技能。我们建议使用与超级大国方法相一致的自然语言提示。

基本调用

"Please generate project rules for this repository using the Superpowers methodology."

显式调用

"@SKILL.md please generate my project rules."

高级工作流

要获得最先进的体验，请确保您拥有 超能力技能 本地安装。

1. 请求生成：要求AI根据项目状态起草规则。
2. JIT检索：AI将扫描 .agent 目录，使用语义匹配最多选择5个相关技能，并加载其内容。
3. 审计与输出：AI将起草 .cursorrules 和 AGENTS.md 并将其推理记录在 .agent/logs/.

______________________________________________________________________

建筑

该项目以标准代理技能的形式构建，主要由核心驱动 SKILL.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
│   ├── wizard.py       # Interacts with rules generation
│   └── lib/            # Shared Python libraries
├── setup.sh            # Unix installation script
├── setup.ps1           # Windows installation script
├── README.md           # This file
└── CHANGELOG.md        # Version history

执行模式

灵活代理引擎（v1.9.4）支持 双模式执行:

1. 模式A（增强型）：利用 scripts/ 包含Python/PowerShell/Bash脚本的目录，用于高性能、令牌高效的索引。它需要本地Python安装来解析依赖关系和令牌 ThreadPoolExecutor.
2. 模式B（自主）：零安装模式，AI解释 SKILL.md 本机无需依赖外部依赖。LLM本机执行目录扫描和语义匹配。

代理对齐原则

该工具执行源自世界级人工智能工程方法的高保真标准：

• 安德烈·卡尔帕西的方法论：优先考虑“简单第一”、“手术改变”和“编码前思考”逻辑。
• 超级大国框架：实施“完成前验证”和“子代理驱动开发”。

______________________________________________________________________

可用脚本

______________________________________________________________________

故障排除

安装脚本失败

错误： curl: command not found 或 irm: command not found 解决方案： 确保您使用的是现代终端（适用于Linux/Mac的Git Bash、WSL或本机macOS终端；适用于Windows的PowerShell 5.1+）。如果 curl 如果缺少，请使用选项3（直接集成）手动下载文件。

人工智能显示错误的技能

错误： 生成的 .cursorrules 包含不存在的库或无效的技能名称。 解决方案： 确保AI正确调用技能。在提示中明确提及技能文件： "Using @SKILL.md, regenerate the project rules. Strictly adhere to the JIT Retrieval constraint."

旧的工作流程依然存在

错误： AI不断引用 .agent/workflows/create-project-rules.md. 解决方案： 您使用的是旧版本。重新运行v1.9.4安装脚本(setup.sh 或 setup.ps1)，其中包含自动清理逻辑，用于删除已弃用的 workflows/ 目录。

______________________________________________________________________

路线图

• \[x\] 多平台支持（9+工具）
• \[x\] 深度上下文节省（指针系统）
• \[x\] 并行索引（线程池执行器）
• \[x\] 系统调试（堆栈跟踪审计）
• \[x\] 精确的单词边界标记（\\bregex\\b）
• \[x\] 重构到根级别 SKILL.md （v1.9.4）
• \[\]多智能体仿真环境
• \[\]基于Web的配置UI

看 未解决的问题 查看建议功能的完整列表。

______________________________________________________________________

贡献

1. 分叉项目
2. 创建功能分支(git checkout -b feature/AmazingFeature)
3. 提交您的更改(git commit -m 'Add some AmazingFeature')
4. 推到分支机构(git push origin feature/AmazingFeature)
5. 打开拉取请求

______________________________________________________________________

许可证

根据MIT许可证分发。看 LICENSE 了解更多信息。

______________________________________________________________________