Adobe Commerce access keys
You must have Adobe Commerce access keys to download and use the Upgrade Compatibility Tool. Add your Adobe Commerce access keys to your auth.json
file, which is located at ~/.composer
by default.
auth.json
file is located.The public key corresponds to the username whereas the private key is the password:
Example of Adobe Commerce access keys
"http-basic": {
"repo.magento.com": {
"username": "YOUR_MAGENTO_PUBLIC_KEY",
"password": "YOUR_MAGENTO_PRIVATE_KEY"
}
},
composer create-project
command will fail.Run composer install
in your terminal to install dependencies.
System requirements
The minimum requirements to use the Upgrade Compatibility Tool in a command-line interface are:
Upgrade Compatibility Tool requires PCNTL and other PHP extensions for the execution. Check the required PHP extensions using composer check-platform-reqs
command:
# Example output of `composer check-platform-reqs` command for UCT 2.2.6 and PHP 7.4:
$ composer check-platform-reqs
Checking platform requirements for packages in the vendor dir
ext-ctype * success provided by symfony/polyfill-ctype
ext-dom 20031129 success
ext-filter 7.4.30 success
ext-json 7.4.30 success
ext-libxml 7.4.30 success
ext-mbstring * success provided by symfony/polyfill-mbstring
ext-openssl 7.4.30 success
ext-pcntl 7.4.30 success
ext-pcre 7.4.30 success
ext-phar 7.4.30 success
ext-simplexml 7.4.30 success
ext-tokenizer 7.4.30 success
ext-xml 7.4.30 success
ext-xmlwriter 7.4.30 success
ext-zip 1.15.6 success
php 7.4.30 success
Adobe Commerce is only supported on Linux operating systems. You can run the Upgrade Compatibility Tool in a Linux OS. You do not have to run the Upgrade Compatibility Tool where your Adobe Commerce instance is located.
It is necessary for the Upgrade Compatibility Tool to have access to the source code of the Adobe Commerce instance. For example, you can install it on one server and point it at your Adobe Commerce installation on another server.
If you are running the Upgrade Compatibility Tool against an Adobe Commerce instance with large modules and files, the tool might require a high amount of RAM (at least 2GB).
Run the Upgrade Compatibility Tool from the Site-Wide Analysis Tool for Adobe Commerce on cloud infrastructure projects.