Home - uhop/console-toolkit GitHub Wiki

console-toolkit is a toolkit that provides a set of utilities to produce fancy console output. Create a compelling user experience with TUI, write CLI applications with ease.

To learn more start with the Concepts document.

The modules of the toolkit are:

• Text containers:
  • strings — a set of utilities to work with strings.
    • It is the simplest text container of the toolkit: an array of strings.
  • box — the Box text container.
  • panel — the Panel text container.
• style — a set of utilities to work with colors and text styles.
  • This is one of the central modules of the toolkit.
• Draw blocks:
  • draw-block — a set of utilities to draw blocks.
  • draw-block-frac — a set of utilities to draw fractional blocks.
    • Yes, it is possible!
• symbols — the curated set of Unicode symbols to spice up your console output.

The packages of the toolkit are:

• ANSI — a set of utilities to produce ANSI escape sequences, specifically CSI and SGR escape sequences.
  • This is one of the most important packages of the toolkit used for colors and text styles.
• alphanumeric — the curated set of Unicode symbols to produce decorated output, e.g., numbers.
• Drawing helpers:
  • plot — a set of utilities to draw bitmaps.
  • turtle — an implementation of the Turtle graphics to draw vector-based (line-based) graphics.
• themes — a collection of line- and block-based themes for console output.
• spinner — spinners and utilities to produce an updatable texts.
• Complex visuals:
  • charts — bar/column charts and their themes.
  • table — fancy tables.
• output — helpers to output text containers and create updatable displays.