Menu
Search

consoleur 0.3.0

Basic package for interaction with character-oriented (POSIX) terminal emulators


To use this package, run the following command in your project's root directory:

Manual usage
Put the following dependency into your project's dependences section:


This package provides sub packages which can be used individually:

consoleur:cli - Simple command-line widgets

consoleur:commands - Invocation of commands from terminfo database

consoleur:core - Library core

consoleur:cursor - Cursor manipulation

consoleur:extended - Extended terminal manipulation

consoleur:screen - Screen manipulation

consoleur:style - Output styling

consoleur:terminfo - Terminfo database reader

consoleur:input - Reading events from STDIN

Info

Consoleur

Please use with caution. Consoleur in the active development, some interfaces and behavior may change in future releases.

A package for interaction with character-oriented terminal emulators.

Features

  • Output coloring and formatting.
  • Cursor positioning.
  • UTF-8 input with codepoint and CSI/SS3 sequences detection.
  • Special keys recognition.
  • Support for Konsole super key.
  • CLI UI elements: password input and progress bar.

Some restrictions

  • It is assumed that the terminal operates in the UTF-8 encoding.
  • Special keys detector assumes that a PC-compatible keyboard is used. I.e. keyboard has F1 — F12 function keys and Shift, Control and Alt modifier keys.

To-Do

  • Unit tests.
  • Better documentation.
  • Support for mouse input.
  • Support for Windows cmd.exe.
Authors:
  • Maxim Freck
Sub packages:
consoleur:cli, consoleur:commands, consoleur:core, consoleur:cursor, consoleur:extended, consoleur:screen, consoleur:style, consoleur:terminfo, consoleur:input
Dependencies:
consoleur:commands, consoleur:cli, consoleur:extended, consoleur:style, consoleur:screen, consoleur:cursor, consoleur:core, consoleur:input, consoleur:terminfo
Versions:
0.3.0 2017-Nov-14
0.2.0 2017-Nov-13
0.1.1 2017-Nov-11
0.1.0 2017-Sep-08
~master 2018-Oct-17
Show all 6 versions
Download Stats:

  • 0 downloads today

  • 0 downloads this week

  • 0 downloads this month

  • 32 downloads total

Score:
0.7
Short URL:
consoleur.dub.pm