Upgrading to Clerk.js 2 on Magento 2

See how to get the flexible Clerk.js 2 setup on your webshop.

Clerk.js 2 is a faster and much more flexible version of our JavaScript library that makes installing Clerk.io on any webshop a breeze.

However, since the two versions work slightly differently, you need to follow these steps to successfully upgrade.

The two main differences in Clerk.js 2 is that the Designs in my.clerk.io use the Liquid templating language, but they can also easily be created using the Design Editor.

Step 1: Converting Designs

Since Clerk.js 2 has a different approach Designs, you need to create new ones.

You can create your Clerk.js 2 Designs in one of two ways:

1.1 Start by going to my.clerk.io -> Recommendations / Search -> Designs and click New Design:

1.2 On the following screen, give your Design a Name (we recommend adding " V2" so its obvious that you are using Clerk.js2).

1.3. Choose Design Type.

1.4. In the Design Editor, click any of the existing elements like the name, image, button etc. to edit it, or add new elements to the Design to add more information about products.

1.5. Click Publish  when you are done, and go to Step 2 in the guide.

1.6. Lastly, go to Recommendations / Search -> Content and change your Clerk.io Content to use your new Design.

1.7. Click Update Content. This will temporarily cause them to not show up on your webshop, until you are done with Step 2. Choose the new Design for all Content that should be updated.

1.9. There! You are now ready to switch over to Clerk.js 2.

Step 2: Upgrading your extension

WARNING: Remember to take backups of any modified files, as they will be overwritten.

Upgrading the Magento 2 extension is done via commandline.

Its done by following these steps:

2.1. Login to your server through commandline.

2.2. Navgiate to your webroot folder (usually " /var/www/your_domain/public_html")

2.3. Enable Root Access by typing su and then enter your password.

2.4.Type in the following commands in order:composer update clerk/magento2php bin/magento setup:upgradephp bin/magento setup:di:compile

2.5. Wait for the extension to finish.

Your Magento 2 is now upgraded to the latest version.

Now you have the latest version of Clerk.io for Magento 2 installed, and Clerk.js 2 is running on your webshop!

The full documentation for Clerk.js 2 can be found here: