This topic discusses how to install extensions, which can be any of the following:
- Modules (extend Magento capabilities)
- Themes (change the look and feel of your storefront and Admin)
- Language packages (localize the storefront and Admin)
This topic discusses how to install extensions you purchased from Magento Marketplace. You can use the same procedure to install any extension; all you need is the extension's Composer name. To find it, open the extension's
composer.json file and note the values for
You must check in
composer.lock to your environment; otherwise, the extension won't load in Magento Commerce (Cloud). That's because we run
composer install (which uses
composer.lock) and not
composer update when we build and deploy the environment.
To install a extension, you must:
- Obtain the extension from Magento Marketplace or elsewhere.
- Get the extension’s Composer name and version from your purchase history.
- In your local Magento Commerce (Cloud) project, update the Magento
composer.jsonfile with the name and version of the extension.
- Push the changes to your environment.
- Verify the extension installed properly.
- Log in to your local development system, or switch to, the Magento file system owner.
- Change to a directory to which the Magento file system owner has write access.
Enter the following command in a terminal to log in to your project:
List your projects. With the project ID, you can complete additional commands.
If necessary, clone the project to your local. You should have cloned when setting up your local development workspace.
magento-cloud project:get <project ID>
- Change to a project directory. For example,
List environments in the project. Every environment includes an active Git branch of your code, database, environment variables, configurations, and services.
magento-cloud environment:listdisplays environment hierarchies whereas
git branchdisplays does not. If you have any nested environments, use
magento-cloud environment:listto see the full list.
Fetch origin branches to get the latest code:
git fetch origin
Check out, or switch to, a specific branch and environment. Git commands only checkout the Git branch. The Magento Cloud command also switches to the active environment.
magento-cloud environment:checkout <environment ID>
To create a new environment, use
magento-cloud environment:branch <environment name> <parent environment ID>
Pull any updated code to your local for the environment ID (which is the Git branch):
git pull origin <environment ID>
Create a snapshot of the environment as a backup:
magento-cloud snapshot:create -e <environment ID>
Step 1: Get the extension’s Composer name and version
If you already know the extension’s Composer name and version, skip this step and continue with Update Magento’s
This section discusses how to get a extension’s Composer name and its version from Magento Marketplace. Alternatively, you can find the name and version of any extension (whether or not you purchased it on Marketplace) in the extension’s
composer.json file. Open
composer.json in a text editor and write down the values of
To get the extension’s Composer name from Magento Marketplace:
- Log in to Magento Marketplace with the user name and password you used to purchase the component.
In the upper right corner, click <your user name> > My Account as the following figure shows.
On the My Account page, click My Purchases as the following figure shows.
On the My Purchases page, click Technical Details for the extension you purchased as the following figure shows.
- Click Copy to copy the component name to the clipboard.
- Open a text editor.
- Paste the extension name in the text editor.
- Append a colon character (
:) to the component name.
- In Technical Details on the My Purchases page, click Copy to copy the version to the clipboard.
Append the version number to the component name after the colon.
A sample follows:
Continue with the next section.
Step 2: Update Magento’s
- If you haven’t done so already, change to your environment root directory.
Enter the following commands to update it:
composer require <component-name>:<version> --no-update composer update
composer require pixlee/magento2:1.0.1 --no-update composer update
- Enter the following
- Wait for project dependencies to update.
- Continue with the next section.
Step 3: Push the extension to your environment
Enter the following commands in the order shown to commit your changes, including
git add -A git commit -m "<message>" git push origin <environment ID>
If there are errors, see extension deployment failure.
Step 4: Verify the extension
To verify the extension installed properly, you can check its functionality in the Magento Admin or you can make sure it is enabled as follows:
- SSH to the environment on which the extension is installed.
Enter the following command to display a list of enabled modules:
`php bin/magento module:status`
Verify the extension is listed.
The extension name is in the format
<VendorName>_<ComponentName>; it is not the same format as the Composer name.