console-toolkit

console-toolkit is a toolkit for building rich CLI/TUI applications. It provides:

• Styles based on ANSI escape sequences:
  • SGR: colors and text styles
  • CSI: cursor and screen control
• Bitmap graphics
• Vector graphics based on Turtle graphics
• Curated sets of Unicode symbols
• Tables with themes
• Bar and column charts with themes
• Various helpers and examples

Visual examples

Memory watcher

Waveform

Table + chart

Turtle graphics

Code example

import style, {c} from 'console-toolkit/style.js';
import drawChart from 'console-toolkit/charts/bars/plain.js';
import lineTheme from 'console-toolkit/themes/lines/unicode-rounded.js';
import makeTable from 'console-toolkit/table';

// styles

console.log(style.bold + 'Hello, ' + style.bright.cyan + 'world!' + style.reset.all);

console.log(style.bold.text('Hello, ') + style.bright.cyan.bold.text('world!'));

const redBg = style.bg.red;
console.log(redBg.bold.text('Hello, ') + redBg.bright.cyan.bold.text('world!'));

console.log(c`{{bold}}Hello, {{bright.cyan}}world!`);

// chart

const chart = drawChart(
  [
    [2, 1, 2],
    [5, 1, 4],
    [1, 1],
    [3, 1, 3]
  ],
  50
);
for (const line of chart) console.log(line);

// table

const tableData = [
  ['Name', 'Value'],
  ['Bill', 33],
  ['Jill', 42]
];

const table = makeTable(tableData, lineTheme);
for (const line of table.toStrings()) console.log(line);

Output:

Installation

npm install console-toolkit

Modules

Text containers

| Module | Import | Description | | ----------- | ------------------------- | -------------------------------------------------------------- | | strings | console-toolkit/strings | String array utilities: getLength, clip, toStrings | | Box | console-toolkit/box | Rectangular text container — all lines equal width. Immutable. | | Panel | console-toolkit/panel | 2D cell grid with per-cell SGR state. Mutable. |

Styling and drawing

| Module | Import | Description | | ------------------- | ------------------------------------ | --------------------------------------------------------- | | Style | console-toolkit/style | Fluent SGR styling API + s/c tagged template literals | | draw-block | console-toolkit/draw-block.js | Draw filled blocks and frames with block themes | | draw-block-frac | console-toolkit/draw-block-frac.js | Fractional-width/height blocks (1/8th Unicode steps) | | symbols | console-toolkit/symbols.js | Curated Unicode constants (blocks, shades, math, marks) |

Packages

| Package | Import | Description | | ---------------- | ---------------------------------- | ------------------------------------------------------------ | | ansi | console-toolkit/ansi | Low-level ANSI CSI/SGR escape sequence handling | | table | console-toolkit/table | Table renderer with line themes | | charts | console-toolkit/charts/... | Bar and column charts (plain, block, frac, stacked, grouped) | | themes | console-toolkit/themes/... | Line and block themes (unicode, ascii variants) | | plot | console-toolkit/plot | Bitmap plotting (quadrant and braille characters) | | turtle | console-toolkit/turtle | Turtle graphics for vector line drawing | | spinner | console-toolkit/spinner | Spinner animations and updatable output | | output | console-toolkit/output/... | Output helpers: Writer (streaming), Updater (in-place) | | alphanumeric | console-toolkit/alphanumeric/... | Decorative Unicode number and letter sets |

Documentation

See wiki for detailed usage docs.

For project internals see ARCHITECTURE.md. For development setup see CONTRIBUTING.md. For AI agent rules see AGENTS.md.

License

BSD 3-Clause License

Release history

• 1.2.15 TypeScript 6.0 compatibility, updated dev deps, CI, license year.
• 1.2.14 Updated dev deps.
• 1.2.13 Fixed spinner .d.ts export, added TS type tests, stricter type checking, updated dev deps.
• 1.2.12 Minor bug fixes, improved test coverage, documentation corrections.
• 1.2.11 Improved docs for brevity and clarity, added script descriptions, added AI workflows.
• 1.2.10 Added TypeScript typings, JSDoc, minor bug fixes, updated dev deps.
• 1.2.9 Updated dev deps.
• 1.2.8 Updated dev deps.
• 1.2.7 Updated dev deps.
• 1.2.6 Updated dev deps.
• 1.2.5 Updated dev deps.
• 1.2.4 Updated deps.
• 1.2.3 Updated deps + more tests.
• 1.2.2 Updated deps.
• 1.2.1 Added support for Bun.stringWidth().
• 1.2.0 Refactored strings.
• 1.1.1 Minor bugfixes in Table, some improvements, updated deps.
• 1.1.0 Minor improvements, enhanced Writer and Updater.
• 1.0.0 Initial release.