chrisshick / cakephp-agent
AI engineering knowledge platform for CakePHP 5 — rules, skills, extensions, and installer for Cursor, Claude Code, and Codex.
Requires
- php: ^8.2
- composer/semver: ^3.4
Requires (Dev)
- phpstan/phpstan: ^2.1
- phpunit/phpunit: ^11.5
This package is auto-updated.
Last update: 2026-08-11 20:38:13 UTC
README
AI engineering knowledge for CakePHP 5.x — rules, skills, agents, and a safe installer for Cursor, Claude Code, and Codex.
Status: 1.0.0-beta.2 (public beta — not stable 1.0 yet). On Packagist:
chrisshick/cakephp-agent. License: Apache-2.0. Soak then stable1.0.0— HANDOFF, pre-1.0.
Repository: github.com/chrisShick/cakephp-agent
What this is
Canonical CakePHP engineering knowledge (decisions, smells, workflows) delivered as editor rules/skills/agents — with behavioral evaluation fixtures for maintainers. Not “Laravel tips rewritten for CakePHP.”
Offline eval self-checks prove fixture/scorer plumbing. They are not live model quality scores.
Requirements
- PHP 8.2+
- Composer 2
- CakePHP 5.x application (for install targets)
Install into an existing CakePHP app
Follow docs/install-existing-app.md.
Quick start (Packagist):
composer require --dev chrisshick/cakephp-agent:^1.0@beta vendor/bin/cakephp-agent doctor vendor/bin/cakephp-agent install --editor=cursor --dry-run --verbose vendor/bin/cakephp-agent install --editor=cursor
After stable 1.0.0: composer require --dev chrisshick/cakephp-agent:^1.0
Codex gets rules/skills only (no agents directory).
CLI
vendor/bin/cakephp-agent help vendor/bin/cakephp-agent install --editor=cursor vendor/bin/cakephp-agent uninstall --editor=all --dry-run vendor/bin/cakephp-agent detect vendor/bin/cakephp-agent extensions vendor/bin/cakephp-agent explain vendor/bin/cakephp-agent doctor vendor/bin/cakephp-agent validate vendor/bin/cakephp-agent eval
Install options
| Flag | Meaning |
|---|---|
--editor=cursor|claude|codex|all |
Target editor layout(s) |
--extension=ID |
Force-enable extension (repeatable) |
--without=ID |
Force-disable extension (repeatable) |
--force |
Overwrite managed / conflicting files |
--symlink |
Symlink package files instead of copying (Unix) |
--prune |
Remove previously managed files no longer present |
--dry-run |
Plan only |
--project=PATH |
Explicit project root |
--verbose |
Show skipped actions too |
Safety
- Project-owned overlays live under
.ai/and are never overwritten or uninstalled. - Managed files are tracked in
.cakephp-agent.lock.json. --prune/uninstallonly delete paths recorded in that lock file.
Configuration
Optional composer.json:
{
"extra": {
"cakephp-agent": {
"editor": "cursor",
"extensions": {
"enable": [],
"disable": []
}
}
}
}
Or .cakephp-agent.json in the project root (overrides extra).
Precedence: CLI flags > .cakephp-agent.json > composer.json extra > defaults.
Documentation
| Doc | Topic |
|---|---|
| Install into existing app | Composer require, dry-run, upgrade, uninstall |
| Editors | Cursor / Claude / Codex paths |
.ai overlays |
Project-owned conventions |
| Extension authoring | Writing packs |
| Troubleshooting | Common failures |
| Evaluation baselines | Maintainer eval runner |
| Architecture | Platform shape |
| Pre-1.0 review | Gap backlog |
| Rules & skills coverage | CakePHP coverage audit |
| Phase 14b handoff | ORM-first polish → soak → stable 1.0 |
Package development
git clone https://github.com/chrisShick/cakephp-agent.git cd cakephp-agent composer install composer test composer phpstan php bin/cakephp-agent validate php bin/cakephp-agent eval
See CONTRIBUTING.md.