Home Getting Started ✨ Installation Guide

✨ Installation Guide

Last updated on Jul 07, 2025

Follow this guide to install any Blackbird extension on your Magento 2 store.

✅ Prerequisites

Before starting the installation, make sure:

  • Your store runs Magento 2.3.x or higher.

  • You are comfortable using the command line.

  • The site is in developer mode (recommended for installation).

⚠️ Do not install extension directly to a production environment without testing it before in a development environment.


1. Get the Extension

You can get the Blackbird extension in one of the following ways:

Option A: Via Composer (Recommended)

As the module is hosted in a private repository, you may need to add credentials or repository information to your composer.json. Follow this guide on how to generate the access keys and configure your composer.json .

composer require blackbird/module-extension-name

🔁 Replace module-extension-name with the actual package name (e.g., blackbird/contentmanager).

Option B: Manual Installation (ZIP File)

  1. Download the extension from your customer account.

  2. Extract the contents and upload them to:

app/code/Blackbird/ExtensionName

app/code/Blackbird/ExtensionName

🗂️ Make sure the folder structure is: app/code/Blackbird/ExtensionName/registration.php, etc.

NB: Install all the modules present in the require section of composer.json. Generally, the blackbird/extensions-core is required. You can find it here.


2. Enable the Module

Run the following CLI commands from your Magento root directory:

bin/magento module:enable Blackbird_ExtensionName
bin/magento setup:upgrade

If needed:

bin/magento setup:di:compile
bin/magento setup:static-content:deploy

⚠️ Replace Blackbird_ExtensionName with the correct module name.


3. Clear Cache

bin/magento cache:clean bin/magento cache:flush

4. Verify Installation

You can verify that the module is installed correctly by running:

bin/magento module:status

Look for Blackbird_ExtensionName in the list of enabled modules.

You can also check in the Admin Panel, where a new menu item or feature section should now appear depending on the extension.


Need Help?

If you encounter issues during installation, check the logs in:

var/log/

Or contact us via the chat for technical assistanc