Galactica

Build dashboards (or any other application) using ascii/ansi art and javascript.

Friendly to terminals, ssh and developers. Features custom drawille rendering and powerful layout widgets.

Maintained by Brian Shannon Bluesky • GitHub

Demo (full size):

(source code)

Running the demo

git clone https://github.com/codemeasandwich/CliUI.git
cd CliUI
npm install
node ./examples/dashboard.js

Works on Linux, OS X and Windows. For Windows follow the pre requisites.

Installation

npm install galactica

Quick Start

CommonJS

const galactica = require('galactica')
const screen = galactica.screen()
const grid = new galactica.grid({rows: 1, cols: 2, screen: screen})

const line = grid.set(0, 0, 1, 1, galactica.line,
  { style: { line: "yellow", text: "green", baseline: "black" }
  , xLabelPadding: 3
  , xPadding: 5
  , label: 'Stocks'})

const map = grid.set(0, 1, 1, 1, galactica.map, {label: 'Servers Location'})

line.setData([{ x: ['t1', 't2', 't3', 't4'], y: [5, 1, 7, 5] }])

screen.key(['escape', 'q', 'C-c'], function(ch, key) {
  return process.exit(0)
})

screen.render()

ES Modules

import { screen, grid, line, map } from 'galactica'

const scr = screen()
const grd = new grid({rows: 1, cols: 2, screen: scr})

const lineChart = grd.set(0, 0, 1, 1, line,
  { style: { line: "yellow", text: "green", baseline: "black" }
  , xLabelPadding: 3
  , xPadding: 5
  , label: 'Stocks'})

const worldMap = grd.set(0, 1, 1, 1, map, {label: 'Servers Location'})

lineChart.setData([{ x: ['t1', 't2', 't3', 't4'], y: [5, 1, 7, 5] }])

scr.key(['escape', 'q', 'C-c'], () => process.exit(0))

scr.render()

Documentation

See COOKBOOK.md for detailed widget documentation including:

Widgets: Line Chart, Scatter Plot, Bar Chart, Stacked Bar, Map, Gauge, Donut, LCD Display, Rolling Log, Picture, Sparkline, Table, Tree, Markdown

Layouts: Grid, Carousel

Troubleshooting

If you see question marks or missing characters try running with these env vars:

$> LANG=en_US.utf8 TERM=xterm-256color node your-code.js

License

This library is under the MIT License

More Information

Maintained by Brian Shannon Bluesky • GitHub