Installation

TUI4J is published to Maven Central. Add it as a dependency using your build tool of choice.

TUI4J requires Java 21 or later. Make sure your toolchain is configured accordingly.

Add the dependency

<dependency>
    <groupId>com.williamcallahan</groupId>
    <artifactId>tui4j</artifactId>
    <version>0.3.1-preview</version>
</dependency>

implementation 'com.williamcallahan:tui4j:0.3.1-preview'

implementation("com.williamcallahan:tui4j:0.3.1-preview")

That’s it for stable releases. No additional repository configuration is needed — Maven Central is the default for both Maven and Gradle.

Use a snapshot build

Snapshot builds are published to the Sonatype snapshot repository and track the latest development work. You need to add the repository before declaring the dependency.

Add the snapshot repository

<repositories>
    <repository>
        <id>sonatype-snapshots</id>
        <url>https://central.sonatype.com/repository/maven-snapshots/</url>
        <releases>
            <enabled>false</enabled>
        </releases>
        <snapshots>
            <enabled>true</enabled>
        </snapshots>
    </repository>
</repositories>

repositories {
    mavenCentral()
    maven(url = "https://central.sonatype.com/repository/maven-snapshots/")
}

Declare the snapshot dependency

<dependency>
    <groupId>com.williamcallahan</groupId>
    <artifactId>tui4j</artifactId>
    <version>0.3.3-SNAPSHOT</version>
</dependency>

dependencies {
    implementation("com.williamcallahan:tui4j:0.3.3-SNAPSHOT")
}

Prefer stable releases for production use. Snapshot versions may change without notice.

What gets included

TUI4J depends on three libraries that are pulled in automatically:

Library	Artifact	Purpose
JLine 3	`org.jline:jline-terminal-jni`	Terminal I/O, raw mode, key parsing
ICU4J	`com.ibm.icu:icu4j`	Unicode text width and grapheme cluster handling
Apache Commons Text	`org.apache.commons:commons-text`	Text utilities

You do not need to add these separately — they are declared as api dependencies and are available on your classpath automatically.

Verify the installation

After adding the dependency, confirm the library resolves by importing a core class in your IDE or running a quick compilation:

import com.williamcallahan.tui4j.compat.bubbletea.Model;
import com.williamcallahan.tui4j.compat.bubbletea.Program;

If your build resolves without errors, you are ready to go. Head to Quickstart to build your first TUI application.

Get Started

Core Concepts

Components

Guides

Compatibility

Installation

Add the dependency

Use a snapshot build

What gets included

Verify the installation

​Add the dependency

​Use a snapshot build

​What gets included

​Verify the installation

Add the dependency

Use a snapshot build

What gets included

Verify the installation