My Cart

Composer Installation

On every product's User Manual page you can find installation recommendations. Herein provides general instructions for composer installation. Composer Installation allows a quick start installation.

These represent general instructions. For additional information check the User Manual section for every extension. There you will be able to find detailed information related to the installation of that particular product.


If you need to install PWA Studio on your Magento 2 store, please check the article about it.

If you are installing an extension from Aheadworks for the first time, you need to add our composer repository to your Magento store:

  1. Login to your ssh console and navigate to your store folder:
cd path_to_the_store_root_folder

Run the following command:

composer config repositories.aheadworks composer

On successful execution of the command you will be able to use the composer to install the extensions.

To install the extension:

  1. Login to your ssh console and navigate to your store folder:
cd path_to_the_store_root_folder
  1. Run the following command to install the latest version of the extension:
composer require aheadworks/module-[nameofextension]

if you need to install a specific version, run this command:

composer require aheadworks/module-[nameofextension]:<version>

When prompted, enter Public Key (Username) and Private Key (Password):

Both Public Key (Username) and Private Key (Password) can be found in My Projects and Licenses in your personal account on our site:

  1. Enable the extension:
php -f bin/magento module:enable [Name of Extension]

Next, register the extension:

bin/magento setup:upgrade

Recompile your Magento store if you are in the Production mode:

bin/magento setup:di:compile

To verify that the extension is enabled, run this command:

bin/magento module:status

Clean store cache, by running the following command:

bin/magento cache:clean

Log out and Log in the backend again.

To upgrade the extension:

  1. To update or upgrade an extension:

Download the updated extension file. Take note of the module-name and version. Export the contents to your Magento root.

If a composer package exists for the extension, run one of the following.

Update per module name:

composer update aheadworks/module-[nameofextension]

Updater per version:

composer require aheadworks/[nameofextension]:<version>

Run the following commands to upgrade, deploy, and clean the cache.

php bin/magento setup:upgrade --keep-generated 
php bin/magento setup:static-content:deploy
php bin/magento cache:clean

NOTE: All the values, i.e.[Name of Extension], [nameofextension] shouldn’t have square braces ([]).

NOTE: Specify the version of the extension in <version>

Report incorrect information

Still Have Questions?

Our customer care team is here for you!

Contact Us