{"id":19228404,"url":"https://github.com/gillesdemey/cli-progress-bar","last_synced_at":"2025-04-21T01:32:04.041Z","repository":{"id":57200086,"uuid":"44285041","full_name":"gillesdemey/cli-progress-bar","owner":"gillesdemey","description":":clock9: A simple CLI progress bar, inspired by Gauge","archived":false,"fork":false,"pushed_at":"2016-09-06T08:46:34.000Z","size":8,"stargazers_count":5,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-01T07:54:26.070Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gillesdemey.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":"2015-10-15T00:56:41.000Z","updated_at":"2023-02-02T20:36:57.000Z","dependencies_parsed_at":"2022-09-16T15:02:41.585Z","dependency_job_id":null,"html_url":"https://github.com/gillesdemey/cli-progress-bar","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gillesdemey%2Fcli-progress-bar","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gillesdemey%2Fcli-progress-bar/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gillesdemey%2Fcli-progress-bar/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gillesdemey%2Fcli-progress-bar/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gillesdemey","download_url":"https://codeload.github.com/gillesdemey/cli-progress-bar/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249982572,"owners_count":21355721,"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":[],"created_at":"2024-11-09T15:28:19.690Z","updated_at":"2025-04-21T01:32:03.719Z","avatar_url":"https://github.com/gillesdemey.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Usage\n\nA simple CLI progress bar, inspired by Gauge.\n\n```javascript\nvar ProgressBar = require('cli-progress-bar')\n\nvar bar = new ProgressBar()\n\nbar.show(\"Foo\", 0.75)\n\nbar.pulse(\"bar\")\n\nbar.hide()\n```\n\n![screenshot 2015-10-15 02 58 33](https://cloud.githubusercontent.com/assets/868844/10502089/a7a483c0-72e8-11e5-90c8-1c2786639c49.png)\n\n# API\n\n### `var bar = new ProgressBar([options])`\n\n* **options** – *(optional)* An option object.\n\nThe **options** object can have the following properties, all of which are\noptional:\n\n* theme: defaults to `ProgressBar.themes.unicode` if the terminal supports\n  unicode according to [cli-character-set], otherwise it defaults to `ProgressBar.themes.ascii` or `ProgressBar.themes.cp437` for Windows.\n* width: sets a desired width (in columns) of the entire progress indicator, not just the bar. The progress bar itself will take up about half of the column width. Additional text may overflow the desired with. By default it uses the number of available columns of the TTY.\n\n### `bar.show([name, [completed]])`\n\n* **name** – *(optional)* The name of the current thing contributing to progress. Defaults to the last value used, or \"\".\n* **completed** – *(optional)* The portion completed as a value between 0 and 1. Defaults to the last value used, or 0.\n\n### `bar.hide()`\n\nRemoves the progress bar from the terminal.\n\n### `bar.pulse([name])`\n\n* **name** – *(optional)* The specific thing that triggered this pulse\n\nSpins the spinner in the progress bar to show output. If **name** is included then\nit will be combined with the last name passed to `bar.show()` using the\nsubsection property of the theme (typically a right facing arrow).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgillesdemey%2Fcli-progress-bar","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgillesdemey%2Fcli-progress-bar","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgillesdemey%2Fcli-progress-bar/lists"}