Install Jeamlit

There are 2 main ways to install and run Jeamlit:

Read the details to get more information about each option.

Short Version

Jeamlit requires A Java JDK >= 21.

Standalone CLI and app runner

  1. Install: (JBang is highly recommended)

    # recommended: install with jbang jbang app install jeamlit@jeamlit # vanilla curl -L -o jeamlit.jar https://repo1.maven.org/maven2/io/jeamlit/jeamlit/0.44.0/jeamlit-0.44.0-all.jar

  2. Validate the installation by running the Hello app:

    # jbang jeamlit hello # vanilla java -jar jeamlit.jar hello

  3. Jump to our Basic concepts.

Embedded server

  1. Add the dependency to your project
    <dependency> <groupId>io.jeamlit</groupId> <artifactId>jeamlit</artifactId> <version>0.44.0</version> </dependency>
  2. Launch the server in your project:
    void startJeamlitServer() { // the Jeamlit app class class MyApp { public static void main(String[] args) { Jt.text("Hello World").use(); } } // prepare a Jeamlit server var server = Server.builder(MyApp.class, 8888).build(); // start the server - this is non-blocking server.start(); }

Details

Option 1: Standalone

Best for getting started, simple apps, education, testing, documentation and demos.
JBang-style dependency import included.

Option 2: Embedded in a Maven/Gradle project

Best for complex apps, existing systems and production systems.

Option 3: Embedded in a Spring project

Best for ... integrating Jeamlit in a Spring project.

Previous: Get startedNext: Standalone
forum

Still have questions?

Go to our discussions forum for helpful information and advice from Jeamlit experts.