pepperfm/ai-guidelines

Personal Codex/Boost AI guidelines installer (symlink/copy into .ai/guidelines)

Maintainers

Details

github.com/pepperfm/ai-guidelines

Source

Issues

Installs: 4

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 0

Forks: 0

Open Issues: 0

pkg:composer/pepperfm/ai-guidelines

1.1.0 2025-12-13 23:48 UTC

Requires

MIT 5c3489064a8d5a1b1457c36dc42b13617f36832e

This package is auto-updated.

Last update: 2025-12-13 23:48:41 UTC

README

Небольшой Composer‑пакет для установки личных AI‑гайдлайнов (Codex / Boost) в проект.

Пакет хранит 3 пресета (по одному core.md):

  • laravel — Codex — Laravel/Sail/MCP Guidelines (Personal Overrides)
  • nuxt-ui — Nuxt UI — Project Guidelines (Laravel 12 + Vite + Inertia + Tailwind v4)
  • element-plus — Element Plus + Vue 3

CLI умеет:

  • выбрать пресеты интерактивно (Laravel Prompts),
  • создать symlink или copy в .ai/guidelines/...,
  • (опционально) запустить php artisan boost:update, если проект Laravel.

Установка

composer r --dev pepperfm/ai-guidelines

Быстрый старт (интерактивно)

Из корня проекта:

vendor/bin/pfm-guidelines
# или
vendor/bin/pfm-guidelines init

Команда:

  1. спросит какие пресеты подключить,
  2. спросит режим (symlink/copy),
  3. спросит путь назначения (по умолчанию: .ai/guidelines),
  4. создаст/обновит файлы вида:
.ai/guidelines/laravel/core.md
.ai/guidelines/nuxt-ui/core.md
.ai/guidelines/element-plus/core.md

Также создаст конфиг в корне проекта: .pfm-guidelines.json.

Синхронизация (после composer update)

vendor/bin/pfm-guidelines sync

Без интерактива (CI / scripts)

vendor/bin/pfm-guidelines sync --no-interaction --mode=copy --presets=laravel,element-plus

Доступные параметры:

  • --presets=laravel,nuxt-ui,element-plus
  • --mode=symlink|copy
  • --target=.ai/guidelines
  • --force (перезаписывать существующие файлы)
  • --dry-run (ничего не менять, только показать действия)
  • --config=.pfm-guidelines.json (путь к конфигу)

Связка с Boost / Codex

Если проект использует Laravel Boost, то после установки гайдлайнов можно выполнить:

php artisan boost:update

Boost прочитает .ai/guidelines/* и пересоберёт AGENTS.md и другие файлы.

Команды

  • pfm-guidelines (без аргументов) → alias для init
  • pfm-guidelines init → интерактивная настройка + sync
  • pfm-guidelines sync → применить конфиг/параметры, создать symlink/copy
  • pfm-guidelines list → показать доступные пресеты
  • pfm-guidelines help → справка