Installing Adobe I/O Runtime CLI and Mesh plugin

Before you begin using API Mesh for Adobe Developer App Builder, you need to install the aio CLI and the API Mesh plugin.
For installation instructions and prerequisites, visit the API Mesh Getting started page.

Who is this video for?

  • Developers new to API Mesh or Adobe Commerce with limited experience using Adobe I/O Runtime and API Mesh.

Video content

  • Introduction to API Mesh
  • Installing the Adobe I/O Runtime CLI (command-line interface)
  • Installing the API Mesh plugin
Transcript
In this video, we will learn how to install API Mesh command line plugin, part of the Adobe IO CLI tool. This plugin is needed so we can start creating meshes and perform other operations. In order to actually use API Mesh, you’ll need a set of prerequisites. And these prerequisites, you might have them installed on some of your computer and some of them you might access them for the first time. I assume everybody is accustomed with installing Node. If not, you can go on their webpage and we have a link. In my case, I’m using a Mac and I can click on the 64-bit Mac OS installer. I can download the package. It will prompt me to install it. And in half a minute or so, I will actually run Node on my computer. Going to my terminal here, I can actually run Node. And here we go. I’m running Node 18. You can also use NVM, which is a package manager for Node. In this case, we included a link here, which goes to the following page and it can actually install through this package any version of Node, including the one that we just installed by downloading the package. And I’m going to actually run this command. Next we are going to install the Adobe IO command line. I am going to copy this from our documentation and paste it here in the terminal. This is going to trigger some installation process. Roughly take in a minute or two. You would usually get something like this. If you do, then you will have to sudo and rerun the command. This will ensure that your application actually has rights to install a system command. This is the prompt that you would want to get, and this ensures that you had installed correctly. I’m going to test this by running the IO command. Sure enough, if you get a prompt like this, that means you already are running this command. Next I’m going to actually install the Adobe CLI plugin for API Mesh. This is the second command that we have to run in our terminal and by using the IO command itself and the plugin version explained here. This process is going to take far less than the initial command took to install. We’re running version 2 of the plugin for API Mesh for the IO command. The next scenario is for those of you who might already have the IO command and it’s outdated. You haven’t used it for some time. In order to make sure that it’s up to date, you will be looking at the following command IO-H. This will give you the usage of the command plus a nice prompt at the initial of the command where it tells you it is out of date. You have to upgrade from one version to another and I’m going to do exactly that. I’m going to copy this command, run it and it’s going to fetch everything that it needs in order to upgrade the command. The command will try to install. In my case, it actually errored out and that is because in some systems you will need to do a pseudo command like this. This will reinitiate the upgrade and it will go again through reinstalling everything. After a few attempts, you will hopefully get a successful IO command was actually installed correctly. In order to further check functionality of IO and its correctness of how it updated, I can just go ahead and do IO. I won’t include the minus H command because that has been removed in newer versions. I can look at the prompt. I can see all the options that it gives me and sure enough, I’m looking to not find a prompt that is actually out of date. That ensures that I’m using the latest version possible. In some other cases, the error might be related to your version of node. Like expected here, it is saying that I have version 14.17.3 and it’s expecting a list of 14.18. In this case, you could go back to documentation and refer to installing your latest node version. You can also go here and download the latest package and update your node version. Going back to my command here, I can simply redo the same command as before.
And there we go. We are now on the version two of the API Mesh plugin. This concludes this video tutorial and you have learned what’s needed so you can start to interact and perform operations with API Mesh.

Installing the aio CLI and API Mesh plugin

After installing node and npm, run the following command to install the aio CLI:

npm install -g @adobe/aio-cli

Once the Adobe I/O Runtime CLI is installed, use the following command to install the API Mesh plugin:

aio plugins:install @adobe/aio-cli-plugin-api-mesh

Useful API Mesh resources

recommendation-more-help
3a5f7e19-f383-4af8-8983-d01154c1402f