{"id":24271532,"url":"https://github.com/kartoffelchipss/tui4j","last_synced_at":"2026-06-07T11:31:18.873Z","repository":{"id":271594792,"uuid":"913954891","full_name":"KartoffelChipss/TUI4J","owner":"KartoffelChipss","description":"A Java library for making TUIs including easy inputs and text formatting","archived":false,"fork":false,"pushed_at":"2026-01-21T13:55:40.000Z","size":1445,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-01-21T22:49:23.116Z","etag":null,"topics":["formatting","forms","input","java","java-tui","tui","tui4j"],"latest_commit_sha":null,"homepage":"https://tui4j.strassburger.org/","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/KartoffelChipss.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-01-08T17:07:14.000Z","updated_at":"2026-01-21T13:56:06.000Z","dependencies_parsed_at":"2025-01-08T18:27:42.720Z","dependency_job_id":"16835f3d-14e2-435e-9262-0d908aedcc2d","html_url":"https://github.com/KartoffelChipss/TUI4J","commit_stats":null,"previous_names":["kartoffelchipss/tui4j"],"tags_count":9,"template":false,"template_full_name":null,"purl":"pkg:github/KartoffelChipss/TUI4J","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KartoffelChipss%2FTUI4J","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KartoffelChipss%2FTUI4J/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KartoffelChipss%2FTUI4J/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KartoffelChipss%2FTUI4J/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/KartoffelChipss","download_url":"https://codeload.github.com/KartoffelChipss/TUI4J/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KartoffelChipss%2FTUI4J/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34020187,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-07T02:00:07.652Z","response_time":124,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["formatting","forms","input","java","java-tui","tui","tui4j"],"created_at":"2025-01-15T17:53:19.191Z","updated_at":"2026-06-07T11:31:18.867Z","avatar_url":"https://github.com/KartoffelChipss.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# TUI4J\n\n![maven build and test](https://github.com/KartoffelChipss/TUI4J/actions/workflows/maven-build-and-test.yml/badge.svg)\n[![Release](https://jitpack.io/v/KartoffelChipss/TUI4J.svg)](https://jitpack.io/#KartoffelChipss/TUI4J)\n![Monthly download statistics](https://jitpack.io/v/KartoffelChipss/TUI4J/month.svg)\n\nTUI4J is a Java-based library for creating text-based user interfaces (TUIs).\n\n## Demo\n\n![Demo](https://f.j4n.net/tui_demo.gif)\n\n*You can find the code for this demo [here](#example-usage).*\n\n## Features\n\n- Flexible Inputs\n  - Text Input\n  - Multiline Text Input\n  - Number Input\n  - Boolean Input\n  - Selection Input\n  - Date Input\n  - Enter-To-Continue Input\n- Easy text formatting\n  - Colors\n  - Flex Layouts (Centering, Justifying, Spacing)\n  - Tables\n  - Spinners and Loaders\n- Command Line Parsing\n  - Subcommands\n  - Options\n  - Arguments\n- Customizable\n  - Custom Input Prompts\n  - Custom Input Validators\n\n## Installation\n\nMake sure to replace `0.0.0` with the version you want to use. (You can find the latest version [here](https://jitpack.io/#KartoffelChipss/TUI4J))\n\n### Maven\n\n```xml\n\u003cdependencies\u003e\n    \u003cdependency\u003e\n        \u003cgroupId\u003eorg.strassburger\u003c/groupId\u003e\n        \u003cartifactId\u003eTUI4J\u003c/artifactId\u003e\n        \u003cversion\u003e0.0.0\u003c/version\u003e\n    \u003c/dependency\u003e\n\u003c/dependencies\u003e\n\n\u003crepositories\u003e\n    \u003crepository\u003e\n        \u003cid\u003ejitpack.io\u003c/id\u003e\n        \u003curl\u003ehttps://jitpack.io\u003c/url\u003e\n    \u003c/repository\u003e\n\u003c/repositories\u003e\n```\n\n### Gradle\n\n```groovy\ndependencies {\n    implementation 'org.strassburger:TUI4J:0.0.0'\n}\n\nrepositories {\n    maven { url 'https://jitpack.io' }\n}\n```\n\n## API Documentation\n\nThe API documentation can be found [here](https://tui4j.strassburger.org).\n\n## Examples\n\n### Formatting and Inputs\n\n```java\npackage org.example;\n\nimport org.strassburger.tui4j.formatting.ansi.AnsiColor;\nimport org.strassburger.tui4j.formatting.StyledText;\nimport org.strassburger.tui4j.formatting.layout.FlexJustify;\nimport org.strassburger.tui4j.formatting.layout.FlexText;\nimport org.strassburger.tui4j.formatting.layout.Spinner;\nimport org.strassburger.tui4j.formatting.layout.SpinnerFrames;\nimport org.strassburger.tui4j.input.*;\nimport org.strassburger.tui4j.input.validationrules.NumberValidationRules;\nimport org.strassburger.tui4j.input.validationrules.TextValidationRules;\nimport org.strassburger.tui4j.input.validationrules.ValidationRule;\nimport org.strassburger.tui4j.printer.ConsolePrinter;\nimport org.strassburger.tui4j.printer.Printer;\n\npublic class Main {\n    public static void main(String[] args) {\n        Printer printer = new ConsolePrinter();\n    \n        printer.println(\" \");\n        printer.println(new FlexText(StyledText.text(\"Welcome to the TUI4J example application!\").fg(AnsiColor.BLUE).bold()));\n        printer.println(\" \");\n    \n        String name = new TextInput(printer)\n                .setPrompt(\"What is your name? \")\n                .setInline(true)\n                .read();\n    \n        String gender = new SelectInput\u003cString\u003e(printer)\n                .setPrompt(\"Select your gender: \")\n                .addOption(\"Male\", \"Male\")\n                .addOption(\"Female\", \"Female\")\n                .addOption(\"Other\", \"Other\")\n                .setOptionsStyle(StyledText.text(\" (%num%) \").fg(AnsiColor.CYAN).append(\"%label%\"))\n                .read();\n    \n        String email = new TextInput(printer)\n                .setPrompt(\"What is your email address?\")\n                .addValidationRule(\n                        new ValidationRule\u003cString\u003e() {\n                            @Override\n                            public boolean validate(String s) {\n                                return s.contains(\"@\") \u0026\u0026 s.contains(\".\");\n                            }\n      \n                            @Override\n                            public StyledText getErrorMessage() {\n                                return StyledText.text(\"Email address must contain '@' and '.'\").fg(AnsiColor.RED);\n                            }\n                        }\n                )\n                .read();\n    \n        String about = new MultilineTextInput(printer)\n                .setPrompt(\"Tell me about yourself: \")\n                .addValidationRule(TextValidationRules.minLength(30))\n                .read();\n    \n        int age = new IntegerInput(printer)\n                .setPrompt(\"How old are you? \")\n                .addValidationRule(NumberValidationRules.greaterThan(0))\n                .addValidationRule(NumberValidationRules.lessThan(150))\n                .read();\n    \n        double height = new DoubleInput(printer)\n                .setPrompt(\"How tall are you? \")\n                .addValidationRule(NumberValidationRules.greaterThan(0.0))\n                .addValidationRule(NumberValidationRules.lessThan(3.0))\n                .read();\n    \n        printer.println(\" \");\n        printer.println(StyledText.text(\"Your Inputs:\").fg(AnsiColor.BRIGHT_WHITE).bold());\n        printer.println(new FlexText()\n                .addPart(StyledText.text(\"Name \").fg(AnsiColor.BRIGHT_WHITE))\n                .addPart(StyledText.text(\" \" + name).fg(AnsiColor.BRIGHT_WHITE))\n                .setJustify(FlexJustify.SPACE_BETWEEN)\n                .setSeparatorChar(StyledText.text(\".\").fg(AnsiColor.BRIGHT_BLACK))\n        );\n        printer.println(FlexText.keyValue(\"Email \", \" \" + email));\n        printer.println(FlexText.keyValue(\"Age \", \" \" + age));\n        printer.println(FlexText.keyValue(\"Height (m) \", \" \" + height));\n        printer.println(FlexText.keyValue(\"Gender \", \" \" + gender));\n        printer.println(\" \");\n    \n        boolean shouldContinue = new BooleanInput(printer)\n                .setPrompt(\"Do you want to continue? (y/n)\")\n                .read();\n    \n        if (shouldContinue) {\n            printer.println(\"Continuing...\");\n\n          Spinner spinner = new Spinner()\n                  .setMessage(StyledText.text(\"Loading some stuff...\"))\n                  .setSpinnerColor(AnsiColor.CYAN)\n                  .setSpinnerFrames(SpinnerFrames.SYNTHWAVE)\n                  .setSpeedMs(100);\n          printer.print(spinner);\n\n          for (int i = 0; i \u003c 50; i++) {\n            Thread.sleep(100);\n            spinner.setMessage(StyledText.text(\"Loading some stuff... \" + (i + 1) * 2 + \"%\"));\n          }\n\n          spinner.stop(StyledText.text(\"✔ Loading complete!\").fg(AnsiColor.GREEN).bold());\n            \n        } else {\n            printer.println(\"Exiting...\");\n        }\n    }\n}\n```\n\n### Commands\n\n```java\nimport org.strassburger.tui4j.command.Argument;\nimport org.strassburger.tui4j.command.Command;\nimport org.strassburger.tui4j.command.Option;\nimport org.strassburger.tui4j.command.exceptions.CommandException;\nimport org.strassburger.tui4j.formatting.layout.*;\nimport org.strassburger.tui4j.input.*;\n\npublic class Main {\n    public static void main(String[] args) {\n        String[] testArgs = \"farewell franky\".split(\" \");\n        System.out.println(\"Executing with args: \" + String.join(\" \", testArgs));\n    \n        Option\u003cString\u003e nameOption = Option.str(\"name\", \"n\", \"World\");\n        Argument\u003cString\u003e nameArgument = Argument.str(\"name\", true);\n    \n        Command command = Command.root()\n                .addSubCommand(\n                        Command.named(\"greet\")\n                                .addOption(nameOption)\n                                .setHandler(context -\u003e {\n                                  String name = context.getOptionValue(nameOption);\n                                  System.out.println(\"Hello, \" + name + \"!\");\n                                }),\n                        Command.named(\"farewell\")\n                                .addArgument(nameArgument)\n                                .setHandler(context -\u003e {\n                                  String name = context.getArgumentValue(nameArgument);\n                                  System.out.println(\"Goodbye, \" + name + \"!\");\n                                })\n                );\n    \n        try {\n            command.execute(testArgs);\n        } catch (CommandException e) {\n            System.err.println(\"Error: \" + e.getMessage());\n        }\n    }\n}\n```\n\n### Table\n\n```java\nimport org.strassburger.tui4j.formatting.StyledText;\nimport org.strassburger.tui4j.formatting.ansi.AnsiColor;\nimport org.strassburger.tui4j.formatting.layout.table.Table;\nimport org.strassburger.tui4j.formatting.layout.table.styles.ColumnAlign;\nimport org.strassburger.tui4j.formatting.layout.table.styles.TableStyles;\nimport org.strassburger.tui4j.printer.ConsolePrinter;\nimport org.strassburger.tui4j.printer.Printer;\n\nimport java.util.List;\n\npublic class Main {\n  public static void main(String[] args) {\n      Printer printer = new ConsolePrinter();\n    \n      List\u003cStyledText\u003e headers = List.of(\n              StyledText.text(\"Name\").fg(AnsiColor.BRIGHT_WHITE).bold(),\n              StyledText.text(\"Age\").fg(AnsiColor.BRIGHT_WHITE).bold(),\n              StyledText.text(\"City\").fg(AnsiColor.BRIGHT_WHITE).bold()\n      );\n    \n      List\u003cStyledText\u003e row1 = List.of(\n              StyledText.text(\"Alice\").fg(AnsiColor.CYAN),\n              StyledText.text(\"30\").fg(AnsiColor.GREEN),\n              StyledText.text(\"New York\").fg(AnsiColor.MAGENTA)\n      );\n    \n      List\u003cStyledText\u003e row2 = List.of(\n              StyledText.text(\"Bob\").fg(AnsiColor.CYAN),\n              StyledText.text(\"25\").fg(AnsiColor.GREEN),\n              StyledText.text(\"Los Angeles\").fg(AnsiColor.MAGENTA)\n      );\n    \n      List\u003cStyledText\u003e row3 = List.of(\n              StyledText.text(\"Charlie\").fg(AnsiColor.CYAN),\n              StyledText.text(\"35\").fg(AnsiColor.GREEN),\n              StyledText.text(\"Chicago\").fg(AnsiColor.MAGENTA)\n      );\n    \n      Table table = new Table()\n              .setStyle(TableStyles.UNICODE_BOX.withBorderColor(AnsiColor.BRIGHT_BLACK))\n              .setHasHeader(true)\n              .setColumnGrow(0, 1)\n              .setColumnAlignment(0, ColumnAlign.START)\n              .setColumnAlignment(1, ColumnAlign.CENTER)\n              .setColumnAlignment(2, ColumnAlign.END)\n              .addRow(headers)\n              .addRow(row1)\n              .addRow(row2)\n              .addRow(row3);\n    \n      printer.println(table);\n  }\n}\n```\n\n## License\n\nThis project is licensed under the GNU General Public License v3.0 - see the [LICENSE](https://github.com/KartoffelChipss/TUI4J/blob/main/LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkartoffelchipss%2Ftui4j","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkartoffelchipss%2Ftui4j","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkartoffelchipss%2Ftui4j/lists"}