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

🚀 Quick Start

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 🤖 AI Rules 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)
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 🤖 AI Rules → Sync Rules

4. Verify Generated Files

Check your workspace root directory:

workspace/
├── .github/.copilot-instructions.md  # ✅ GitHub Copilot config (generated by default)

Note: Only GitHub Copilot adapter is enabled by default. To use other AI tools, enable the corresponding adapters in settings.

📖 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 (MDC)

Rules use MDC (Markdown + YAML Frontmatter) format:

---
id: typescript-naming
title: TypeScript Naming Conventions
priority: high
tags: [typescript, naming]
---

# TypeScript Naming Conventions

Use camelCase for variables...

🎯 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

🤝 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