JReadline is a Java library for handling console input.
Java Groovy
#1 Compare This branch is 1 commit ahead, 1193 commits behind aeshell:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
config/checkstyle
src
.gitignore
README.md
build.gradle
license.txt
pom.xml

README.md

JReadline

JReadline is a Java library for handling console input with the goal to support most GNU Readline features.

Features:

  • Line editing
  • History (search, persistence)
  • Completion
  • Masking
  • Undo and Redo
  • Paste buffer
  • Emacs and Vi editing mode
  • Supports POSIX OS's and Windows
  • Easy to configure (history file & buffer size, edit mode, streams, possible to override terminal impls, etc)
  • Support standard out and standard error
  • Redirect

How to build:

To get going:

public class Example {

public static void main(String[] args) throws java.io.IOException {

    org.jboss.jreadline.console.Console console = new org.jboss.jreadline.console.Console();

    org.jboss.jreadline.console.ConsoleOutput line;
    while ((line = console.read("> ")) != null) {
        console.pushToConsole("======>\"" +line.getBuffer()+ "\n");

        if (line.getBuffer().equalsIgnoreCase("quit") || line.getBuffer().equalsIgnoreCase("exit")) {
            break;
        }
    }

}

}

Keys that are mapped by default in JReadline

Note: C equals Control and M is Meta/Alt

EMACS Mode

  • Move back one char : C-b or left arrow
  • Move forward one char : C-f or right arrow
  • Delete the character left of cursor : backspace
  • Delete the character on cursor : C-d
  • Undo : C-_ or C-x C-u
  • Move to the start of the line : C-a or home
  • Move to the end of the line : C-e or end
  • Move forward a word, where a word is composed of letters and digits : M-f
  • Move backward a word : M-b
  • Previous line : up arrow
  • Next line : down arrow
  • Clear the screen, reprinting the current line at the top : C-l
  • Delete next word to the right of cursor : M-d
  • Complete : tab
  • Kill the text from the current cursor position to the end of the line : C-k
  • Kill from the cursor to the end of the current word, or, if between words, to the end of the next word : M-d
  • Kill from the cursor to the previous whitespace : C-w
  • Yank the most recently killed text back into the buffer at the cursor : C-y
  • Search backward in the history for a particular string : C-r
  • Search forward in the history for a particular string : C-s
  • Switch to VI editing mode: M-C-j

VI Mode

In command mode: About every vi command is supported, here's a few:

  • Move back one char : h
  • Move forward one char : l
  • Delete the character left of cursor : X
  • Delete the character on cursor : x
  • Undo : u
  • Move to the start of the line : 0
  • Move to the end of the line : $
  • Move forward a word, where a word is composed of letters and digits : w
  • Move backward a word : b
  • Previous line : k
  • Next line : n
  • Clear the screen, reprinting the current line at the top : C-l
  • Delete next word to the right of cursor : dw
  • Kill the text from the current cursor position to the end of the line : D and d$
  • Kill from the cursor to the end of the current word, or, if between words, to the end of the next word : db
  • Kill from the cursor to the previous whitespace : dB
  • Yank the most recently killed text back into the buffer at the cursor : p (after cursor), P (before cursor)
  • Add text into yank buffer : y + movement action
  • Enable change mode : c
  • Repeat previous action : .
  • +++ (read a vi manual)

In edit mode:

  • Search backward in the history for a particular string : C-r
  • Search forward in the history for a particular string : C-s
  • Delete the character left of cursor : backspace

Supported runtime properties:

  • jreadline.terminal : specify Terminal object
  • jreadline.editmode : specify either VI or EMACS edit mode
  • jreadline.readinputrc : specify if jreadline should read settings from inputrc
  • jreadline.inputrc : specify the inputrc file (must exist)
  • jreadline.historyfile : specify the history file (must exist)
  • jreadline.historypersistent : specify if jreadlin should persist history file on exit
  • jreadline.historydisabled : specify if history should be disabled
  • jreadline.historysize : speficy the maximum size of the history file
  • jreadline.logging : specify if logging should be enabled
  • jreadline.logfile : specify the log file
  • jreadline.disablecompletion : specify if completion should be disabled