Onboarding and Installation

Use this method to install the Catalog Service extension for a Commerce Cloud instance.

1. On your local workstation, change to the project directory for your Adobe Commerce on cloud infrastructure project.

   note note
   NOTE
   For information about managing Commerce project environments locally, see Managing branches with the CLI in the Adobe Commerce on Cloud Infrastructure User Guide.

2. Check out the environment branch to update using the Adobe Commerce Cloud CLI.

   code language-shell
   magento-cloud environment:checkout <environment-id>

3. Add the Catalog Service module.

   code language-bash
   composer require "magento/catalog-service" "^3.0.1" --no-update

4. Update package dependencies.

   code language-bash
   composer update "magento/catalog-service"

5. Commit and push code changes for the composer.json and composer.lock files.

6. Add, commit, and push the code changes for the composer.json and composer.lock files to the cloud environment.

   code language-shell
   git add -A git commit -m "Add catalog service module" git push origin <branch-name>

   Pushing the updates initiates the Commerce cloud deployment process to apply the changes. Check the deployment status from the deploy log.

Use this method to install the Catalog Service extension for an on-premises instance.

1. Use Composer to add the Catalog Service module to your project:

   code language-bash
   composer require "magento/catalog-service" "^3.0.1" --no-update

2. Update dependencies and install the extension:

   code language-bash
   composer update "magento/catalog-service"

3. Upgrade Adobe Commerce:

   code language-bash
   bin/magento setup:upgrade

4. Clear the cache:

   code language-bash
   bin/magento cache:clean

   note tip
   TIP
   In some cases, particularly when deploying to production, you might wish to avoid clearing compiled code because it can take some time. Ensure that you back up your system before making any changes.