PHPackages                             crealoz/easy-audit-free - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [CLI &amp; Console](/categories/cli)
4. /
5. crealoz/easy-audit-free

Abandoned → [crealoz/easyaudit-cli](/?search=crealoz%2Feasyaudit-cli)Magento2-module[CLI &amp; Console](/categories/cli)

crealoz/easy-audit-free
=======================

A tool that permits to run different types of audits in Magento 2.

0.4.5(7mo ago)191834[3 PRs](https://github.com/crealoz/easy-audit-free/pulls)MITPHPPHP ^8.1CI passing

Since Jan 23Pushed 3mo ago1 watchersCompare

[ Source](https://github.com/crealoz/easy-audit-free)[ Packagist](https://packagist.org/packages/crealoz/easy-audit-free)[ Docs](https://crealoz.fr/crealoz-easy-audit/)[ RSS](/packages/crealoz-easy-audit-free/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (8)Dependencies (2)Versions (12)Used By (0)

EasyAudit Module
================

[](#easyaudit-module)

[![Latest Stable Version](https://camo.githubusercontent.com/768b578c6adf5746a2567cafd68c1060b827e5e85dd1254c36d553f3a7e4330c/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f637265616c6f7a2f656173792d61756469742d667265652e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/crealoz/easy-audit-free)[![License: MIT](https://camo.githubusercontent.com/37c9c236e0b50f79dea4f9cc90a736325edd2e4e14dae366131914f7bb1b684e/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f637265616c6f7a2f656173792d61756469742d667265652e7376673f7374796c653d666c61742d737175617265)](./LICENSE)[![Packagist](https://camo.githubusercontent.com/3604062d38ea9c4655dd227c894dd7c39c2ae42ec9267f8a73c1c4b28cbe865e/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f637265616c6f7a2f656173792d61756469742d667265652e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/crealoz/easy-audit-free/stats)[![Packagist](https://camo.githubusercontent.com/9554bf218de169b4258e11a8bdf5df42cf6ea3fedc570cc3b32c2709decb8acb/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f646d2f637265616c6f7a2f656173792d61756469742d667265652e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/crealoz/easy-audit-free/stats)[![codecov](https://camo.githubusercontent.com/69c4ea5bd1a1db88696b2f5c1cf1ab97d46e53506c06265e929994ecdc19ae35/68747470733a2f2f636f6465636f762e696f2f67682f637265616c6f7a2f656173792d61756469742d667265652f67726170682f62616467652e7376673f746f6b656e3d434b48304c3047333935)](https://codecov.io/gh/crealoz/easy-audit-free)

EasyAudit is a Magento 2 module that audits your codebase and configuration to highlight potential issues and provide actionable insights. It helps developers and site owners improve Magento applications' quality, performance, and maintainability.

Stack and Project Overview
--------------------------

[](#stack-and-project-overview)

- Language: PHP (&gt;= 8.1)
- Framework / Platform: Magento 2 (module type: magento2-module)
- Package manager: Composer
- Tests: PHPUnit
- Entry points:
    - Magento CLI command: `crealoz:audit:run`
    - Magento Admin UI (grids and configuration)

For more details on the processors used in EasyAudit, see docs/existing-processors.md.

Requirements
------------

[](#requirements)

From composer.json and codebase:

- PHP: ^8.1
- Magento Framework (Magento 2)
- PHP extensions: ext-simplexml, ext-zip, ext-curl
- Composer

Note: A working Magento 2 instance is required to use the module (both CLI and Admin UI).

Installation
------------

[](#installation)

Install via Composer from Packagist:

```
composer require crealoz/easy-audit-free
```

Then enable and register the module in Magento:

```
php bin/magento module:enable Crealoz_EasyAudit
php bin/magento setup:upgrade
php bin/magento cache:flush
```

Manual installation (for contributors):

1. Clone the repository into your Magento installation under app/code/Crealoz/EasyAudit or use path mapping via composer.
2. Install PHP dependencies if needed (usually handled at the Magento root): ```
    composer install
    ```
3. Enable the module as above.

Usage
-----

[](#usage)

You can run EasyAudit from the Magento CLI or via the Admin UI.

- CLI command (correct command name):

    ```
    php bin/magento crealoz:audit:run \
        --language=en_US \
        --ignored-modules=Vendor_Module1,Vendor_Module2
    ```

    Options:

    - --language (-l): locale to use for messages (default: en\_US)
    - --ignored-modules (-i): comma-separated list of modules to exclude
- Admin back-office: see docs/using-admin.md. Screenshots are available in docs/img.

Configuration and Environment Variables
---------------------------------------

[](#configuration-and-environment-variables)

Configuration can be set in Magento Admin at Stores &gt; Configuration &gt; Crealoz &gt; Easy Audit.

Fields (etc/adminhtml/system.xml):

- Allow PR generation (easy\_audit/general/pr\_enabled)
- Hash (easy\_audit/general/hash)
- Key (easy\_audit/general/key)
- Credits left (display only)

Advanced settings (can also be set via app/etc/env.php using DeploymentConfig):

- easy\_audit/middleware/host: override API host (default: )
- easy\_audit/middleware/self\_signed: boolean; if true, SSL peer verification is disabled for the middleware client
- easy\_audit/middleware/key: middleware key (overrides admin value)
- easy\_audit/middleware/hash: middleware hash (overrides admin value)

Notes:

- PR generation uploads selected source data to a dedicated service for automated processing. See in-module notices for details.
- If you’re unsure of host/key/hash values, obtain them from your Crealoz account.
- TODO: Document sandbox/test endpoints if available.

Features at a Glance
--------------------

[](#features-at-a-glance)

- Detects common Magento anti-patterns (ObjectManager usage, helpers vs ViewModels, SQL in code, heavy classes without proxies, etc.)
- XML/layout checks (cacheable layout handles, preferences, plugins, command registrations)
- Logic-level insights (unused/disabled modules, Block vs ViewModel ratios)
- Database checks (heavy tables, flat catalog)
- PHPCS results export
- Result grids in Admin, downloadable reports, optional patch/ticket generation integration

For in-depth processors list and rationale, see docs/existing-processors.md.

Patch and Ticket Generation
---------------------------

[](#patch-and-ticket-generation)

From the result detail view, a Generate Patch button opens a modal where you can choose relative paths and patch type. Once generated, apply patches incrementally to avoid conflicts.

- Available processors include:
    - Around plugins that should be converted to before/after plugins
    - Proxies for commands

Ticket creation is available for GitHub and Jira; created links appear in the grid and disable the respective button.

Scripts
-------

[](#scripts)

Utility scripts are provided in bash/ for development purposes:

- bash/add-headers-php: add a license header to all PHP files
- bash/add-headers-xml: add a license header to all XML files
- bash/add-headers-js: add a license header to all JS files

Composer scripts: none defined in this module’s composer.json.

Tests
-----

[](#tests)

PHPUnit configuration files are provided (phpunit.xml, phpunit.xml.dist). To run tests from the module root:

```
./vendor/bin/phpunit
```

Coverage reports (HTML and Clover) will be written under build/ as configured in phpunit.xml.

Notes:

- Unit tests live under Test/Unit; integration tests under Test/Integration.
- Integration tests may require a bootstrapped Magento testing environment and database configuration.
- TODO: Provide fixtures setup instructions for integration tests.

Project Structure (top-level)
-----------------------------

[](#project-structure-top-level)

- Api, Model, Service, Processor, Ui, Controller, etc: Magento module code
- etc/: DI, adminhtml, and other Magento configurations
- view/: adminhtml UI components and assets
- Test/: Unit, Integration, and Mocks
- docs/: documentation and screenshots
- bash/: development helpers
- composer.json, registration.php: module metadata and registration
- LICENSE, LICENSE-FR, CONTRIBUTING.md, CODE\_OF\_CONDUCT.md, SECURITY.md

License
-------

[](#license)

EasyAudit Free is released under the MIT License. See LICENSE and LICENSE-FR for details.

Note: Certain referenced premium assets (e.g., examples or headers mentioning “EasyAudit Premium”) relate to a separate paid edition and are not part of this free module’s license. TODO: Add a link that compares Free vs Premium features.

Contributing
------------

[](#contributing)

Contributions are welcome. Please open issues and submit pull requests. Be sure to run tests before submitting.

###  Health Score

40

—

FairBetter than 88% of packages

Maintenance72

Regular maintenance activity

Popularity22

Limited adoption so far

Community14

Small or concentrated contributor base

Maturity43

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 98% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~40 days

Total

6

Last Release

226d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/3d5db3c2a5ae9acfa36990c4502617825b7abe75f00c49a8e21562aa3537b919?d=identicon)[ChristopheCrealoz](/maintainers/ChristopheCrealoz)

---

Top Contributors

[![ChristopheFerreboeuf](https://avatars.githubusercontent.com/u/10241898?v=4)](https://github.com/ChristopheFerreboeuf "ChristopheFerreboeuf (195 commits)")[![ronangr1](https://avatars.githubusercontent.com/u/22326931?v=4)](https://github.com/ronangr1 "ronangr1 (2 commits)")[![aleron75](https://avatars.githubusercontent.com/u/1199894?v=4)](https://github.com/aleron75 "aleron75 (1 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (1 commits)")

---

Tags

auditmagentomagento2magento2-extensionmagento2-modulephpclimagentoextensionmodulefreemagento2

### Embed Badge

![Health badge](/badges/crealoz-easy-audit-free/health.svg)

```
[![Health](https://phpackages.com/badges/crealoz-easy-audit-free/health.svg)](https://phpackages.com/packages/crealoz-easy-audit-free)
```

###  Alternatives

[olegkoval/magento2-regenerate-url-rewrites

Add into Magento 2 a CLI feature which allow to regenerate a Url Rewrites of products and categories

4423.7M2](/packages/olegkoval-magento2-regenerate-url-rewrites)[opengento/module-webapi-logger

This module allows you to analyze all the webapi rest done call toward your Magento.

1014.9k](/packages/opengento-module-webapi-logger)[opengento/composer-registration-plugin

This plugin allows to compile the Magento2 components registrations on composer install/update.

111.6k](/packages/opengento-composer-registration-plugin)[rafaelcg/magento2-quicklink

Faster subsequent page-loads by prefetching in-viewport links during idle time

5115.9k](/packages/rafaelcg-magento2-quicklink)[mahocommerce/maho

Free and open source ecommerce platform, created in 2024 on the M1 platform, PHP 8.3+

1322.1k12](/packages/mahocommerce-maho)[tnegeli/m2clitools

Some nice commands to cleanup media files and tables on production systems

4068.2k](/packages/tnegeli-m2clitools)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
