PHPackages                             cacheful/magento2-module - 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. [Caching](/categories/caching)
4. /
5. cacheful/magento2-module

ActiveMagento2-module[Caching](/categories/caching)

cacheful/magento2-module
========================

Cacheful Magento 2 client

1.0.3(6y ago)07.8k1MITPHP

Since May 28Pushed 6y agoCompare

[ Source](https://github.com/cacheful/magento2-module)[ Packagist](https://packagist.org/packages/cacheful/magento2-module)[ RSS](/packages/cacheful-magento2-module/feed)WikiDiscussions master Synced 2w ago

READMEChangelogDependencies (1)Versions (7)Used By (0)

Cacheful Magento 2 Module
=========================

[](#cacheful-magento-2-module)

**Cacheful** offers a simple, yet powerful way to warm-up your website cache. This specific module for Magento 2 integrates with the cacheful API in order to initiate a warm-up process, either manually or automatically after your website cache has been flushed. This way the first page load for every request is handled by the server, so that no actual visitor has to deal with delay in page load.

Install with Composer
---------------------

[](#install-with-composer)

`composer require cacheful/magento2-module`

Quick start in 5 steps
----------------------

[](#quick-start-in-5-steps)

- Create a free account [on cacheful](https://cacheful.app).
- Create your first team and project.
- Go to `your settings -> API` and create your first API token.
- Copy your *project ID* and *API token* here:
    - `system config -> cacheful client -> connection`.
- Enable "Initiate warm-up after cache flush" option here:
    - `system config -> cacheful client -> general`.

Initiate warm-up manually
-------------------------

[](#initiate-warm-up-manually)

Run the following command to initiate a warm-up using your configured credentials.

`$ bin/magento cacheful:execute`

Initiate warm-up after cache flush
----------------------------------

[](#initiate-warm-up-after-cache-flush)

Enable "Initiate warm-up after cache flush" option in system configuration, so that the cache warm-up will be triggered after each cache flush as long as the project is idle, avoiding concurrent warm-up processes.

API endpoints
-------------

[](#api-endpoints)

You can also do API requests manually if you like, for example using Guzzle.

`/api/projects/:key/process`

**Headers**

```
{
  "Authorization": "Bearer :token",
  "Accept": "application/json"
}
```

Using Guzzle
------------

[](#using-guzzle)

```
    $url = 'https://cacheful.app/api/projects/%s/process';

    $projectId = 'your-project-id';
    $token = 'your-api-token';
    $requestUrl = sprintf($url, $projectId);

    $request = $client->request('POST', $requestUrl, [
        'headers' => [
            'Authorization' => 'Bearer ' . $token,
            'Accept'        => 'application/json',
        ]
    ]);

    if ($request->getStatusCode() === '200') {
        // successfully queued
    }
```

**Status codes**

- `200` when the process has been added to the queue successfully.
- `409` if the project status is `running` or `pending`.

###  Health Score

31

—

LowBetter than 66% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity19

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity64

Established project with proven stability

 Bus Factor1

Top contributor holds 100% 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 ~28 days

Recently: every ~35 days

Total

6

Last Release

2448d ago

Major Versions

0.1.1 → 1.0.02019-05-28

### Community

Maintainers

![](https://www.gravatar.com/avatar/d91a0b4cc171050631054998d45aaf17035f28a351a218a8809ac7daa364da48?d=identicon)[imadphp](/maintainers/imadphp)

---

Top Contributors

[![imadphp](https://avatars.githubusercontent.com/u/33043295?v=4)](https://github.com/imadphp "imadphp (1 commits)")

### Embed Badge

![Health badge](/badges/cacheful-magento2-module/health.svg)

```
[![Health](https://phpackages.com/badges/cacheful-magento2-module/health.svg)](https://phpackages.com/packages/cacheful-magento2-module)
```

###  Alternatives

[aws/aws-sdk-php

AWS SDK for PHP - Use Amazon Web Services in your PHP project

6.2k532.1M2.5k](/packages/aws-aws-sdk-php)[svix/svix

Svix PHP Library

3.3k964.7k7](/packages/svix-svix)[neuron-core/neuron-ai

The PHP Agentic Framework.

2.0k656.1k34](/packages/neuron-core-neuron-ai)[craftcms/cms

Craft CMS

3.6k3.6M2.9k](/packages/craftcms-cms)[tencentcloud/tencentcloud-sdk-php

TencentCloudApi php sdk

3741.3M46](/packages/tencentcloud-tencentcloud-sdk-php)[tempest/framework

The PHP framework that gets out of your way.

2.2k31.1k12](/packages/tempest-framework)

PHPackages © 2026

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