fruitcake/magento2-ai-guidelines

Generate AI Guidelines for Magento 2 projects.

Installs: 2

Dependents: 0

Suggesters: 0

Security: 0

Stars: 5

Watchers: 1

Forks: 1

Open Issues: 0

pkg:composer/fruitcake/magento2-ai-guidelines

v0.1.1 2025-11-27 15:58 UTC

This package is auto-updated.

Last update: 2025-11-27 15:59:47 UTC


README

Generate a CLAUDE.md file with project context for AI assistance.

Installation

Option 1: Install via Composer in your project

  • composer require fruitcake/magento2-ai-guidelines
  • php bin/magento module:enable Fruitcake_AiGuidelines

Option 2: Install as Magerun2 module:

  • Clone this library in ~/.n98-magerun2/modules

Usage

Generate the CLAUDE.md file at project root:

bin/magento ai:generate-context

This creates a CLAUDE.md file containing:

  • System information (Magento version, PHP version, OS)
  • Theme information (Hyva detection)
  • Installed modules (custom and third-party)
  • Project structure hints
  • Magento best practices

Customization

To customize the generated CLAUDE.md file, edit CLAUDE.md outside the <magento-ai-guidelines> tags.

Then regenerate:

bin/magento ai:generate-context

Ideas

  • Add docs based on installed packages/versions
  • Add skills