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

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?

SyncAI solves this by creating a single Rules.md file that automatically syncs to all your AI agent configuration files through symbolic links.

Edit once, update everywhere!

# 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

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

# Install dependencies
yarn install

# Link globally
yarn link

# Interactive mode (recommended for first time)
syncai

# Skip all prompts and use defaults
syncai -y

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

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

   const SYMLINK_OPTIONS = [
     // ... existing options
     { 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)

# Run locally
node cli.js

1. Creates Rules.md: If it doesn't exist, AGRG creates it with sensible defaults
2. Creates Symlinks: Selected files are symlinked to Rules.md
3. Updates .gitignore: Optionally adds symlinked files to .gitignore
4. Single Edit Point: Edit Rules.md and all symlinked files update automatically

MIT License - see LICENSE file for details

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