Devtify Rule - Workspace Initializer

A command-line tool to initialize a complete development workspace with Cursor AI rules, VSCode configuration, and documentation structure.

Installation

npm install -g devtify-rule

Usage

Navigate to your project directory and run:

npx devtify-rule

This will create a complete workspace structure with:

What Gets Created

📁 .cursor/rules/

Organized Cursor AI rules by category:

• core-rules/ - Cursor agent behavior and rule generation
• technical-standard/ - Code standards and development practices
• my-rules/ - Personal rules (gitignored)
• global-rules/ - Rules applied to every chat
• testing-rules/ - Testing standards and practices
• tool-rules/ - Tool-specific usage rules
• ts-rules/ - TypeScript language rules
• py-rules/ - Python language rules
• ui-rules/ - HTML, CSS, React rules

⚙️ .vscode/

VSCode configuration:

• settings.json - Editor settings with Cursor optimizations
• extensions.json - Recommended extensions

📚 docs/

Documentation structure:

• standards/ - Code standards, git commit guidelines, task breakdown
• brd/ - Business Requirements Documents
• tdd/ - Technical Design Documents
• api/ - API documentation

Features

• 🚀 Complete workspace setup in seconds
• 📋 Standardized project structure across teams
• 🤖 Cursor AI optimized rules and settings
• 📖 Documentation templates ready to use
• 🔧 VSCode configuration with best practices
• 🎯 Personal rules support with gitignore

Rule System

The rule system follows a structured approach:

Rule Types

• Always Rules (-always.mdc) - Applied to every chat
• Auto Rules (-auto.mdc) - Applied to specific file patterns
• Agent Rules (-agent.mdc) - Applied when context matches
• Manual Rules (-manual.mdc) - Manually triggered

Rule Structure

---
description: When and why to apply this rule
globs: *.ts, *.tsx (optional)
alwaysApply: true/false
---

# Rule Title

## Critical Rules
- Actionable bullet points

## Examples
<example>
Valid usage example
</example>

<example type="invalid">
Invalid usage example
</example>

Development

# Clone the repository
git clone <repo-url>
cd devtify-rule

# Install dependencies
npm install

# Test locally
node bin/devtify-rule.js

# Publish
npm publish

License

MIT