AI Project Rules Generator

🚀 Workflow for generating .cursorrules and AGENTS.md files with dynamic AI skills integration
Explore the docs »

View Example · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Key Features
   • Supported Project Types
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Workflow Stages
5. Example Output
6. Roadmap
7. Contributing
8. License
9. Contact
10. Acknowledgments

About The Project

A structured 5-stage workflow for creating professional project rules (.cursorrules) and AI agent guidelines (AGENTS.md). This workflow helps you establish consistent coding standards across all your projects while ensuring AI assistants understand your codebase.

Why Use This?

• ✅ Consistent Standards - Same structure across all projects
• ✅ AI-Ready - AI assistants understand your codebase better
• ✅ Dynamic Skills - Never outdated with dynamic skill discovery
• ✅ Time-Saving - Complete in 30-60 minutes
• ✅ Best Practices - Built from proven patterns

(back to top)

Key Features

Feature	Description
5-Stage Workflow	Structured process with time estimates
Keyword Tables	Easy skill discovery by project type

| Verification Checklist | Ensure quality with reader testing | | Quick Reference Card | At-a-glance summary for fast execution |

Supported Project Types

• 🌐 Web Frontend - React, Vue, Angular, Next.js
• ⚙️ Backend API - Node.js, Python, Go, Rust
• 🧩 Chrome Extensions - Manifest V3
• 📱 Mobile Apps - React Native, Flutter
• 💻 CLI Tools - Bash, PowerShell
• 🤖 AI/ML Projects - LLM, RAG, Agents
• 🎮 Game Development - Unity, Godot, Unreal

(back to top)

Getting Started

Prerequisites

• An AI assistant that supports skills (Cursor, Claude, etc.)
• Access to .agent/skills/CATALOG.md (skill library)
• Your project source code

Installation

1. Download the workflow file to your project:

   curl -o .agent/workflows/create-project-rules.md https://raw.githubusercontent.com/naravid19/ai-project-rules-generator/main/workflows/create-project-rules.md

   (Ensure you have an .agent/workflows directory first)

(back to top)

Usage

Quick Start

Run the workflow with your AI assistant:

/create-project-rules

Or simply ask:

"Create professional project rules for this project"

Manual Execution

1. Open .agent/workflows/create-project-rules.md
2. Follow the 5 stages step by step
3. Get .cursorrules and AGENTS.md tailored to your project

(back to top)

Workflow Stages

┌─────────────────────────────────────────────────────────┐
│           CREATE PROJECT RULES - QUICK REF              │
├─────────────────────────────────────────────────────────┤
│ Stage 1: Analyze         │ Config, Tech Stack, Patterns │
│ Stage 2: Skills          │ Search CATALOG.md + Read     │
│ Stage 3: .cursorrules    │ Standards, Rules, Examples   │
│ Stage 4: AGENTS.md       │ Skills section (dynamic!)    │
│ Stage 5: Verify          │ Checklist + Reader Test      │
├─────────────────────────────────────────────────────────┤
│ ⏱️  Total Time: 30-60 minutes                           │
└─────────────────────────────────────────────────────────┘

Stage	Time	Description
1. Project Analysis	10-15 min	Understand structure, tech stack, patterns
2. Skill Discovery	5-10 min	Search CATALOG.md for relevant skills
3. Create .cursorrules	10-20 min	Write coding standards and rules
4. Create AGENTS.md	5-10 min	Write AI guidelines with dynamic skills
5. Verification	5 min	Checklist and reader testing

(back to top)

Example Output

.cursorrules (excerpt)

# Project Rules: My Chrome Extension

## Tech Stack

- Language: JavaScript (ES2020+)
- Platform: Chrome Extension (Manifest V3)

## Critical Rules

1. ❌ Never use `localStorage` - use `chrome.storage` instead
2. ✅ Always check `chrome.runtime.lastError` after API calls

AGENTS.md (excerpt)

## 🎯 Available Skills

> [!IMPORTANT]
> Always check `.agent/skills/CATALOG.md` before starting any task!

### Helpful Keywords

- Extension: `browser`, `extension`, `chrome`, `manifest`
- Testing: `testing`, `jest`, `unit`

(back to top)

Roadmap

• Core workflow with 5 stages
• Time estimates for each stage
• Example outputs
• Quick reference card
• Add more project type examples
• Visual diagram for workflow
• Multi-language support

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

naravid19 - GitHub Profile

Project Link: https://github.com/naravid19/ai-project-rules-generator

(back to top)

Acknowledgments

• Best-README-Template
• Cursor IDE
• Anthropic Claude
• Img Shields
• Antigravity

(back to top)