https://github.com/codejive/twinkle
A Java library for creating advanced console user interfaces
https://github.com/codejive/twinkle
Last synced: 14 days ago
JSON representation
A Java library for creating advanced console user interfaces
- Host: GitHub
- URL: https://github.com/codejive/twinkle
- Owner: codejive
- License: apache-2.0
- Created: 2023-03-10T01:14:24.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-12-29T13:20:55.000Z (about 1 month ago)
- Last Synced: 2026-01-01T15:22:11.665Z (about 1 month ago)
- Language: Java
- Size: 126 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Twinkle
Twinkle is a Java library for creating advanced text-based user interfaces.
This is a very early proof of concept, nothing to see here (yet)
## Building
To build the project, run the following command:
```bash
./mvnw clean package
```
## Running
To see a couple of very early demos, run the following commands:
```bash
java -cp twinkle-chart/target/twinkle-chart-1.0-SNAPSHOT.jar:twinkle-core/target/twinkle-core-1.0-SNAPSHOT.jar:twinkle-ansi/target/twinkle-ansi-1.0-SNAPSHOT.jar:twinkle-chart/target/test-classes examples.BarDemo
java -cp twinkle-chart/target/twinkle-chart-1.0-SNAPSHOT.jar:twinkle-core/target/twinkle-core-1.0-SNAPSHOT.jar:twinkle-ansi/target/twinkle-ansi-1.0-SNAPSHOT.jar:twinkle-chart/target/test-classes examples.MathPlotDemo
java -cp twinkle-chart/target/twinkle-chart-1.0-SNAPSHOT.jar:twinkle-core/target/twinkle-core-1.0-SNAPSHOT.jar:twinkle-ansi/target/twinkle-ansi-1.0-SNAPSHOT.jar:twinkle-chart/target/test-classes examples.MathPlotColorDemo
java -cp twinkle-chart/target/twinkle-chart-1.0-SNAPSHOT.jar:twinkle-core/target/twinkle-core-1.0-SNAPSHOT.jar:twinkle-ansi/target/twinkle-ansi-1.0-SNAPSHOT.jar:twinkle-chart/target/test-classes examples.MathPlotFourDemo
```
An easier way to run the demos is using [JBang](https://www.jbang.dev/):
```bash
./mvnw install -DskipTests
jbang run BarDemo
jbang run MathPlotDemo
jbang run MathPlotColorDemo
jbang run MathPlotFourDemo
```
These demos only show Twinkle's Ansi output capabilities. There is no interactivity being shown.