Command Handler

The command handler is the base for creating your own commands.

Preparation

terminal.commandHandler(...);
LineReader lineReader = terminal.lineReader();
lineReader.tabCompleter(new CommandTabCompleter(terminal));
lineReader.inputHistory(InputHistory.create(false));
terminal.lineReading(true);

Define command handler

private static class ExampleCommandHandler implements
    CommandHandlerr<CommandArgument> {

  @Override
  public @NotNull CommandParserr<CommandArgument> parser() {
    return new DefaultCommandParser();
  }

  @Override
  public void command(CommandArgument[] args, @NotNull String line) {
    ...
  }

  //optional method
  @Override
  public @NotNull TermString view(@NotNull TermString view, 
    CommandArgument[] args) {
    //return new view of line
    return view;
  }

  //optional method
  @Override
  public @NotNull List<String> getTabCompletions(
    CommandArgument[] args, int cursor) {
    List<String> tabCompletions = new ArrayList<>();
    tabCompletions.add(...);
    return tabCompletions;
  }
}

Last modified: 01 Juni 2025