Skip to content
Skillpedia
APIs & servers (backend)40k · #5084

create-quarkus-project

Lets your agent start a new Quarkus project. It sets up the project with the right tools and makes it ready to start coding.

What it does

This agent creates a new Quarkus project for you. It can set up the project with the tools you need, like databases and API features.

When to use it

  • ✓When you want to start a new Quarkus application.
  • ✓When you need a basic REST API.
  • ✓When you want to add features like databases or security to your project.

Example of what to ask your AI

“Create a Quarkus project with extensions for REST, PostgreSQL, and security.”

Want more? Open the sections below.

How to use

The easiest way: copy the message below and paste it into Claude, ChatGPT, Cursor or any AI. It reads the skill and follows the instructions.

Skill link

https://github.com/github/awesome-copilot/blob/main/skills/create-quarkus-project/SKILL.md

Ready-to-paste message

Use this skill to help me: https://github.com/github/awesome-copilot/blob/main/skills/create-quarkus-project/SKILL.md Read the SKILL.md file at that link and follow its instructions for my task.
How it works

It uses tools like the Quarkus CLI or the Maven plugin to generate the initial project structure. You can choose which 'extensions' (extra features) to include.

Installation

Easiest way: copy the skill link and paste it into Claude, ChatGPT or Cursor asking it to follow the instructions.

In the terminal (Claude Code, Codex, Cursor), in your project folder:

npx skills add github/awesome-copilot --skill create-quarkus-project

Or download just the file:

curl -L https://raw.githubusercontent.com/github/awesome-copilot/main/skills/create-quarkus-project/SKILL.md -o SKILL.md
Technical content (original SKILL.md)

Original text by the author, straight from GitHub.

Create a Quarkus Project

1. Detect the environment

java -version          # Java 17, 21 or 25 (Quarkus 3.40 recommends 25, 3.27 recommends 21)
quarkus --version      # optional Quarkus CLI
./mvnw -v || mvn -v    # or ./gradlew -v

If the folder already contains a Quarkus project (io.quarkus.platform BOM, quarkus-maven-plugin, or io.quarkus Gradle plugin), do NOT scaffold: read its Quarkus version and keep it. For a new project, use the stream marked recommended on https://code.quarkus.io/api/streams (an LTS stream; see also https://quarkus.io/support/), and do not invent a patch version: let the tool pick it. Quarkus 4.0 is still a beta, so do not use it unless asked. If an extension is missing from the recommended stream, the CLI silently picks an older stream; check quarkus.platform.version in the generated build file.

2. Scaffold (pick one)

Quarkus CLI (install via https://quarkus.io/get-started/ , e.g. SDKMAN sdk install quarkus):

quarkus create app com.example:demo \
  --extension='rest-jackson,hibernate-orm-panache,jdbc-postgresql,hibernate-validator,smallrye-health' \
  --java=21 --maven        # or --gradle

No CLI: Maven plugin (pin the version to the current release from https://quarkus.io/guides/maven-tooling, replace QUARKUS_VERSION below with it):

mvn io.quarkus.platform:quarkus-maven-plugin:QUARKUS_VERSION:create \
  -DprojectGroupId=com.example -DprojectArtifactId=demo \
  -Dextensions='rest-jackson,hibernate-orm-panache,jdbc-postgresql' \
  -DbuildTool=maven        # or gradle

Or generate from the https://code.quarkus.io web UI / REST API (https://code.quarkus.io/d?g=com.example&a=demo&e=rest-jackson&b=MAVEN) and unzip.

3. Choose extensions

Need Extension
REST + JSON rest-jackson (Quarkus REST; not legacy resteasy)
Database ORM hibernate-orm-panache, jdbc-postgresql
Validation hibernate-validator
Health / metrics smallrye-health, micrometer-registry-prometheus
Auth oidc or smallrye-jwt
OpenAPI smallrye-openapi
REST client rest-client-jackson
Container container-image-jib (or container-image-docker)

Add later with quarkus extension add <name> or ./mvnw quarkus:add-extension -Dextensions=<name>; quarkus extension list --installable lists options.

4. Layout and run

src/main/java/...          # resources, services, entities
src/main/resources/application.properties
src/main/docker/           # Dockerfile.jvm, Dockerfile.native, ...
src/test/java/...          # @QuarkusTest / @QuarkusIntegrationTest
./mvnw quarkus:dev         # or: quarkus dev / ./gradlew quarkusDev

Generated tests include a *IT class that Maven skips by default (<skipITs>true</skipITs> in the template); run it with ./mvnw verify -DskipITs=false or -Dnative. Dev mode gives live reload, Dev UI at http://localhost:8080/q/dev-ui, Dev Services (auto containers), and continuous testing (press r). Package: ./mvnw package (runnable target/quarkus-app/quarkus-run.jar).

References

Verified (scaffold, ./mvnw verify, ./gradlew build, dev mode, Dev Services PostgreSQL, JDK 26 with Java 25 release) on Quarkus 3.40.1 (current recommended LTS stream) and ./mvnw verify on 3.27.6 (older LTS).

Related skills: quarkus-dev-services-and-testing, quarkus-native-and-container.

Upstream sources (read before upgrading)

Fetch the page for the target version; prefer it over this skill when they conflict.

FAQ

What are 'extensions'?

Extensions are like pre-built feature packages you can add to your Quarkus project, such as database support, security, or specific APIs.

How do I add more extensions later?

You can add more extensions using commands like `quarkus extension add <extension-name>` or `./mvnw quarkus:add-extension -Dextensions=<extension-name>`.

What Java version do I need?

Generally, newer Java versions are recommended, such as Java 21 or 25, depending on the Quarkus version you are using.

Details

Original description by the author

Create a new Quarkus project (Maven or Gradle) with the Quarkus CLI, code.quarkus.io API or Maven plugin, choose extensions, and run it in dev mode. Use when asked to scaffold, bootstrap or start a Quarkus application or REST API.

repo: github/awesome-copilot

Popularity

GitHub stars
40k
Ranking position
#5084
License
MIT
Updated
10/15/2026

Is this skill useful?

0

Sign in to vote.

Comments

  • …

More skills from this repository

Similar skills