Adobe Commerce

https://experienceleague.adobe.com/en/docs/commerce
Admin
Adobe Commerce provides a comprehensive platform for businesses to build and manage their online...
Tokens:2,465,163
Snippets:47,852
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Run setup upgrade and recompile

Source: https://experienceleague.adobe.com/en/docs/commerce/live-search/live-search-storefront/migrate-to-plp

Finalize the installation by running the setup upgrade and dependency injection compilation commands.

```bash
bin/magento setup:upgrade
bin/magento setup:di:compile
```

--------------------------------

### Install example modules via CLI

Source: https://experienceleague.adobe.com/en/docs/commerce-learn/tutorials/global-reference-architecture-implementation-techniques/split-git

Downloads and enables example modules using curl, unzip, and composer commands.

```bash
cd packages/gra
mkdir antonevers
cd antonevers
curl -OL https://github.com/AntonEvers/module-example-gra/archive/refs/heads/main.zip
unzip main.zip
rm main.zip
mv module-example-gra-main module-gra
git add module-gra

cd ../../3rdparty
mkdir antonevers
cd antonevers
curl -OL https://github.com/AntonEvers/module-example-3rdparty/archive/refs/heads/main.zip
unzip main.zip
rm main.zip
mv module-example-3rdparty-main module-3rdparty
git add module-3rdparty

cd ../../..
composer require antonevers/module-gra:@dev antonevers/module-3rdparty:@dev
bin/magento module:enable AntonEvers_Gra AntonEvers_ThirdParty
bin/magento test:gra
bin/magento test:3rdparty
```

--------------------------------

### Install Adobe Commerce via command line

Source: https://experienceleague.adobe.com/en/docs/commerce-operations/installation-guide/prerequisites/web-server/nginx

Execute the setup:install command with database and base URL parameters to initialize the application.

```shell
bin/magento setup:install \
--base-url=http://localhost/magento2ee \
--db-host=localhost \
--db-name=<db-name> \
```

--------------------------------

### Install Adobe Commerce via CLI

Source: https://experienceleague.adobe.com/en/docs/commerce-operations/installation-guide/composer

Executes the setup:install command with database, admin, and search engine configuration parameters.

```shell
bin/magento setup:install \
--base-url=http://localhost/magento2ee \
--db-host=localhost \
--db-name=magento \
--db-user=magento \
--db-password=magento \
--admin-firstname=admin \
--admin-lastname=admin \
--admin-email=admin@admin.com \
--admin-user=admin \
--admin-password=admin123 \
--language=en_US \
--currency=USD \
--timezone=America/Chicago \
--use-rewrites=1 \
--search-engine=opensearch \
--opensearch-host=os-host.example.com \
--opensearch-port=9200 \
--opensearch-index-prefix=magento2 \
--opensearch-timeout=15
```

--------------------------------

### Start local storefront preview

Source: https://experienceleague.adobe.com/en/docs/commerce/optimizer/use-case/admin-use-case

Executes the local development server to preview the storefront at http://localhost:3000.

```shell
npm start
```

--------------------------------

### Install Price Indexer Disabler Module

Source: https://experienceleague.adobe.com/en/docs/commerce/price-indexer/catalog-adapter/catalog-adapter

Use Composer to install the module required to disable the product price indexer for headless storefront scenarios.

```bash
composer require magento/module-price-indexer-disabler
```

--------------------------------

### Example SaaS Resync Log Entry

Source: https://experienceleague.adobe.com/en/docs/commerce/saas-data-export/logs-troubleshooting/troubleshooting-logging

A sample JSON log entry showing the structure of a progress update during a full sync operation.

```json
{
   "feed": "prices",
   "operation": "full sync",
   "status": "Progress: 2/5, processed: 200, synced: 100",
   "elapsed": "00:00:00 190 ms",
   "pid": "12824",
   "caller": "bin/magento saas:resync --feed=products"
}
```

--------------------------------

### Identify Tenant ID from Commerce Optimizer URL

Source: https://experienceleague.adobe.com/en/docs/commerce/optimizer/use-case/admin-use-case

Example URL structure showing the location of the tenant ID used for configuring the commerce-endpoint.

```text
https://experience.adobe.com/#/@commerceprojectbeacon/in:XDevkG9W6UbwgQmPn995r3/commerce-optimizer-studio/catalog
```

--------------------------------

### Install Extra Product Attributes Module

Source: https://experienceleague.adobe.com/en/docs/commerce/saas-data-export/extensibility/add-tax-attribute-set-inventory-attributes

Use Composer to add the required module to your Adobe Commerce project.

```shell
composer require adobe-commerce/module-extra-product-attributes
```

--------------------------------

### Query New Relic Logs

Source: https://experienceleague.adobe.com/en/docs/commerce/saas-data-export/logs-troubleshooting/troubleshooting-logging

Example query string to filter logs by specific feed type and status.

```nrql
feed.feed:"products" and feed.status:"Complete"
```

--------------------------------

### Composer Package Not Found Error

Source: https://experienceleague.adobe.com/en/docs/commerce/payment-services/get-started/install

Example of the error message displayed when the Payment Services package cannot be located due to incorrect keys or version constraints.

```none
Could not find a matching version of package magento/payment-services. Check the package spelling, your version constraint and that the package is avai
lable in a stability which matches your minimum-stability (stable).
```

--------------------------------

### Identify Nginx installation error in var/report

Source: https://experienceleague.adobe.com/en/docs/commerce-knowledge-base/kb/troubleshooting/installation-and-upgrade/cannot-install-using-nginx

Example of the error log entry indicating that the setup directory is inaccessible during installation.

```text
NOTE: You cannot install Adobe Commerce using the Setup Wizard because the Adobe Commerce setup directory cannot be accessed.
You can install Adobe Commerce using either the command line or you must restore access to the following directory: /var/www/html/setup
If you are using the sample nginx configuration, please go to http://ce.mtf03.bcn.magento.com/setup/";i:1;s:641:"#0 /var/www/html/lib/internal/Magento/
Framework/App/Http.php(213): Magento\Framework\App\Http->redirectToSetup(Object(Magento\Framework\App\Bootstrap), Object(Exception))
```

--------------------------------

### Sample Data Installation Timeout Log

Source: https://experienceleague.adobe.com/en/docs/commerce-knowledge-base/kb/troubleshooting/installation-and-upgrade/errors-installing-optional-sample-data

Example output showing the installation process halting during the Magento_CustomerSampleData module.

```text
(more)

Module 'Magento_CustomerSampleData':
Installing data...
```

--------------------------------

### Example output for all saved configurations

Source: https://experienceleague.adobe.com/en/docs/commerce-operations/configuration-guide/cli/configuration-management/set-configuration-values

Sample output format showing configuration paths and their corresponding values.

```text
web/unsecure/base_url - http://example.com/
general/region/display_all - 1
general/region/state_required - AT,BR,CA,CH,EE,ES,FI,LT,LV,RO,US
catalog/category/root_id - 2
analytics/subscription/enabled - 1
```

--------------------------------

### Sample Data Installation Error Message

Source: https://experienceleague.adobe.com/en/docs/commerce-knowledge-base/kb/troubleshooting/installation-and-upgrade/errors-installing-optional-sample-data

Example of an error message indicating a missing class during sample data installation.

```php
[Magento\Setup\SampleDataException] Error during sample data installation: Class Magento\Sales\Model\Service\OrderFactory does not exist
```

--------------------------------

### CLI download response example

Source: https://experienceleague.adobe.com/en/docs/commerce-on-cloud/user-guide/develop/deploy/staging-production

Example output showing the interactive mount selection process.

```none
Enter a number to choose a mount to download from:
  [0] app/etc
  [1] pub/static
  [2] var
  [3] pub/media
  [4] All mounts
 > 3

Target directory: ~/pub/media/

Downloading files from the remote mount pub/media to pub/media

Are you sure you want to continue? [Y/n] Y
```

--------------------------------

### Magento Indexer Installation Exception

Source: https://experienceleague.adobe.com/en/docs/commerce-knowledge-base/kb/troubleshooting/installation-and-upgrade/exceptions-during-installation

Example of a recoverable error occurring during the Magento_Indexer module installation due to a type mismatch in the constructor.

```bash
Module 'Magento_Indexer':
Running recurring..
[ERROR] exception 'Exception' with message 'Recoverable Error: Argument 1 passed to Magento\Indexer\Model\Config\Data::__construct() must be an instanc
e of Magento\Framework\Indexer\Config\Reader, instance of Magento\Indexer\Model\Config\Reader given, called in /home/magento2_dev/
public_html/generated/code/Magento/Indexer/Model/Config/Data/Interceptor.php on line 14 and defined in /home/magento2_dev/public_html/
app/code/Magento/Indexer/Model/Config/Data.php on line 22' in /home/magento2_dev/public_html/lib/internal/Magento/Framework/App/ErrorHandler.php:67
Stack trace:
#0 /home/magento2_dev/public_html/app/code/Magento/Indexer/Model/Config/Data.php(22): Magento\Framework\App\ErrorHandler->handler(4096,
'Argument 1 pass...', '/home/magento2...', 22, Array)
#1 /home/magento2_dev/public_html/generated/code/Magento/Indexer/Model/Config/Data/Interceptor.php(14): Magento\Indexer\Model\Config\Data->__construct(Object(Magento\Indexer\Model\Config\Reader), Object(Magento\Framework\App\Cache\Type\Config), Object(Magento\Indexer\Model\Resource\Indexer
\State\Collection), 'indexer_config')
#2 /home/magento2_dev/public_html/lib/internal/Magento/Framework/ObjectManager/Factory/AbstractFactory.php(103): Magento\Indexer\Model\Config\Data\Inte
rceptor->__construct(Object(Magento\Indexer\Model\Config\Reader), Object(Magento\Framework\App\Cache\Type\Config),
Object(Magento\Indexer\Model\Resource\Indexer\State\Collection), 'indexer_config')

... more ...
```

--------------------------------

### Initialize and run an App Builder project

Source: https://experienceleague.adobe.com/en/docs/commerce-learn/tutorials/extensibility/adobe-developer-app-builder/io-events/create-app-builder-project

Use these commands to create a directory, authenticate, initialize the project, and start the local development server.

```bash
mkdir myproject && cd myproject

aio login

aio app init

aio app run
```

--------------------------------

### MessageQueue consumer execution examples

Source: https://experienceleague.adobe.com/en/docs/commerce-operations/tools/cli-reference/commerce-on-premises-beta

Various examples of starting a consumer with specific flags for message processing, batching, and process control.

```text
bin/magento queue:consumers:start someConsumer

bin/magento queue:consumers:start someConsumer --max-messages=50

bin/magento queue:consumers:start someConsumer --batch-size=500

bin/magento queue:consumers:start someConsumer --area-code='adminhtml'

bin/magento queue:consumers:start someConsumer --single-thread

bin/magento queue:consumers:start someConsumer --pid-file-path='/var/someConsumer.pid'

bin/magento queue:consumers:start someConsumer --multi-process=4
```

--------------------------------

### Clone the integration starter kit

Source: https://experienceleague.adobe.com/en/docs/commerce/cloud-service/tutorials/tutorial-prerequisites

Downloads the integration starter kit repository and navigates into the directory.

```bash
git clone https://github.com/adobe/commerce-integration-starter-kit.git extension
cd extension
```

--------------------------------

### Install Adobe Commerce with Admin User

Source: https://experienceleague.adobe.com/en/docs/commerce-operations/installation-guide/advanced

Executes the setup:install command with full database, admin, and search engine configuration.

```shell
magento setup:install --base-url=http://127.0.0.1/magento2/ \
--db-host=localhost --db-name=magento --db-user=magento --db-password=magento \
--admin-firstname=Magento --admin-lastname=User --admin-email=user@example.com \
--admin-user=admin --admin-password=admin123 --language=en_US \
--currency=USD --timezone=America/Chicago --use-rewrites=1 \
--search-engine=opensearch --opensearch-host=os-host.example.com \
--opensearch-port=9200
```

--------------------------------

### Help command usage examples

Source: https://experienceleague.adobe.com/en/docs/commerce-on-cloud/user-guide/dev-tools/ece-tools/ece-tools-cli-reference

Examples showing how to retrieve help for commands and specify output formats.

```bash
The help command displays help for a given command:

  bin/ece-tools help list

You can also output the help in other formats by using the --format option:

  bin/ece-tools help --format=xml list

To display the list of available commands, please use the list command.
```

--------------------------------

### View Configuration Details

Source: https://experienceleague.adobe.com/en/docs/commerce-admin/customers/audience-activation

Example output showing the client credentials and sandbox configuration status.

```none
+----------------------------------+---------------+---------------------------------------------+-------------------------------------------------
--------+--------------+
| Client ID                        | Client secret | Technical account ID                        | Technical account email                         
        | Sandbox name |
+----------------------------------+---------------+---------------------------------------------+-------------------------------------------------
--------+--------------+
| 1234bd57fac8497d8933327c535347d8 | *****         | 12341E116638D6B00A495C80@techacct.adobe.com | 12345-b95b-4894-a41c-a4130d26bd80@techacct.adobe
.com | dev          |
```

--------------------------------

### Run Adobe Commerce Extensibility App Setup

Source: https://experienceleague.adobe.com/en/docs/commerce/cloud-service/tutorials/tutorial-prerequisites

Initiates the interactive setup process for cloning a starter kit and configuring Adobe I/O console settings.

```shell-session
aio commerce extensibility app-setup

🚀 Adobe Commerce Extensibility App Setup

✔ Logged in
📁 Working directory: /Users/username/projects/my-commerce-project

✔ Which starter kit would you like to use? Checkout Starter Kit
✔ Enter a name for your project directory: my-extension
✔ Which coding agent would you like to install the skills for? Cursor

📦 Cloning Checkout Starter Kit...
   ✔ Repository cloned
   Using npm (package-lock.json found)
   ✔ Dependencies installed

📋 Current Adobe I/O Console configuration:
   Org: My Organization (1234567)
   Project: My Commerce Project (1234567890123456789)
   Workspace: Stage (9876543210987654321)
✔ Do you want to continue with this configuration? (Answer "No" to select a different org/project/workspace)
No

🔧 Selecting Adobe I/O Console org, project, and workspace...

? Select Org: My Organization
Org selected My Organization
You are currently in:
1. Org: My Organization
2. Project: <no project selected>
3. Workspace: <no workspace selected>

? Select Project: My Commerce Project
Project selected : My Commerce Project
You are currently in:
```

--------------------------------

### Composer B2B Installation Error

Source: https://experienceleague.adobe.com/en/docs/commerce-operations/release/notes/security-patches/2-4-6-p1

Example of the error message encountered when installing or upgrading the B2B extension to 1.4.0 due to missing dependencies.

```text
Your requirements could not be resolved to an installable set of packages.

  Problem 1
    - Root composer.json requires magento/extension-b2b 1.4.0 -> satisfiable by magento/extension-b2b[1.4.0].
    - magento/extension-b2b 1.4.0 requires magento/security-package-b2b 1.0.4-beta1 -> found magento/security-package-b2b[1.0.4-beta1] but it does not match your minimum-stability.

Installation failed, reverting ./composer.json and ./composer.lock to their original content.
```

--------------------------------

### Enable verbose output for setup commands

Source: https://experienceleague.adobe.com/en/docs/commerce-on-cloud/user-guide/dev-tools/ece-tools/error-reference

Add this configuration to your .magento.env.yaml file to increase logging detail for setup:install command failures.

```yaml
VERBOSE_COMMANDS: '-vvv'
```
Tokens:
Raw