Skip to content
Quarkus Studio

Initial Setup

Getting Started with Quarkus Studio

Section titled “Getting Started with Quarkus Studio”

Quarkus Studio is an advanced developer productivity suite for Quarkus, available on the Open VSX Registry and compatible with VS Code, VSCodium, Eclipse Theia, and Gitpod.

This guide will walk you through installing the required developer toolchain (Java, Maven or Gradle, and Quarkus CLI) using SDKMAN!, configuring container runtimes, and launching Quarkus Studio.

🛠️ Step 1: Install Required Software with SDKMAN!

Section titled “🛠️ Step 1: Install Required Software with SDKMAN!”

SDKMAN! is the easiest and most reliable tool to manage parallel versions of multiple Software Development Kits (Java, Maven, Gradle, Quarkus CLI) on macOS, Linux, and Windows (via WSL or MSYS2).

  1. Install SDKMAN!

    Section titled “Install SDKMAN!”

    Open a terminal and run the official installation script:

    Terminal window
    curl -s "https://get.sdkman.io" | bash

    Open a new terminal or initialize SDKMAN in your current session:

    Terminal window
    source "$HOME/.sdkman/bin/sdkman-init.sh"

    Verify the installation:

    Terminal window
    sdk version
  2. Section titled “Install Java (JDK 21 LTS Recommended)”

    Quarkus works best with modern LTS versions of Java (Java 17 or Java 21). Install Eclipse Temurin (or GraalVM / Mandrel for ahead-of-time native image compilation):

    Terminal window
    sdk install java 21-tem

    Verify your Java version:

    Terminal window
    java -version

  3. Install Build Tool (Maven or Gradle)

    Section titled “Install Build Tool (Maven or Gradle)”

    Install either Apache Maven or Gradle (or both):

    Terminal window
    sdk install maven

    Verify:

    Terminal window
    mvn -version

  4. Install Quarkus CLI

    Section titled “Install Quarkus CLI”

    The official Quarkus command-line interface makes it easy to create projects, execute commands, and run Dev Mode from the shell:

    Terminal window
    sdk install quarkus

    Verify the Quarkus CLI installation:

    Terminal window
    quarkus --version

🐳 Step 2: Container Engine (For Dev Services)

Section titled “🐳 Step 2: Container Engine (For Dev Services)”

Quarkus Dev Services starts zero-config background containers (PostgreSQL, Kafka, Redis, Keycloak, etc.) automatically during dev mode and testing.

Ensure you have one of the following container runtimes running:

  • Docker Desktop or Docker Engine: docker ps
  • Podman: podman ps

💻 Step 3: Install Quarkus Studio Extension

Section titled “💻 Step 3: Install Quarkus Studio Extension”
  1. Open your editor and press Ctrl + Shift + X (or Cmd + Shift + X on macOS) to open the Extensions view.
  2. Search for Quarkus Studio or maratib.quarkus-studio.
  3. Click Install.

⚙️ Step 4: Configure Settings (Optional)

Section titled “⚙️ Step 4: Configure Settings (Optional)”

Quarkus Studio works out of the box with zero configuration. You can adjust your container runtime or auto-refresh settings in settings.json:

.vscode/settings.json
{
  "quarkusStudio.containerRuntime": "auto",
  "quarkusStudio.devServices.autoRefresh": true,
  "quarkusStudio.continuousTesting.rerunOnSave": true
}

🚀 Step 5: Launch Your First Project

Section titled “🚀 Step 5: Launch Your First Project”

  1. Create or Open a Quarkus Project

    Section titled “Create or Open a Quarkus Project”
    • From Command Palette: Press Ctrl/Cmd + Shift + P and run Quarkus Studio: Create Single Module Project with Maven (or Gradle).
    • From Terminal with Quarkus CLI:
      Terminal window
      quarkus create app com.example:my-quarkus-app --extension=resteasy-reactive-jackson
      code my-quarkus-app

  2. Open the Apps View Sidebar

    Section titled “Open the Apps View Sidebar”

    Click the Quarkus Studio icon in the Activity Bar on the left. You will see your service listed under the Apps tree.

  3. Start Dev Mode and Launch Dev UI

    Section titled “Start Dev Mode and Launch Dev UI”
    • Click the green Play button next to your app (or run quarkus dev).
    • Quarkus Studio launches Dev Mode in a dedicated integrated terminal.
    • Click Open Dev UI in the sidebar to open http://localhost:8080/q/dev-ui directly in your browser.

🎯 Next Steps

Section titled “🎯 Next Steps”

Explore the capabilities of Quarkus Studio:

Project BuilderScaffold single & multi-module enterprise architectures with Maven or Gradle.
Apps View & Dev ModeManage application lifecycles and browse REST endpoints with one-click navigation.
Dev Services ManagerInspect background test containers, grab JDBC connection strings, and stream logs.
Panache Entity GeneratorGenerate Active Record or Repository entities, DTOs, and REST CRUD APIs from JSON or SQL.