{"id":20622601,"url":"https://github.com/myterminal/faded-progressbar","last_synced_at":"2026-05-19T04:36:59.044Z","repository":{"id":57232408,"uuid":"82022568","full_name":"myTerminal/faded-progressbar","owner":"myTerminal","description":"A simple, light-weight and customizable progress bar for command-line applications","archived":false,"fork":false,"pushed_at":"2022-08-19T05:14:49.000Z","size":516,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-06-10T08:05:17.569Z","etag":null,"topics":["cli","nodejs","progressbar"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/myTerminal.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-02-15T05:09:06.000Z","updated_at":"2022-08-03T22:58:16.000Z","dependencies_parsed_at":"2022-08-31T20:51:03.032Z","dependency_job_id":null,"html_url":"https://github.com/myTerminal/faded-progressbar","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/myTerminal/faded-progressbar","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/myTerminal%2Ffaded-progressbar","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/myTerminal%2Ffaded-progressbar/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/myTerminal%2Ffaded-progressbar/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/myTerminal%2Ffaded-progressbar/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/myTerminal","download_url":"https://codeload.github.com/myTerminal/faded-progressbar/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/myTerminal%2Ffaded-progressbar/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264476767,"owners_count":23614569,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","nodejs","progressbar"],"created_at":"2024-11-16T12:23:54.559Z","updated_at":"2026-05-19T04:36:59.004Z","avatar_url":"https://github.com/myTerminal.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# faded-progressbar\r\n\r\n[![npm version](https://badge.fury.io/js/faded-progressbar.svg)](https://badge.fury.io/js/faded-progressbar)\r\n[![npm downloads](https://img.shields.io/npm/dt/faded-progressbar.svg)](https://www.npmjs.com/package/faded-progressbar)\r\n[![License](https://img.shields.io/github/license/myTerminal/ample-alerts.svg)](https://opensource.org/licenses/MIT)  \r\n[![Build Status](https://travis-ci.org/myTerminal/faded-progressbar.svg?branch=master)](https://travis-ci.org/myTerminal/faded-progressbar)\r\n[![Code Climate](https://codeclimate.com/github/myTerminal/faded-progressbar.png)](https://codeclimate.com/github/myTerminal/faded-progressbar)\r\n[![js-myterminal-style](https://img.shields.io/badge/code%20style-myterminal-blue.svg)](https://www.npmjs.com/package/eslint-config/myterminal)\r\n[![Coverage Status](https://img.shields.io/coveralls/myTerminal/faded-progressbar.svg)](https://coveralls.io/r/myTerminal/faded-progressbar?branch=master)    \r\n[![NPM](https://nodei.co/npm/faded-progressbar.png?downloads=true\u0026downloadRank=true\u0026stars=true)](https://nodei.co/npm/faded-progressbar/)\r\n\r\nA simple, light-weight and customizable progress bar for command-line applications\r\n\r\n![Demo](images/demo.gif)\r\n\r\n## Features\r\n\r\n* Easy to use with only a few methods.\r\n\r\n## How to Use\r\n\r\nSimply do a `require` and create a process as\r\n\r\n    var fadedProgressbar = require('faded-progressbar');\r\n    var newProcess = fadedProgressbar.newProcess(\"Some long running process\", 20);\r\n\r\nThe first argument is the process title that is to be displayed on the console, the second is the total number of sub-tasks in the process.\r\n\r\nTo print the start of the process, simply invoke `start()`.\r\n\r\n    newProcess.start();\r\n\r\nWhen the process progresses (in small steps), invoke `updateProgress()` passing in the new progress number.\r\n\r\n    newProcess.updateProgress(15);\r\n\r\nWhen the process ends, invoke `end()` which prints *100%* against the process title and shows a completed progress bar.\r\n\r\n    newProcess.end();\r\n    \r\nYou are free to use the console to print any logs while a process is active, *faded-progressbar* takes care of maintaining a single progress bar at the end of the console automatically.\r\n\r\nBy default, the package replaces the default `console.log()` method with an internal one, which is almost the same but with a few extra functionalities. You can turn this feature off by invoking `unmaskLogs()`.\r\n\r\n    fadedProgressbar.unmaskLogs();\r\n\r\nOnce turned off, you would be able to use the default `console.log()` again. This should not be required in usual cases though.\r\n\r\nYou can also enable the feature with the exact opposite method: `maskLogs()`.\r\n    \r\n## To-do\r\n\r\n* Customizable progress bar character\r\n* Animations\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmyterminal%2Ffaded-progressbar","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmyterminal%2Ffaded-progressbar","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmyterminal%2Ffaded-progressbar/lists"}