# smile/elasticsuite

> Magento 2 merchandising and search engine built on ElasticSearch

`composer require smile/elasticsuite`

Canonical URL: https://packagento.com/smile/elasticsuite

## At a glance

- **Vendor**: smile (https://packagento.com/smile.md)
- **Latest version**: 2.12.0 — released 2026-06-01
- **Pricing**: Free
- **Package type**: Magento 2 component
- **Status**: active, accepting new buyers

## Installation

Packagento is licence-gated, so even free packages need a licence on a project before Composer can resolve them.

1. **Sign in or create an account** at https://packagento.com/customer/account/.

2. **Add the package to your account.** Open https://packagento.com/smile/elasticsuite and complete the free checkout. A licence is minted automatically.

3. **Create or pick a project, then activate the licence on it.**
   - Projects represent the Magento installs you deploy to. Manage them at https://packagento.com/projects/.
   - Activate the new licence on the project you'll deploy this package to. Activation is what generates the Composer credentials scoped to that project.

4. **Add the project credentials to your Magento codebase.**

   Grab the project's public + private key from https://packagento.com/projects/ (open the project, then its Credentials tab), and add them to `auth.json`:

   ```json
   {
     "http-basic": {
       "packagento.com": {
         "username": "ppk_live_...",
         "password": "psk_live_..."
       }
     }
   }
   ```

   Add the Packagento Composer repository to `composer.json`:

   ```json
   {
     "repositories": [
       { "type": "composer", "url": "https://packagento.com" }
     ]
   }
   ```

5. **Install and apply.**

   ```bash
   composer require smile/elasticsuite:*
   bin/magento setup:upgrade
   bin/magento setup:di:compile
   bin/magento cache:flush
   ```

## What it does

Magento 2 merchandising and search engine built on ElasticSearch

## README

[![PHP Code Quality](https://github.com/Smile-Sa/elasticsuite/workflows/PHP%20Code%20Quality/badge.svg?branch=2.10.x)](https://github.com/Smile-SA/elasticsuite/actions) [![Integration](https://github.com/Smile-Sa/elasticsuite/workflows/Integration/badge.svg?branch=2.10.x)](https://github.com/Smile-SA/elasticsuite/actions)  ![Packagist](https://img.shields.io/packagist/dt/smile/elasticsuite.svg?style=square)
[![GitHub stars](https://img.shields.io/github/stars/smile-sa/elasticsuite.svg?style=social&label=Star&maxAge=2592000)](https://GitHub.com/Naereen/StrapDown.js/stargazers/)
[![GitHub forks](https://img.shields.io/github/forks/smile-sa/elasticsuite.svg?style=social&label=Fork&maxAge=2592000)](https://GitHub.com/smile-sa/elasticsuite/network/) ![GitHub contributors](https://img.shields.io/github/contributors/smile-sa/elasticsuite.svg?style=square)   [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=square)](https://github.com/Smile-SA/elasticsuite/pulls) ![Open Source Love](https://badges.frapsoft.com/os/v3/open-source.png?v=103)

<p align="center">
    <a href="https://elasticsuite.io/elastic-suite-pricing/"><img alt="Smile" src="doc/static/elasticsuite-banner-github.png" /></a>
</p>

### News

#### ⚠️ Magento versions compatibility :

Due to several changes in Magento 2.4.6, especially **the introduction of Elasticsearch 8 and Opensearch 2** we cannot ensure compatibility between ElasticSuite <2.11 and Magento >=2.4.6 versions.

So : 
- if your project is based on **Magento >= 2.4.6**, you can start working with ElasticSuite today using the latest **2.11.x release**
- if your project is based on **Magento < 2.4.6**, the latest Elasticsuite release you can use is the **2.10.x** 

#### 🎉 Hyvä compatibility

Elasticsuite is compatible with Hyvä theme. Please checkout [their blog article](https://hyva.io/blog/news/elasticsuite-hyva-partnership.html) to find out more about that.

If you want to use Elasticsuite with Hyvä theme, you'll need to install the [compatibility module](https://gitlab.hyva.io/hyva-themes/hyva-compat/magento2-smile-elasticsuite/)

#### Breezefront compatibility

If you want to use Elasticsuite with the [Breezefront themes](https://breezefront.com), you will need to install their [module](https://github.com/breezefront/module-breeze-smile-elasticsuite)

**Which version should I use ?**

Magento Version (Open Source/Commerce)                                     | ElasticSuite Latest Version                                            | Elasticsearch | OpenSearch | Actively maintained
----------------------------------------------------|------------------------------------------------------------------------|-----------------------------------|------------------------------|---------------
**2.0.x**   |ElasticSuite **2.1.x** : ```composer require smile/elasticsuite ~2.1.0``` | 2.x | - | No
**2.1.x**   |ElasticSuite **2.3.x** : ```composer require smile/elasticsuite ~2.3.0``` | 2.x & 5.x | - | No
**2.2.x**   |ElasticSuite **2.6.x** : ```composer require smile/elasticsuite ~2.6.0``` | 5.x & 6.x | - | No
**<2.3.2**  |ElasticSuite **2.8.4** : ```composer require smile/elasticsuite 2.8.4``` | 5.x & 6.x | - | No
**<2.3.5**  |ElasticSuite **2.8.x** : ```composer require smile/elasticsuite ~2.8.0``` | 5.x & 6.x | - | No
**>=2.3.5** |ElasticSuite **2.9.x** : ```composer require smile/elasticsuite ~2.9.0``` | 6.x & 7.x | - | No
**2.4.0**   |ElasticSuite **2.10.1** : ```composer require smile/elasticsuite 2.10.1``` | 6.x & 7.x | - | No 
**>=2.4.1 && < 2.4.6** |ElasticSuite **2.10.x** : ```composer require smile/elasticsuite ~2.10.13``` | 6.x & 7.x | 1.x | **Yes**
**>=2.4.4 && < 2.4.6** |ElasticSuite **2.10.x** **(OpenSearch 2 support)** : ```composer require smile/elasticsuite ~2.10.27``` | 6.x & 7.x | 1.x **& 2.x** | **Yes**
**>=2.4.6 && < 2.4.8** |ElasticSuite **2.11.x** : ```composer require smile/elasticsuite ~2.11.0``` | 7.x & 8.x | 1.x & 2.x | **Yes**
**>=2.4.8** |ElasticSuite **2.11.x >= 2.11.13** : ```composer require smile/elasticsuite ~2.11.13``` | 7.x & 8.x | 1.x & 2.x **& 3.x** | **Yes**

#### Magento2 B2B Compatibility

If your are using Magento Commerce (formerly known as Enterprise Edition) B2B feature with Elasticsuite, you will need to install :

- **Elasticsuite Shared Catalog** module which is located [here](https://github.com/Smile-SA/magento2-module-elasticsuite-shared-catalog)

- **Elasticsuite Quick Order** module which is located [here](https://github.com/Smile-SA/magento2-module-elasticsuite-quick-order)

#### Introducing Elasticsuite modules

We are glad to announce officially that we now have a complete list of **additional modules to Elasticsuite**, which are all available for free and are published Open Source on Github :

Module Name                                                                                           | Description
------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------
[CMS Search](https://github.com/Smile-SA/module-elasticsuite-cms-search)                              | Allow to search for CMS pages (in autocomplete and search results).
[Ratings](https://github.com/Smile-SA/magento2-module-elasticsuite-rating)                            | Allow to filter and/or sort on ratings (based on standard Magento rating module).
[Elasticsuite for Retailers](https://github.com/Smile-SA/elasticsuite-for-retailer)                   | A complete suite of retail oriented modules : Store Locator, Price segmentation per store, etc...
[TargetRules with Elasticsearch](https://github.com/Smile-SA/magento2-module-elasticsuite-targetrule) | This module allow to compute target rules via Elasticsearch instead of full MySQL (**require Magento Commerce (EE)**).

#### Community Add-ons

_(README truncated for .md surface. Full README on https://packagento.com/smile/elasticsuite.)_

## Recent Versions

| Version | Released |
|---|---|
| 2.12.0 | 2026-06-01 |
| 2.11.19 | 2026-06-01 |
| 2.10.34 | 2026-06-01 |
| 2.11.19-rc1 | 2026-04-22 |
| 2.10.34-rc1 | 2026-04-22 |
| 2.11.18.1 | 2026-03-26 |
| 2.10.33.1 | 2026-03-26 |
| 2.11.18 | 2026-03-19 |
| 2.10.33 | 2026-03-19 |
| 2.11.17.1 | 2026-02-17 |

Showing 10 of 220 versions. Full release history on https://packagento.com/smile/elasticsuite.

## Dependencies

### Require

| Package | Constraint |
|---|---|
| magento/framework | >=103.0.6 |
| magento/magento-composer-installer | * |
| magento/module-backend | >=102.0.6 |
| magento/module-catalog | >=104.0.6 |
| magento/module-catalog-graph-ql | >=100.4.6 |
| magento/module-catalog-search | >=102.0.6 |
| magento/module-store | >=101.1.6 |
| opensearch-project/opensearch-php | ^1.0 \|\| ^2.0 <2.4.0 \|\| >=2.4.3 <3.0.0 |

### Require (dev)

| Package | Constraint |
|---|---|
| smile/magento2-smilelab-quality-suite | ~2.2.0 |

### Replace

| Package | Constraint |
|---|---|
| smile/module-elasticsuite-admin-notification | self.version |
| smile/module-elasticsuite-analytics | self.version |
| smile/module-elasticsuite-catalog | self.version |
| smile/module-elasticsuite-catalog-graph-ql | self.version |
| smile/module-elasticsuite-catalog-optimizer | self.version |
| smile/module-elasticsuite-catalog-rule | self.version |
| smile/module-elasticsuite-core | self.version |
| smile/module-elasticsuite-indices | self.version |
| smile/module-elasticsuite-swatches | self.version |
| smile/module-elasticsuite-thesaurus | self.version |
| smile/module-elasticsuite-tracker | self.version |
| smile/module-elasticsuite-virtual-category | self.version |

## Quality

Latest release (2.12.0) fails the Packagento QA pipeline. Verdicts below are per-cell (Magento line × PHP version) for the matrixed tools, and run-once for the static / security tiers.


### Compatibility

Each Magento line is installed on its supported PHP versions, then the module is built (DI compile + static-content deploy). Cells show passed / failed / untested; staircase gaps render as `–`.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | Pass | Pass | – | – |
| 2.4.8 | – | Pass | Pass | – |
| 2.4.9 | – | – | Pass | Pass |


### Code Quality

Advisory checks against the module's source. Never affect the Compatibility verdict — a phpcs finding can't make a module incompatible.

#### Static Analysis

Coding standards (phpcs), mess detection (phpmd), copy-pasted code (cpd), PHP cross-version compatibility, composer.json validity. Each runs once for the whole module.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| PHPCS | Fail | 4057 | 151 errors, 3906 warnings (ruleset: Magento2) — 2625 auto-fixable with phpcbf |
| PHPMD | Pass | 0 |  |
| Cpd | Warning | 42 | 42 duplicated chunks spanning 2435 total lines (min-lines=5, min-tokens=70) |
| Composer validate | Info | 7 | valid; 7 advisory notes (composer validate --strict) |

#### PHPStan

Type-checks the module against a real Magento install. Re-runs per Magento + PHP version because resolvable symbols differ between releases.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | 964 | 964 | – | – |
| 2.4.8 | – | 964 | 964 | – |
| 2.4.9 | – | – | 956 | 956 |


### Tests

Unit and integration suites run per Magento + PHP cell. Test failures speak to the module's behaviour, not its compatibility with a line, so they're reported here separately.

#### Unit Tests

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | – | – |
| 2.4.8 | – | N/A | N/A | – |
| 2.4.9 | – | – | N/A | N/A |

#### Integration Tests

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | – | – |
| 2.4.8 | – | N/A | N/A | – |
| 2.4.9 | – | – | N/A | N/A |


### Security

Dependency-advisory audit (composer audit) plus a source malware scan. A malware detection fails the version outright.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| Composer audit | Pass | 0 |  |
| Malware scan | Pass | 0 |  |

## Licence and pricing

Free. A licence is still minted on checkout and bound to your project for Composer access — no payment step.

Refundable within 14 days of first purchase via https://packagento.com/account/refunds/.

## Install via Claude Code or any MCP client

The Packagento MCP server can run the licence + project + Composer steps above in one tool call:

```
purchase_and_install_packages(
  composer_names=["smile/elasticsuite"],
  project_id="proj_xxx"
)
```

This handles cart, checkout, licence minting, project activation, and writes auth.json credentials. Connect a client with `claude mcp add packagento https://mcp.packagento.com`. Full setup at https://packagento.com/docs/mcp-setup.

## Vendor

smile is a Magento 2 vendor on Packagento. See https://packagento.com/smile.md for their full catalogue.