@dolsem/progress
v1.0.0
Published
easy to use progress-bar for command-line/terminal applications
Downloads
5
Maintainers
Readme
CLI-Progress
Easy to use Progress-Bar for Command-Line/Terminal Applications
Install
$ yarn add cli-progress
$ npm install cli-progress --save
Features
- Simple, Robust and Easy to use
- Full customizable output format (constious placeholders are available)
- Single progressbar mode
- Multi progessbar mode
- Custom Bar Characters
- FPS limiter
- ETA calculation based on elapsed time
- Custom Tokens to display additional data (payload) within the bar
- TTY and NOTTY mode
- No callbacks required - designed as pure, external controlled UI widget
- Works in Asynchronous and Synchronous tasks
- Preset/Theme support
Usage
Multiple examples are available e.g. example.js - just try it $ node example.js
const _cliProgress = require('cli-progress');
// create a new progress bar instance and use shades_classic theme
const bar1 = new _cliProgress.SingleBar({}, _cliProgress.Presets.shades_classic);
// start the progress bar with a total value of 200 and start value of 0
bar1.start(200, 0);
// update the current value in your application..
bar1.update(100);
// stop the progress bar
bar1.stop();
Single Bar Mode
Example
const _cliProgress = require('cli-progress');
// create new progress bar
const b1 = new _cliProgress.SingleBar({
format: 'CLI Progress |' + _colors.cyan('{bar}') + '| {percentage}% || {value}/{total} Chunks || Speed: {speed}',
barCompleteChar: '\u2588',
barIncompleteChar: '\u2591',
hideCursor: true
});
// initialize the bar - defining payload token "speed" with the default value "N/A"
b1.start(200, 0, {
speed: "N/A"
});
// update values
b1.increment();
b1.update(20);
// stop the bar
b1.stop();
Constructor
Initialize a new Progress bar. An instance can be used multiple times! it's not required to re-create it!
const _cliProgress = require('cli-progress');
const <instance> = new _cliProgress.SingleBar(options:object [, preset:object]);
Options
::start()
Starts the progress bar and set the total and initial value
<instance>.start(totalValue:int, startValue:int [, payload:object = {}]);
::update()
Sets the current progress value and optionally the payload with values of custom tokens as a second parameter
<instance>.update(currentValue:int [, payload:object = {}]);
::increment()
Increases the current progress value by a specified amount (default +1). Update payload optionally
<instance>.increment([delta:int [, payload:object = {}]]);
::setTotal()
Sets the total progress value while progressbar is active. Especially useful handling dynamic tasks.
<instance>.setTotal(totalValue:int);
::stop()
Stops the progress bar and go to next line
<instance>.stop();
Multi Bar Mode
Example
const _cliProgress = require('./cli-progress');
// create new container
const multibar = new _cliProgress.MultiBar({
clearOnComplete: false,
hideCursor: true
}, _cliProgress.Presets.shades_grey);
// add bars
const b1 = multibar.create(200, 0);
const b2 = multibar.create(1000, 0);
// control bars
b1.increment();
b2.update(20, {filename: "helloworld.txt"});
// stop all bars
multibar.stop();
Constructor
Initialize a new multiprogress container. Bars need to be added. The options/presets are used for each single bar!
const _cliProgress = require('cli-progress');
const <instance> = new _cliProgress.MultiBar(options:object [, preset:object]);
::create()
Adds a new progress bar to the container and starts the bar. Returns regular SingleBar
object which can be individually controlled.
const <barInstance> = <instance>.start(totalValue:int, startValue:int [, payload:object = {}]);
::remove()
Removes an existing bar from the multi progress container.
<instance>.remove(<barInstance>:object);
::stop()
Stops the all progress bars
<instance>.stop();
Options
The following options can be changed
format
(type:string) - progress bar output format @see format sectionfps
(type:float) - the maximum update rate (default: 10)stream
(type:stream) - output stream to use (default:process.stdout
)stopOnComplete
(type:boolean) - automatically callstop()
when the value reaches the total (default: false)clearOnComplete
(type:boolean) - clear the progress bar on complete /stop()
call (default: false)barsize
(type:int) - the length of the progress bar in chars (default: 40)align
(type:char) - position of the progress bar - 'left' (default), 'right' or 'center'barCompleteChar
(type:char) - character to use as "complete" indicator in the bar (default: "=")barIncompleteChar
(type:char) - character to use as "incomplete" indicator in the bar (default: "-")hideCursor
(type:boolean) - hide the cursor during progress operation; restored on complete (default: false) - passnull
to keep terminal settingslinewrap
(type:boolean) - disable line wrapping (default: false) - passnull
to keep terminal settings; passtrue
to add linebreaks automatically (not recommended)etaBuffer
(type:int) - number of updates with which to calculate the eta; higher numbers give a more stable eta (default: 10)synchronousUpdate
(type:boolean) - trigger redraw duringupdate()
in case threshold time x2 is exceeded (default: true)noTTYOutput
(type:boolean) - enable scheduled output to notty streams - e.g. redirect to files (default: true)notTTYSchedule
(type:int) - set the output schedule/interval for notty output inms
(default: 2000ms)
Bar Formatting
The progressbar can be customized by using the following build-in placeholders. They can be combined in any order.
{bar}
- the progress bar, customizable by the options barsize, barCompleteString and barIncompleteString{percentage}
- the current progress in percent (0-100){total}
- the end value{value}
- the current value set by lastupdate()
call{eta}
- expected time of accomplishment in seconds{duration}
- elapsed time in seconds{eta_formatted}
- expected time of accomplishment formatted into appropriate units{duration_formatted}
- elapsed time formatted into appropriate units
Example
progress [{bar}] {percentage}% | ETA: {eta}s | {value}/{total}
is rendered as
progress [========================================] 100% | ETA: 0s | 200/200
Examples
Example 1 - Set Options
// change the progress characters
// set fps limit to 5
// change the output stream and barsize
const bar = new _progress.Bar({
barCompleteChar: '#',
barIncompleteChar: '.',
fps: 5,
stream: process.stdout,
barsize: 65,
position: 'center'
});
Example 2 - Change Styles defined by Preset
// uee shades preset
// change the barsize
const bar = new _progress.Bar({
barsize: 65,
position: 'right'
}, _progress.Presets.shades_grey);
Example 3 - Custom Payload
// create new progress bar with custom token "speed"
const bar = new _progress.Bar({
format: 'progress [{bar}] {percentage}% | ETA: {eta}s | {value}/{total} | Speed: {speed} kbit'
});
// initialize the bar - set payload token "speed" with the default value "N/A"
bar.start(200, 0, {
speed: "N/A"
});
// some code/update loop
// ...
// update bar value. set custom token "speed" to 125
bar.update(5, {
speed: '125'
});
// process finished
bar.stop();
Example 4 - Custom Presets
File mypreset.js
const _colors = require('colors');
module.exports = {
format: _colors.red(' {bar}') + ' {percentage}% | ETA: {eta}s | {value}/{total} | Speed: {speed} kbit',
barCompleteChar: '\u2588',
barIncompleteChar: '\u2591'
};
Application
const _mypreset = require('./mypreset.js');
const bar = new _progress.Bar({
barsize: 65
}, _mypreset);
Presets/Themes
Need a more modern appearance ? cli-progress supports predefined themes via presets. You are welcome to add your custom one :)
But keep in mind that a lot of the "special-chars" rely on Unicode - it might not work as expected on legacy systems.
Default Presets
The following presets are included by default
- legacy - Styles as of cli-progress v1.3.0
- shades-classic - Unicode background shades are used for the bar
- shades-grey - Unicode background shades with grey bar
- rect - Unicode Rectangles
Any Questions ? Report a Bug ? Enhancements ?
Please open a new issue on GitHub
License
CLI-Progress is OpenSource and licensed under the Terms of The MIT License (X11). You're welcome to contribute!