Get Started

Step 1

Install via Command Line Interface

Open your favorite terminal and use JBang to install the Quarkus CLI. You do not need to have Java installed first.

For Linux, macOS, and Windows (using WSL or bash compatible shell like Cygwin or MinGW)

curl -Ls https://sh.jbang.dev | bash -s - trust add https://repo1.maven.org/maven2/io/quarkus/quarkus-cli/
curl -Ls https://sh.jbang.dev | bash -s - app install --fresh --force quarkus@quarkusio

For Windows using Powershell

iex "& { $(iwr https://ps.jbang.dev) } trust add https://repo1.maven.org/maven2/io/quarkus/quarkus-cli/"
iex "& { $(iwr https://ps.jbang.dev) } app install --fresh --force quarkus@quarkusio"

If it's your first time to install, you'll need to restart your shell.

Or, you can also install the CLI with SDKMAN!

sdk install quarkus

For more options, such as Homebrew or Chocolatey, see the Quarkus CLI guide.

Step 2

Create the Getting Started Application

Run this script in your CLI:

quarkus create && cd code-with-quarkus

Step 3

Run the Getting Started Application

Run this script in your CLI:

quarkus dev

Boom! Your Quarkus app is now running at localhost:8080

Step 4

Live Coding with Quarkus

Quarkus makes it easy to change your code on the fly. Let's modify the RESTful endpoint

Open src/main/java/GreetingsResource.java in a text editor or your favorite IDE and change "hello RESTEasy" to "hola RESTEasy". Then refresh the browser and see the changes.

@Path("/hello")
public class GreetingsResource {

    @GET
    @Produces(MediaType.TEXT_PLAIN)
    public String hello() {
        return "Hello RESTEasy";
    }
}

Cool stuff right? Learn more about Quarkus's dev mode.