SyncAI - Sync AI Rules Across All Your Dev Tools

   ███████╗██╗   ██╗███╗   ██╗ ██████╗     █████╗ ██╗
   ██╔════╝╚██╗ ██╔╝████╗  ██║██╔════╝    ██╔══██╗██║
   ███████╗ ╚████╔╝ ██╔██╗ ██║██║         ███████║██║
   ╚════██║  ╚██╔╝  ██║╚██╗██║██║         ██╔══██║██║
   ███████║   ██║   ██║ ╚████║╚██████╗    ██║  ██║██║
   ╚══════╝   ╚═╝   ╚═╝  ╚═══╝ ╚═════╝    ╚═╝  ╚═╝╚═╝

🔄 Sync AI agent rules across all your development tools

🤔 The Problem

Are you tired of maintaining separate instruction files for every AI code assistant? Do you find yourself copying and pasting the same rules across multiple files whenever you make updates?

✨ The Solution

SyncAI solves this by creating a single base rules file (default: .github/copilot-instructions.md) that automatically syncs to all your AI agent configuration files through symbolic links.

Edit once, update everywhere!

You can use the default or choose any custom file as your base (e.g., my-rules.md, llm-instructions.txt, etc.).

🚀 Quick Start

Installation

# Install globally via npm
npm install -g syncai

# Or using yarn
yarn global add syncai

# Or run directly with npx (no installation needed)
npx syncai

Install from source

# Clone the repository
git clone https://github.com/nxnom/syncai.git
cd syncai

# Install dependencies
yarn install

# Link globally
yarn link

Usage

# Interactive mode (recommended for first time)
syncai

# Skip all prompts and use defaults (.github/copilot-instructions.md as base)
syncai -y

In interactive mode, you'll be prompted to:

1. Enter your base rules file path (or press Enter for default)
2. Select which AI tool config files to symlink

📸 Demo

🤝 Contributing

We welcome contributions! If your favorite AI agent or code editor isn't supported yet, please create a Pull Request.

Adding Support for New AI Agents

1. Fork the repository
2. Edit cli.js and add your agent to the SYMLINK_OPTIONS array:

   const SYMLINK_OPTIONS = [
     { name: 'GEMINI.md', value: 'GEMINI.md' },
     { name: 'CLAUDE.md', value: 'CLAUDE.md' },
     // ... add your agent here
     { name: 'Your Agent Name', value: '.youragentfile' }
   ];

3. Submit a Pull Request with:
   • The agent/editor name
   • The expected file location
   • A link to documentation (if available)

Development

# Run locally
node cli.js

🔧 How It Works

1. Choose Base File: Select your base rules file (default: .github/copilot-instructions.md) or enter any custom path
2. Creates Base File: If it doesn't exist, SyncAI creates it with sensible defaults
3. Creates Symlinks: Selected AI tool config files are symlinked to your base file
4. Updates .gitignore: Optionally adds symlinked files to .gitignore
5. Single Edit Point: Edit your base file and all symlinked files update automatically

📄 License

MIT License - see LICENSE file for details

🐛 Issues & Feature Requests

Found a bug or have a feature request? Please open an issue.