Articles on: Magento 2 Pearl Theme User Guide

How to use composer and install Pearl Theme or other WeltPixel extensions

Note: At this time, Pearl Theme and individual WeltPixel extensions are kept in private repositories and Composer installs from our repos are for internal use only. We may automate access for Pearl users in the future. Until then, you can still install via Composer by creating your own private repos that mirror the theme’s modular structure.

Overview

Pearl is modular (≈20 modules). To install it via Composer, create private repositories in your organization for each Pearl module and theme package, then point Composer to those repos.

What repositories do I need?

Step 1 — Inspect the module structure

In the Theme Pack, navigate to: app/code/WeltPixel/ and review the folders (each folder is a module).

Step 2 — Create a private repo for each module

In GitHub (or your VCS), create one private repo per module, using each module’s README name.

Example (Backend extension):

Create a private repo named yourcompany/m2-weltpixel-backend.git and push the code from the Backend directory into that repo.

Repeat for all folders under app/code/WeltPixel/.

Creating private repositories for Pearl modules

Step 3 — Create theme repositories

Go to app/design/frontend/Pearl/ and create two additional private repos for the theme:

weltpixel
weltpixel_custom (child theme)

Follow the same approach as in Step 2.

Creating theme repositories for Pearl and Pearl Child

Ensure all repos are private to avoid violating the WeltPixel license (public repos would expose code).

Install with Composer (using your private repos)

Use the Composer instructions from each module’s README, replacing the vendor/URL with your organization’s repo names.

Example (Backend extension):

Add the repo:

composer config repositories.yourcompany-m2-weltpixel-backend git git@github.com:yourcompany/m2-weltpixel-backend.git

Require the package:

composer require yourcompany/m2-weltpixel-backend:dev-master

Repeat for each module and the theme packages until all required components are installed.

Installing only one extension via Composer

If you need just a single WeltPixel extension:

Create two repos:

1) Backend shared pack

2) The specific extension you need

Follow the same steps to add the repos and run composer require for those two packages only.

Install Pearl Theme using the 7-step GUI (1-minute installation)

Updated on: 16/09/2025

Was this article helpful?

Thank you!