The power of a Liferay IDE, inside the editor you love.Learn More
Liferay Studio extension is developed for Liferay Developers who are looking for light weight easy to use development environments for their development workflows.
Its a meticulously crafted extension that brings a seamless, integrated, and blazing-fast Liferay development experience directly into Visual Studio Code. Say goodbye to context switching and hello to a unified, modern workflow.
🚀 Zero to Liferay in Seconds: Scaffold complete Liferay Workspaces and Modules directly from the Command Palette.
📡 Integrated Server Control: Start and stop your Liferay instance without ever leaving VS Code, with a handy status bar toggle.
🪄 One-Command Deployment: Build, deploy, and even hot-deploy all modules with a single command. The hot-deploy watcher automatically redeploys on save, giving you a rapid feedback loop.
🗃️ Context-Aware Menus: Access all commands through a convenient "Liferay" context menu in the file explorer.
📦 Curated Environment: Automatically installs recommended extensions for Java, JSP, and Freemarker to give you a first-class development experience out of the box.
🧠 Smart & Efficient: The extension only activates when a Liferay workspace is detected, keeping your editor lean and fast.
🏁 Getting Started
1. Prerequisites
Before you begin, ensure you have the following installed:
Install Liferay Studio from the VS Code Marketplace.
3. Initial Workspace Setup
After creating your first Liferay Workspace using the extension, you need to tell it where your Liferay server bundle is located.
Recommended Setup :
cmd/ctrl+shift+p : Liferay Studio: Liferay Home
and select your liferay bundle home location or
Manual Setup :
Open the gradle.properties file in the root of your new workspace.
Add the following line, pointing to your Liferay Portal home directory:
# This should point to the root of your Liferay bundle (e.g., /path/to/liferay-ce-portal-7.4.3.113-ga113)
liferay.workspace.home.dir=/path/to/your/liferay/bundle
Liferay new workspace
cmd/ctrl+shift+p : Liferay Studio: New workspace
To create a new liferay workspace.
Select Liferay home
cmd/ctrl+shift+p : Liferay Studio: Liferay Home
Location where tomcat liferay bundle is installed
Start/Stop liferay server
cmd/ctrl+shift+p : Liferay Studio: Start/Stop Liferay Server
Alternatively you have a vscode bottom status bar item with an antenna icon labeled as LR to toggle liferay server start/stop
