Pair

This project is a work in progress, some of the features may not be fully implemented yet, and the API may change in future releases.

Pair stands for Protocol for AI Rules, and it aims to provide a standardized way to define and manage rules for AI editor/agents, ensuring you only maintain one set of AI rules under .ai folder, which can be used by multiple AI editors/agents.

Requires PHP 8.3+

#Installation

You may install Pair using Composer:

composer require nunomaduro/pair --dev

#Usage

Supports: Cursor, Junie, Windsurf, and Cline.

You may run Pair using the pair command. Initially, this command will create a .ai directory in your project root, which will contain the configuration files for your AI rules.

./vendor/bin/pair install

Pair will add .cursor, .junie, etc, files to your project .gitignore file, if it exists, to prevent these files from being committed to your version control system.

Also, Pair will automatically add ./vendor/bin/pair sync to your composer.json file under the scripts section, allowing you to run the sync command on every composer install or composer update command. This ensures that the AI rules are always in sync with the editors or agents you are using.

Of course, you can run the sync command manually at any time:

./vendor/bin/pair sync

Pair was created by Nuno Maduro under the MIT license.