Turbo AI Rules

🚀 Sync AI coding rules from external Git repositories and automatically generate configuration files for various AI tools

English | 中文文档

✨ Features

• 🌐 Multi-Source Support - Sync rules from multiple Git repositories
• 🔄 Auto Sync - Schedule or manually sync rule updates
• 🎯 Smart Adapters - Generate configs for Cursor, Copilot, Continue, and custom tools
• 🔍 Rule Search - Quickly find and browse rules
• 🔐 Private Repos - Support Token authentication
• 📊 Visual Management - Tree view and status bar integration
• 🌍 Multi-Language - UI supports English/Chinese

🎨 Enhanced UI Features

• Welcome Page - First-launch guide with quick start steps and template library
• Statistics Dashboard - Visual analytics with charts, metrics, and export capabilities
• Rule Details Panel - Comprehensive rule inspector with metadata and content preview
• Advanced Search - Multi-criteria search with history, filters, and export (JSON/CSV)
• Rule Selection - Batch select rules via UI and sync to multiple adapters
• Tree View - Priority icons, tooltips, context menus (edit/test/toggle/copy/export)
• Status Bar - Multi-state indicator with progress feedback and quick actions

🚀 Quick Start

⚠️ Multi-root Workspace Limitation: This extension currently has limited support for multi-root workspaces. It's recommended to use it in single workspace environments. Learn more

1. Install Extension

Search for Turbo AI Rules in VS Code Extension Marketplace and install.

2. Add a Rule Source

Method 1: Via Status Bar

• Click Turbo AI Rules status bar icon → Select Add Source

Method 2: Via Command Palette

• Press Ctrl+Shift+P (Mac: Cmd+Shift+P)
• Type Turbo AI Rules: Add Source

Enter your Git repository information:

Repository URL: https://github.com/username/ai-rules.git
Branch:         main (optional)
Subpath:        rules (optional, e.g., rules or docs/rules)
Display Name:   My Rules (optional)
Access Token:   ghp_xxxx (for private repos only)

3. Sync Rules

After adding a source, sync is triggered automatically. You can also manually sync:

• Command Palette: Turbo AI Rules: Sync Rules
• Status Bar: Click Turbo AI Rules → Sync Rules

4. Verify Generated Files

Check your workspace root directory:

workspace/
├── .cursorrules  # ✅ Cursor config (generated by default)

Note: Only Cursor adapter is enabled by default. To use other AI tools, enable the corresponding adapters in settings (Command Palette: Turbo AI Rules: Manage Adapters).

📖 Documentation

📘 User Guide

• 📚 Complete User Guide - Detailed usage instructions
• 📋 01. Commands Reference - All available commands
• ⚙️ 02. Configuration Guide - Config options and examples
• 📝 03. Rule File Format - How to write rules
• ❓ 04. FAQ - Frequently asked questions

🛠️ Developer Guide (Chinese)

• 📐 Architecture Design
• 🔧 Development Guide
• 📦 Maintenance Guide

⚡ Core Concepts

Supported AI Tools

Rule File Format

The extension supports dual-mode parsing for flexibility and manageability:

Relaxed Mode (Default)

✅ Compatible with existing community rule files (e.g., awesome-cursorrules) ✅ Frontmatter is optional, supports pure Markdown files ✅ Automatically extracts metadata from filename/content

Standard format (Cursor/Copilot community standard):

---
description: TypeScript best practices guide
globs: **/*.{ts,tsx}
---

# TypeScript Best Practices

Use camelCase for variables...

Pure Markdown (no frontmatter):

# TypeScript Best Practices

Use camelCase for variables...

Strict Mode (Optional)

For enterprise-level rule library management requiring precise control:

---
id: typescript-naming      # Required: kebab-case format
title: TypeScript Naming   # Required
description: TypeScript best practices guide
globs: **/*.{ts,tsx}
priority: high             # Optional: low/medium/high
tags: [typescript, naming] # Optional
---

# TypeScript Naming Conventions

Use camelCase for variables...

Enable strict mode:

{
  "turbo-ai-rules.parser.strictMode": true,
  "turbo-ai-rules.parser.requireFrontmatter": true
}

📖 Detailed documentation: Rule File Format

🎯 Use Cases

• 📦 Team Collaboration - Share coding standards across team projects
• 🎓 Learning - Apply best practices from community rule repositories
• 🔄 Multi-Project - Sync same rules across multiple projects
• 🛠️ Custom Tools - Support any AI tool with custom adapters

⚠️ Known Limitations

Multi-root Workspace Support

This extension currently has limited support for multi-root workspaces (VS Code workspaces with multiple project folders).

Current Behavior:

• ✅ Extension can be activated in multi-root workspaces
• ⚠️ Only the first workspace folder will be used for operations
• ⚠️ User confirmation required before sync/generate operations
• ❌ Cannot guarantee correct behavior across all workspace folders

Recommended Usage:

• 📁 Use in single workspace environments for best experience
• 🔄 Open each project folder separately when using this extension

Why This Limitation?

• Rule selection state management becomes complex in multi-root scenarios
• Workspace context can be lost when switching between webviews and editors
• Maintaining simplicity and reliability for the primary use case

Future Plans: We may add full multi-root workspace support in future versions based on user feedback.

🤝 Contributing

Contributions are welcome! Please read our Contributing Guide.

Ways to contribute:

• 🐛 Report bugs via GitHub Issues
• 💡 Suggest features
• 📝 Improve documentation
• 🔧 Submit pull requests

📚 Resources

• 📖 Changelog - Version history
• ⚖️ License - MIT License
• 💬 Discussions - Q&A and ideas

📄 License

This project is licensed under MIT License. See LICENSE for details.

💬 Support

• 📧 Email: ygqygq2@qq.com
• 🐙 GitHub: @ygqygq2