Skip to main content

Magento/Adobe Commerce Agent Installation

Prerequisites​

Before installing the Magento Agent, ensure the following:

  • You have access to the Magento or Adobe Commerce project source code.

  • Composer is installed on the system.

  • You have SSH access to the server if installation will be done on the live environment.

  • The Magento or Adobe Commerce project already supports Composer dependencies.

Installation Approaches​

Depending on the client's workflow, the Magento Agent can be installed in two ways:

Option 1 — Install in Local Environment (Recommended)​

  1. Install the agent locally in the Magento or Adobe Commerce project.

  2. Commit the changes to the Git repository.

  3. Deploy the updated code to the server.

This approach ensures the dependency is tracked in composer.json and is reproducible across environments.

Option 2 — Install Directly on the Server​

After deployment is completed, you can SSH into the server and install the agent directly.

Install Magento Agent​

Run the following commands in the Magento or Adobe Commerce project root directory.

composer config repositories.auditiq composer https://composer.auditiq.cloud

composer require auditiq/agent

These commands will:

  1. Add the AuditIQ Composer repository.

  2. Install the Magento Agent package.

Result​

After completing the steps above:

  • Magento Agent will be installed in the Magento or Adobe Commerce project.