cursor-rules
pekral · pekral/cursor-rules
This Composer plugin installs a complete set of .cursorrules files and 62 agent skills for Cursor, Claude Code, and Codex, providing coding standards, testing conventions, and automated workflows for PHP and Laravel projects.
PHP and Laravel Cursor rules — coding standards, testing, and conventions for the Cursor editor. Install via Composer.
Preview
What you can do with it
- Enforce consistent PHP coding standards across a Laravel project using Cursor rules.
- Automate code reviews and bug fixing in Claude Code by leveraging the provided agent skills.
- Set up comprehensive testing conventions in a PHP project, ensuring 100% code coverage with AI assistance.
Safety check
No risky patterns found in the files we scanned.
Automated scan of the repo files. Always review code you run.
From the README
Cursor Rules for PHP and Laravel — Composer Plugin
Cursor rules for PHP and Laravel — a Composer plugin for PHP/Laravel projects that installs a complete set of .mdc rule files and Agent skills for Cursor, Claude Code, and Codex. One package for PHP and Laravel cursor rules: coding standards, testing, and conventions. The installer discovers the project root (via composer.json lookup from the current directory), mirrors the rules/ directory into the editor's rules path and the skills/ directory into the editor's skills path, and copies or symlinks every file into the target project. Use cursor rules for PHP and Laravel to keep every edit aligned with enforced standards, plus comprehensive Agent skills for issue resolution, bug fixing, code review, security analysis, refactoring, testing, frontend and UI, platform and data, and package review.
Why This Package
- a Composer plugin: PHP/Laravel cursor rules + agent skills in one
composer require --devpackage - unified PHP coding guidelines for PHP 8.4 projects
- Pest-based testing with mandatory code analysis and 100% coverage
- strong focus on clean code: typed properties, SRP, no redundant comments
- 62 comprehensive Agent skills for automated workflows (v0.9.1)
- fast onboarding inside development repositories
Installation
composer require pekral/cursor-rules --dev
vendor/bin/cursor-rules install --editor=cursor
The --editor flag is required. Use it to choose the target agent:
- cursor:
.cursor/rules,.cursor/skills - claude:
.claude/rules,.claude/skills, and whenHOME/USERPROFILEis set also~/.claude/skills - codex:
.codex/rules,.codex/skills, and whenHOME/USERPROFILEis set also~/.codex/skills - all: all of the above (Cursor, Claude, Codex in project + home)
Editor compatibility
| Feature | Cursor | Claude | Codex |
|---|---|---|---|
| Rules | ✅ | ✅ | experimental / unverified |
| Skills | ✅ | ✅ | ✅ |
Codex rules support is listed as experimental / unverified — the installer copies the files into .codex/rules, but native rule loading by Codex has not been confirmed; report your findings in #663.
When the package is required via Composer, sources are read from vendor/pekral/cursor-rules/rules and vendor/pekral/cursor-rules/skills.
Important: By default, the installer only copies missing files and keeps existing content untouched. Use the --force flag to overwrite existing files: vendor/bin/cursor-rules install --force. This is particularly useful when you want to update rules to their latest versions or when you've made local changes that should be replaced. The file .cursor/rules/project.mdc and CLAUDE.md are never overwritten once they exist in the target project, so you can safely customize them.
Automatic Installation via Composer Plugin
By default, the Composer plugin does not auto-install rules on composer install or composer update. To enable automatic installation, add the following to your project's composer.json:
{
"extra": {
"cursor-rules": {
"auto-install": true,
"editor": "claude"
}
}
}
| Option | Description | Default |
|---|---|---|
auto-install | Enable automatic install on composer install/update. | false |
editor | Target editor for auto-install (cursor, claude, codex, all). | cursor |
If you prefer manual control, simply call vendor/bin/cursor-rules install in your Composer post-update-cmd scripts with the desired flags.
Installing rules from GitHub (Cursor only)
You can use this repository as a Remote Rule in Cursor without installing the package via Composer:
- Open Cursor Settings → Rules.
- In the Project Rules section, click Add Rule.
- Select Remote Rule (Github).
- Enter the repository URL:
https://github.com/pekral/cursor-rules.
Cursor will fetch and apply the rules from the repository. Note: this method provides rules only; Agent skills are installed into your project when you use the Composer-based installation above.
Available Commands
vendor/bin/cursor-rules help # print help
vendor/bin/cursor-rules install --editor=cursor # install for Cursor
vendor/bin/cursor-rules install --editor=claude # install for Claude
vendor/bin/cursor-rules install --editor=codex # install for Codex
vendor/bin/cursor-rules install --editor=all # install for Cursor, Claude, and Codex
vendor/bin/cursor-rules install --editor=cursor --force # overwrite existing files
vendor/bin/cursor-rules install --editor=cursor --symlink # prefer symlinks (fallback to copy)
vendor/bin/cursor-rules install --editor=claude --allow-bundled-scripts # whitelist this package's bundled scripts in ~/.claude/settings.json
Installer Flow
- Determine the project root by walking up from the current directory until
composer.jsonis found. - Resolve the rules source (local
rules/orvendor/pekral/cursor-rules/rules). - Install rules into the target directory(ies) for the chosen editor (see
--editor). - If present, resolve the skills source and install into the corresponding skill directory(ies).
- For
--editor=claudeor--editor=all: copyCLAUDE.mdto the project root (never overwrites existing). - Optionally overwrite existing files with
--force; use--symlinkto prefer symlinks (fallback to copy on Windows). - Surface explicit errors for missing directories, removal failures, and copy/symlink failures.
CLI Switches
| Option | Description | |------------------