A lightweight Java library for interactive console input with a pluggable command system.
ConsoleReader reads lines from standard input, splits them into commands and arguments, and dispatches them to registered handlers. Commands are defined via a simple functional interface, making it easy to build interactive CLIs, debug consoles, or chat-style bots.
- Command registration — Map commands to handlers at runtime with
registerCommand - Argument parsing — Input is automatically split into command + args array
- Thread-safe mode — Optional
ConcurrentHashMapbackend for multi-threaded use - Custom prompts — Set the text shown before each input line
- Console clearing — Built-in
clearConsole()helper (ANSI escape codes) - Java 8+ — Works with lambdas and method references
- Java 8 or later
- Maven
<dependency>
<groupId>pw.navo</groupId>
<artifactId>consolereader</artifactId>
<version>1.0.0</version>
<scope>compile</scope>
</dependency>ConsoleReader consoleReader = new ConsoleReader("console>");
// Register a command with a custom class
consoleReader.registerCommand("test", new TestCommand());
// Register a command with a lambda (Java 8+)
consoleReader.registerCommand("clear", (String... arguments) -> {
consoleReader.clearConsole();
});
// This blocks your thread and waits for user input
try {
consoleReader.listen();
} catch (IOException exception) {
exception.printStackTrace();
}public static class TestCommand implements ConsoleReader.ConsoleCommand {
@Override
public void onCommand(String... arguments) {
System.out.println("Test command called with " + arguments.length + " arguments");
}
}
Copyright © 2017 navopw
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.