How to Install Magento Extension from Command Line?

Approx. read time : 3 min

January 28, 2020

This article will guide you on how to use the mage script to manage Magento Connect extensions from the command line.

# Brief about Mage Script

Magento incorporates the mage script that enables you to manage Magento Connect extensions.

Mage script can be used in cron jobs and other types of automation tools because it is a command-line application.

Note: Magento 2 has a complete command-line interface. However, older versions of Magento don’t have a complete command-line interface administration solution.

# Steps to configure the Mage script

Though mage script is incorporated with Magento by default, but it is not configured to run. Perform the following steps to configure the mage script :

1) Using SSH login to your account.

2) Enter following command in the command prompt –

cd ~/public_html

chmod 700 mage

Note: If you have installed Magento in a subdirectory under the public_html directory, then before running the chmod command change to that directory.

3) Type following command to get all the available commands for the mage script –

./mage

# Listing of Magento Extensions

Enter the following command to view the extensions currently installed for your Magento site –

./mage list-installed

Enter the following command to view the list of all the extensions available in the default community channel –

./mage list-available

A long list gets generated after entering the above command. If you wish to filter the results, use grep command.

For example, type the following command to list all Magento extensions related to search –

./mage list-available | grep -i search

Note: If you want to work from with the extensions from a third-party channel then use the channel-add option to add the channel. Enter following command and replace channel with the URL of the channel that you want to add –
./mage channel-add channel

This command assumes that you are using the community channel.

# Commands to download and install Magento extensions

Enter the following command to download and install an extension in one step. Replace name with the name of the extension you want to install –

./mage install community name

Enter the following command to download an extension without installing it. Replace name with the name of the extension you want to download –

./mage download community name

Enter the following command to install an extension that you have already downloaded. Replace filename with the path and name of the file that you want to install –

./mage install-file filename

# Commands to upgrade extensions

Enter the following command to determine if there are any upgrades available for your installed extensions –

./mage list-upgrades

Enter the following command to upgrade all extensions at once –

./mage upgrade-all

Enter the following command to upgrade a specific extension. Replace name with the name of the extension that you want to upgrade –

./mage upgrade community name

# Uninstalling Magento extensions

Type the following command to uninstall an extension. Replace name with the name of the extension that you want to remove –

./mage uninstall community name

# Automate extension management using cron

You are allowed to use the mage script in cron jobs to automate administration tasks for your extensions. For example, the following command of cron configuration upgrades all extensions every Sunday at 3:00 AM :

0 3 * * Sun cd /home/username/public_html && ./mage upgrade-all

That’s it!

Also Read :

1) How To Enable Google Analytics For Your Magento Store?

2) How to reset the password for Magento admin panel?

Sonam Wagh

With an interest in doing something creative daily, Sonam works as a Digital Marketing Executive. She likes to write technical blogs related to web hosting, digital marketing, and other IT topics. She also likes to spend her leisure time on social media to find different strategies for client engagement.