NewYour coding agent can read the release notes before it upgrades.Set up the MCP server →
npm · #3258 most downloaded on npm
easy to use progress-bar for command-line/terminal applications
Last release 4 years ago
no release in 18 months
Release timing varies
gaps range from 8 days to 9 months
Nearly every release is documented
notes for 39 of 39 stable releases
Nothing withdrawn
no release was ever pulled
11 years old
39 releases · first in 2015
Added: option to override bar characters via instance options on multibar.create() - thanks to Araxeus on GitHub
multibar.create() - thanks to Araxeus on GitHublinewrap=true state of the terminal - thanks to emmercm on GitHubBugfix: disabled gracefulExit by default, because the default SIGINT/SIGTERM handlers of nodejs are removed
gracefulExit by default, because the default SIGINT/SIGTERM handlers of nodejs are removedOne column per quarter.
Bugfix: MaxListenersExceededWarning was triggered by gracefulExit handlers added in v3.11.0 - thanks to TychoTheTaco on GitHub
MaxListenersExceededWarning was triggered by gracefulExit handlers added in v3.11.0 - thanks to TychoTheTaco on GitHubAdded: log() convenience method the multibar to enable custom logging output on top of the progress bars during operation
log() convenience method the multibar to enable custom logging output on top of the progress bars during operationgracefulExit option (enabled by default) to stop the bars in case of SIGINT or SIGTERM - this restores most cursor settings before exitingprogressCalculationRelative option (disabled by default) to use the startValue as offset for the progress calculation and calculate the absolute progress from the difference given by total-startValue #121multibar.createmultibar.create() returns an undefined value in case noTTYOutput is not enabled #117Changed: foreground color of preset.shades-grey is set directly by ANSI codes
preset.shades-grey is set directly by ANSI codesansi-colors librarycolors dependency due to some issues with the maintainer... see Zalgo bombBugfix: duration calculation doesn't work for bar restart scenarios - thanks to autlaw on GitHub
Added: exported standard formatter and format helper
1e7 (115days) #92Bugfix: bar duration not stopped until all bars have finished - thanks to omjadas on GitHub
Bugfix: percentage calculation used Math.round which caused incorrect values for edge cases - thanks to OxCom on GitHub
Math.round which caused incorrect values for edge cases - thanks to OxCom on GitHubChanged: allow to pass payload as first argument to increment() with implicit delta of 1 - thanks to ecdeveloper on GitHub
increment() with implicit delta of 1 - thanks to ecdeveloper on GitHubupdate() without updating bar valueformatTime option ignored due to type - thanks to omjadas on GitHubAdded: asynchronous eta update for long running processes (optional) - feature requested on GitHub
Bugfix: bar initialization overrides options within all instances - thanks to BigBrainAFK on GitHub
Added: support for custom time-format function
barGlue option to insert ascii escape sequences (e.g. for colorization) between the bar complete/incomplete elements - feature requested on GitHubeta value can be negative for multibars in case the bar is alredy completedAdded: support for events via EventEmitter - feature requested on GitHub
Added: testsuites based on mocha - thanks to on GitHub
stream options was wrong - thanks to ehmicky on GitHubREADME.md - thanks to justsml on GitHubBugifx: synchronous update may cause unexpected behaviour on multibars - limited to single bars
push() method to update()update()Added: option to pass custom formatters as callback via options.format
options.formatAdded: emptyOnZero option to display total:0 bars as empty, not full - thanks to nickcmaynard on GitHub
emptyOnZero option to display total:0 bars as empty, not full - thanks to nickcmaynard on GitHubAdded: notty support (interval/schedule based output) - feature requested on GitHub
stopOnComplete support within MultiBar - thanks to Nox-404 on GitHubMultiBar is controlled by fps option instead of static 500ms valueAdded: multi-progressbar support - feature requested on GitHub
synchronousUpdate to control the synchronized redraw during update() call (default=true)stdout instead of stderrBugifx: preset object got altered by options - thanks to rvalitov on GitHub #27
Added: align option to change the position of the progress bar (left, center, right) - thanks to sidneys on GitHub #22
align option to change the position of the progress bar (left, center, right) - thanks to sidneys on GitHub #22Infinity is displayed as INF, NaN as NULL - feature requested by AxelTerizaki on GitHub #21100000s (INF is displayed in this case)example-notty.php was brokenUpgrade is possible without any code modifications! requires node.js 4
Upgrade is possible without any code modifications! requires node.js 4
linewrap to disable terminal line wrapping (default)cli-progress.jsTerminal classAdded: method setTotal() to manipulate the total value within running progress-bar - feature requested by ReggaePanda on GitHub #19
setTotal() to manipulate the total value within running progress-bar - feature requested by ReggaePanda on GitHub #19examples/ directoryAdded: payload argument to increment() - feature requested by dsego on GitHub #18
increment() - feature requested by dsego on GitHub #18Bugfix: roundTo parameter was not set for elapsedTime calculation which caused raw float values within formatted time strings - thanks to rekinyz on G
roundTo parameter was not set for elapsedTime calculation which caused raw float values within formatted time strings - thanks to rekinyz on GitHub #16Added: Additional payload data which can be used as custom-tokens within the bar - thanks to tobiasps on GitHub #15
Bugifx: Progressbar cannot be initialized to 0% - thanks to erikkallen on GitHub #13
Added: 0 values for total/progress initialization are allowed - feature requested by jfmmm on GitHub #11
Added: Preset/Theme support. Different bar-styles can be loaded from internal library (in addition to full customization)
legacyshades-classicshades-greyrectAdded: Preset/Theme support. Different bar-styles can be loaded from internal library (in addition to full customization)
legacyshades-classicshades-greyrectAdded: example-notty to test the behaviour of progress bar in non-interactive environments (input streams closed)
example-notty to test the behaviour of progress bar in non-interactive environments (input streams closed)update() throws an error in non-tty environments - reported by Ognian on GitHub #9Added: stopOnComplete option to automatically call stop() when the value reaches the total - thanks to lennym on GitHub #7
stopOnComplete option to automatically call stop() when the value reaches the total - thanks to lennym on GitHub #7Added: increment() method to increase the current progress relatively - thanks to lennym on GitHub #6
increment() method to increase the current progress relatively - thanks to lennym on GitHub #6Bugfix: stdout.cursorTo/stdout.clearLine is not a function; replaced by readline - thanks to remcoder on GitHub
Bugfix: stdout.cursorTo/stdout.clearLine is not a function; replaced by readline - thanks to remcoder on GitHub
Bugfix: Hide cursor options was enabled by default
Added: Support for synchronous operations (interval has been replaced by timeout and throttle time) - feature requested GitHub
example-synchronous.jsoptions.hideCursor - default set to falseBugfix: the bar-size is limited to options.barsize - in some (numerical) situations it can be too long (n+1)
options.barsize - in some (numerical) situations it can be too long (n+1)Full customizable output format (various placeholders are available)
Successful tested on Windows10, Debian 8.2 and Ubuntu 14 LTS
Your coding agent can read these notes before it upgrades. Set up the MCP server →