Install Page Builder
How you install the pre-release version of Page Builder depends on whether you are a member of the Early Adopters Program (EAP):
- All Partners (not EAP members) must use the GitHub installation.
- EAP Members can install using the Composer installation.
Prerequisite for both installations
Magento Commerce 2.3+ – Use the installation instructions from the DevDocs installation guide.
All Partners: GitHub Installation
Partners who are not members of the Early Adopters Program (EAP) must install the pre-release version of Page Builder by cloning the Page Builder GitHub repository (https://github.com/magento/magento2-page-builder) into a development instance of Magento. Before installing Page Builder, make sure you have:
- A local development installation of Magento Commerce 2.3+
- Access to the Page Builder repository
- npm package manager
Clone the Page Builder repos into the root directory of your Magento Commerce 2.3+ installation:
git clone https://github.com/magento/magento2-page-builder git clone https://github.com/magento/magento2-page-builder-ee
From the root directory of your Magento Commerce installation, use the
dev/tools/build-ee.phpscript to symlink
magento2-page-builder-eerepos into your Magento Commerce installation:
php dev/tools/build-ee.php --command=link --ee-source="magento2-page-builder" --ce-source="." php dev/tools/build-ee.php --command=link --ee-source="magento2-page-builder-ee" --ce-source="."
The results should look like this:
Enable the Page Builder module using the following command:
Updating GitHub installation
When a new version of Page Builder is available, simply pull down the latest versions from
Installing Node.js dependencies
If you plan to contribute to Page Builder, you need to install Node.js dependencies to compile TypeScript.
Navigate to the
pagebuilder directory and install Page Builder dependencies using the following command:
cd pagebuilder && npm install
After installing the npm packages, you can run
npm run start. This command watches for changes to your TypeScript files, compiles, and checks for errors.
EAP Participants Only: Composer Installation
To use the Composer installation described below, you must be an active member in the Page Builder EAP program and have submitted your MAGEID to get access to the Page Builder Composer packages through
If you are experiencing problems as an EAP member, please contact us at
If you already have Magento 2.3.0 or Page Builder installed, clear your composer cache (
composer clearcache) before you install the latest packages.
Ensure your composer has
composer config minimum-stability beta
Navigate to the root of the project and require the
composer require magento/page-builder-commerce:^1.0.0
Enable the module within Magento:
Activate Page Builder from the Admin UI as described in Activate Page Builder.
Updating Composer installation
You can install updates by completing a
composer update within your project.
Composer installation issues
If you run into the following issue:
Could not find a matching version of package magento/page-builder-commerce. Check the package spelling, your version constraint and that the package is available in a stability which matches your minimum-stability (stable).
Please ensure the credentials you’re using to connect with
repo.magento.com belong to the MAGEID you provided when you signed up to the EAP program.