{"id":21700389,"url":"https://github.com/articulate/progress","last_synced_at":"2026-04-16T07:32:57.546Z","repository":{"id":69598463,"uuid":"110878493","full_name":"articulate/progress","owner":"articulate","description":"Cheap, functional, terminal progress bar","archived":false,"fork":false,"pushed_at":"2017-11-15T20:33:31.000Z","size":28,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":60,"default_branch":"master","last_synced_at":"2025-04-08T22:02:15.846Z","etag":null,"topics":["functional-programming","javascript","progress-bar"],"latest_commit_sha":null,"homepage":"","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/articulate.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-11-15T19:43:19.000Z","updated_at":"2021-02-11T18:41:53.000Z","dependencies_parsed_at":"2023-03-23T10:26:32.052Z","dependency_job_id":null,"html_url":"https://github.com/articulate/progress","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/articulate/progress","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/articulate%2Fprogress","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/articulate%2Fprogress/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/articulate%2Fprogress/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/articulate%2Fprogress/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/articulate","download_url":"https://codeload.github.com/articulate/progress/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/articulate%2Fprogress/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31876440,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-15T15:24:51.572Z","status":"online","status_checked_at":"2026-04-16T02:00:06.042Z","response_time":69,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["functional-programming","javascript","progress-bar"],"created_at":"2024-11-25T20:14:11.845Z","updated_at":"2026-04-16T07:32:57.538Z","avatar_url":"https://github.com/articulate.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# @articulate/progress\n[![@articulate/progress](https://img.shields.io/npm/v/@articulate/progress.svg)](https://www.npmjs.com/package/@articulate/progress)\n[![Build Status](https://travis-ci.org/articulate/progress.svg?branch=master)](https://travis-ci.org/articulate/progress)\n[![Coverage Status](https://coveralls.io/repos/github/articulate/progress/badge.svg?branch=master)](https://coveralls.io/github/articulate/progress?branch=master)\n[![NSP Status](https://nodesecurity.io/orgs/articulate/projects/172aa9db-55a1-4f0d-b76e-2408bf81d4fa/badge)](https://nodesecurity.io/orgs/articulate/projects/172aa9db-55a1-4f0d-b76e-2408bf81d4fa)\n\n![@articulate/progress](https://user-images.githubusercontent.com/888052/32856962-53142736-ca14-11e7-8296-90160a1fa221.gif)\n\nCheap, functional, terminal progress bar.\n\nNext time you're tempted to `process.stderr.write('.')` to track the progress of a script... don't.  Use this instead.\n\n## API\n\n```haskell\nprogress : Object -\u003e Number -\u003e ()\n```\n\nTo setup your progress bar, execute the module with an optional options object:\n\n```js\nconst progress = require('@articulate/progress')({ /* options here */ })\n```\n\nThe following options are accepted:\n\n| Name | Type | Default | Description |\n| ---- | ---- | ------- | ----------- |\n| `label` | `String` | `'progress'` | custom label for your progress bar |\n| `stream` | `stream.Writable` | `process.stderr` | output stream for progress |\n| `width` | `Number` | `24` | max width of the bar |\n\nThe returned function accepts a progress ratio between `0` and `1`, and writes the progress bar to the output stream.  Each time it is called, it will overwrite the previous state of the progress to appear animated in the console.\n\n```js\nconst progress = require('@articulate/progress')()\n\nprogress(0.55)\n//\u003e progress: ⣠ [==============          ] 55%\n```\n\nSee [`demo.js`](https://github.com/articulate/progress/blob/master/demo.js) for a slightly more complex example.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farticulate%2Fprogress","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Farticulate%2Fprogress","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farticulate%2Fprogress/lists"}