Liferay Workspace

Liferay Workspace is an environment designed to handle the full development life cycle (i.e. create, build, deploy, test) for Liferay DXP projects. Because it is implemented with Gradle scripts and plugins, Liferay Workspace integrates seamlessly with any IDE or development tool. It also works hand-in-hand with Liferay’s CLI utilities: Blade CLI, which exists to manage workspaces and projects, and the Liferay Cloud CLI, which exists to manage Cloud services and deploy client extensions to the Cloud Platform.

Prerequisites

Complete these prerequisites to install Liferay Workspace on your computer:

1. Install Java: Oracle JDK 11

2. Install Blade CLI with this command:

   curl -L https://raw.githubusercontent.com/liferay/liferay-blade-cli/master/cli/installers/local | sh
   

   A Blade installed successfully message is displayed after completing the installation. Type blade to check if the tool is working.

   Note

   While we recommend using Blade to set up Liferay Workspace, you can also use Gradle to complete the process manually. See Creating a Liferay Workspace Manually for more information.

3. Install and configure the Liferay Cloud CLI by following these steps:

   1. Run this command:

      curl https://cdn.liferay.cloud/lcp/stable/latest/install.sh -fsSL | bash
      

      If you get a permission error, try replacing bash with sudo bash and running the command again.

      Note

      For Windows systems, find the link to download the Windows installer at Installing the CLI Tool.

   2. Run lcp login to authenticate the tool with your Liferay Cloud Platform’s account.

   3. When prompted to open the browser, type Y and press the Enter key.

   4. Finally, log into your account and wait for the success screen. Your tool should then be authenticated.

4. Configure the CLI tool to point to Liferay Cloud Platform’s remote URL (liferay.cloud). See Configuring the CLI Remote for instructions.

5. Run the lcp login command to authenticate the CLI tool with your platform account.

6. Choose and install one of these IDEs in your computer:

   • VS Code (recommended)
   • Sublime Text
   • Eclipse
   • Intellij IDEA

Creating a Liferay Workspace

Follow these steps to generate your own Liferay Workspace:

1. In your command line interface, go to a directory or create an empty folder where you want to generate your workspace.

2. Run this command to see and choose your preferred DXP version:

   blade init -l
   

   Tip

   DXP’s latest version is recommended.

3. Run this command with your chosen version and a name for your workspace:

   blade init -v [Liferay version] [workspace name]
   

   For example,

   blade init -v dxp-7.4-u102 clarity-workspace
   

If the command doesn’t return any errors, the workspace has been successfully generated and is ready to use. You can keep all development resources for the course here.

Next, we’ll introduce you to Client Extensions and explain how they relate to Liferay Workspace.

Up Next: Client Extensions

Additional Resources

Follow these links to troubleshoot installation and learn more about the tools covered in this article:

• Liferay Workspace
• Blade CLI
• Liferay Cloud CLI