Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lbovet/zibar
Pretty graphs for the terminal
https://github.com/lbovet/zibar
Last synced: 3 months ago
JSON representation
Pretty graphs for the terminal
- Host: GitHub
- URL: https://github.com/lbovet/zibar
- Owner: lbovet
- Created: 2016-01-08T00:28:39.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2016-01-25T14:41:47.000Z (over 8 years ago)
- Last Synced: 2024-02-22T23:03:06.853Z (4 months ago)
- Language: CoffeeScript
- Homepage:
- Size: 13.7 KB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Lists
- awesome-ascii - zibar
README
# Zibar
Pretty graphs for the terminal
Inspired from [babar](https://www.npmjs.com/package/babar) and [sparkline](https://www.npmjs.com/package/sparkline). This actually mixes features of both.
# Installation
```
npm install zibar -g
```
If you don't know what npm is, read [this](https://docs.npmjs.com/getting-started/installing-node).
# Usage
```
zibar [-c config-file] [ - ] [ value1 [value2..]]
```
Data can be read from stdin
Configuration allows fancy rendering
```javascript
{
"height": 5,
"min": 0,
"high": 40,
"marks": [ 0, "?", 0, 0, { "symbol": "▼", "color": "red,bold" } ],
"color": "green",
"colors": {
"5": "magenta,bold"
},
"vlines": [null, null, "cyan"],
"yAxis": {
"decimals": 0
},
"xAxis": {
"interval": 2,
"color": "yellow,bold"
}
}
```
Or minimal sparkline style
```javascript
{
"height": 1,
"min": 0,
"color": "yellow,bold",
"yAxis": {
"display": false
},
"xAxis": {
"display": false
}
}
```
# Configuration
```javascript
{
"height": 5, // graph height
"color": "green", // bar color
"background": "blue", // graph background color
"min": 0, // minimum value, clips values below
"max": 10, // maximum value, clips values above
"low": 3, // soft minimum, values below are also shown
"high": 6. // soft maximum, values above are also shown
"chars": " ⡀⡀⡄⡄⡆⡆⡇⡇⡇", // characters used for the bars, defaults to unicode block elements
"marks": [ 0, // markers chars above the graph
"?", // can be an array or integer-indexed object
null,
0,
{ "symbol": "▼", // use objects to add styling
"color": "red" }
],
"colors": { // custom colors for values
"5": "magenta,bold" // can be an array or integer-indexed object
},
"vlines":
[null, null, "cyan"], // vertical lines markers
"yAxis": {
"display": true, // show/hide the axis labels
"color": "yellow", // axis label color
"ticks": true, // show/hide axis ticks
"decimals": 0 // number of decimals in axis labels
},
"xAxis": {
"display": true, // show/hide the axis labels
"color": "yellow", // axis label color
"interval": 2, // distance between labels
"origin": 10, // axis scale starts with this value
"factor": 2, // axis scale multiplier
"offset": 3 // relative position of the label to its default
}
}
```
# Rendering glitches
The terminal and its font must support unicode. Ensure you have one, e.g. [Source Code Pro](https://github.com/adobe-fonts/source-code-pro).
If some blocks looks weird, try the following config options.
```javascript
"badBlock": true,
"fixFull": true
```
# Using as a library
```
npm install zibar --save
```
```javascript
var zibar = require('zibar');
var graph = zibar(data, config); // returns the graph as a string
```
Example
```javascript
var graph = zibar([30, 12, 9.8, 31, 14, 31.5, 4, 6, 22, 33, 4, 22],
{
"height": 1,
"min": 0,
"color": "yellow,bold",
"yAxis": {
"display": false
},
"xAxis": {
"display": false
}
});
process.stdout.write(graph);
```
# Formatting
When using as a library, you can pass a function for formatting x and y axis labels.
```javascript
format: function(x) { return require('roman-numerals').toRoman(x); }
```
# Scale Transform
For non-linear y scale, you can pass a function and its inverse to transform the scale.
```javascript
tranform: function(x) { return Math.log(x)/Math.log(10); }
inverse: function(x) { return Math.pow(10,x); }
```