Download the PHP package jpcaparas/rulesync without Composer

On this page you can find all versions of the php package jpcaparas/rulesync. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of jpcaparas/rulesync

Informations about the package rulesync

Rulesync

Tests Coverage

Easily sync all of your favourite AI instruction files (e.g. .cursorrules, copilot-instructions.md, GEMINI.md, CLAUDE.md, AGENTS.md, .clinerules/project.md).

https://github.com/user-attachments/assets/98604814-c0aa-450a-83a4-be522c1e4d72

Installation

Requirements: PHP 8.2+ is required for all installation options.

Choose the method that works best for your workflow:

Option 1: Standalone Executable (Recommended)

Download the pre-built executable - no Composer required!

Option 2: Global Composer Binary

Install globally via Composer (adds to your $PATH automatically):

Option 3: Development Dependency

Add to your project's development dependencies:

Quick Start

  1. Create a rulesync.md file with your rules
  2. Run rulesync generate to create all AI assistant rule files
  3. Your rules are now synced across Claude, Cursor, Windsurf, Gemini CLI, GitHub Copilot, OpenAI Codex, Cline, and Junie!

Commands

Supported AI Assistants

FAQ

Rule Augmentation

Q: How does local and global rule augmentation work?

A: Rulesync automatically detects whether you're in a local project (with composer.json) or global context. When both local (./rulesync.md) and global (~/.config/rulesync/rulesync.md) rule files exist, the system prompts you to:

Your preference is saved for future generate calls, but can be changed anytime.

Q: Can I disable certain AI assistants?

A: Yes! Use these commands:

Disabled assistants won't have their rule files generated during rulesync generate.

Q: How does overwrite protection work?

A: By default, Rulesync protects existing rule files by:

You can override this behaviour with:

Q: Can I use base rules from external sources?

A: Yes! The base rules system allows you to:

Base rules are appended to your final rule files after local/global augmentation.

Building Standalone Executable

You can build Rulesync as a standalone PHAR executable that doesn't require Composer on the target system (PHP 8.2+ is still required).

Prerequisites

Install Box globally:

Build Commands

Basic build:

Build with specific version:

Create full release (with tests):

Build with verbose output (for debugging):

Output

The standalone executable is created at builds/rulesync and includes all dependencies. You can distribute this single file without requiring users to install Composer or manage dependencies (PHP 8.2+ is still required).

Test the build:

Notes

License

MIT

All versions of rulesync with dependencies

PHP Build Version
Package Version
Requires php Version ^8.2
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package jpcaparas/rulesync contains the following files

Loading the files please wait ....