You can install Blade CLI using the Liferay Project SDK installer. This installs JPM and Blade CLI into your user home folder and optionally initializes a Liferay Workspace folder. Do not use the Liferay Project SDK installer to update Blade CLI; instead, follow the instructions for updating Blade CLI.
If you must configure proxy settings for Blade CLI, follow the Installing Blade CLI with Proxy Requirements instructions instead.
Follow the steps below to download and install Blade CLI:
-
Download the latest Liferay Project SDK installer that corresponds with your operating system (e.g., Windows, MacOS, or Linux). The Project SDK installer is listed under Liferay IDE, so the folder versions are based on IDE releases. You can select an installer without Dev Studio DXP if you don’t intend to use it. The Project SDK installer is available for versions 3.2.0+. Do not select the large green download button; this downloads Liferay Portal instead.
-
Run the installer.
-
Select the Java Runtime to use with Blade CLI. Then click OK.
-
Click Next to step through the installer’s introduction.
-
If you’d like to initialize a Liferay Workspace, you can set its location.
Figure 1: Determine where your Liferay Workspace should reside, if you want one.
Select Don’t initialize Liferay Workspace directory if you only want to install Blade CLI. Then click Next.
-
If you initialized a Liferay Workspace folder, an additional option appears for selecting the Liferay product type to use with your workspace. Choose the product type and click Next.
Figure 2: Select the product version you'll use with your Liferay Workspace.
-
Click Next to begin installing Blade CLI/Liferay Workspace on your computer.
That’s it! Blade CLI is installed on your machine! If you specified a location to initialize a Liferay Workspace folder, that is also available.
If Blade CLI doesn’t work properly on your machine, visit the Common Errors with Blade CLI article for solutions to common problems.