Syncai

SyncAI - Sync AI Rules Across All Your Dev 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 f