Package Exports

syncai
syncai/cli.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (syncai) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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 Rules.md file that automatically syncs to all your AI agent configuration files through symbolic links.

Edit once, update everywhere!

🚀 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
syncai -y

📸 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

Fork the repository

Edit cli.js and add your agent to the SYMLINK_OPTIONS array:

const SYMLINK_OPTIONS = [
  // ... existing options
  { name: 'Your Agent Name', value: '.youragentfile' }
];

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

Creates Rules.md: If it doesn't exist, AGRG creates it with sensible defaults
Creates Symlinks: Selected files are symlinked to Rules.md
Updates .gitignore: Optionally adds symlinked files to .gitignore
Single Edit Point: Edit Rules.md 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.

Made with ❤️ by developers, for developers