{"id":18901103,"url":"https://github.com/regular/terminal-status-board","last_synced_at":"2025-08-30T05:11:38.270Z","repository":{"id":31973534,"uuid":"35543672","full_name":"regular/terminal-status-board","owner":"regular","description":"display the progress of multiple concurrent job sequences in your terminal","archived":false,"fork":false,"pushed_at":"2015-05-20T16:33:41.000Z","size":260,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-06-18T09:51:43.323Z","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":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/regular.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-05-13T10:50:28.000Z","updated_at":"2021-11-07T06:01:20.000Z","dependencies_parsed_at":"2022-08-26T10:02:18.722Z","dependency_job_id":null,"html_url":"https://github.com/regular/terminal-status-board","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/regular/terminal-status-board","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regular%2Fterminal-status-board","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regular%2Fterminal-status-board/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regular%2Fterminal-status-board/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regular%2Fterminal-status-board/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/regular","download_url":"https://codeload.github.com/regular/terminal-status-board/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regular%2Fterminal-status-board/sbom","scorecard":{"id":769096,"data":{"date":"2025-08-11","repo":{"name":"github.com/regular/terminal-status-board","commit":"97317c6e120c4996a18688fd95e520a48e2a625b"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.6,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/22 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"License","score":0,"reason":"license file not detected","details":["Warn: project does not have a license file"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}}]},"last_synced_at":"2025-08-23T01:45:06.899Z","repository_id":31973534,"created_at":"2025-08-23T01:45:06.900Z","updated_at":"2025-08-23T01:45:06.900Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":272805572,"owners_count":24995916,"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","status":"online","status_checked_at":"2025-08-30T02:00:09.474Z","response_time":77,"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":[],"created_at":"2024-11-08T08:55:11.111Z","updated_at":"2025-08-30T05:11:38.253Z","avatar_url":"https://github.com/regular.png","language":"JavaScript","readme":"terminal-status-board\r\n====\r\ndisplay the progress of multiple concurrent job sequences in your terminal, kind of like the departure boards at airport terminals.\r\n\r\nInstallation\r\n---\r\n\r\n    npm install terminal-status-board\r\n\r\nBasic Usage \r\n---\r\n``` javascript\r\nvar board = require('terminal-status-board');\r\n\r\nboard()\r\n    .add([asyncFunc1, asyncFunc2])\r\n    .add([asyncFunc3, asyncFunc4])\r\n    .on('end', function() {console.log('ALL DONE');})\r\n    .pipe(process.stdout);\r\n```\r\n`asyncFunc1` and `asyncFunc2` run in sequence, so do `asyncFunc3` and `asyncFunc4`. These two sequences however, run in parallel. (think of airplanes changing status from 'boarding' to 'borading complete' to 'departure').\r\n\r\nAdvanced Usage\r\n---\r\n\r\n``` javascript\r\nvar board = require('terminal-status-board');\r\nvar pipeline = require('progress-pipeline');\r\n\r\nfunction makeJob(name, duration, err) {\r\n    var f = function(cb) {\r\n        setTimeout(function() {cb(Math.random()\u003e0.8?err:null);}, duration);\r\n    };\r\n    f.title = name;\r\n    return f;\r\n}\r\n\r\nfunction makeJobs(jobCount, fail) {\r\n    var jobs = [];\r\n    for(var i=0; i\u003cjobCount; ++i) {\r\n        var duration = Math.floor(Math.random() * 4000);\r\n        var name = String.fromCharCode(65+i);\r\n        jobs.push(makeJob(name, duration, fail?new Error('this is bad!'):null));\r\n    }\r\n    return jobs;\r\n}\r\n\r\nboard()\r\n    .add(makeJobs(8), 'first')\r\n    .add(makeJobs(8), {\r\n        template: function(ctx) {\r\n            if (ctx._jobFinished \u0026\u0026 ctx._jobIndex === ctx._totalJobs-1) {\r\n                return '  2nd: done';\r\n            }\r\n            return '-\\\\|/'[ctx._jobIndex % 4] + ' 2nd';\r\n        }\r\n    })\r\n    .add(\r\n        pipeline(makeJobs(20, true)).on('error', function() {\r\n            process.stdout.write('\\u0007'); // terminal BELL\r\n        })\r\n    )\r\n    .add(makeJobs(10, true), {context: {name: 'fourth', color:'yellow'}})\r\n    .on('end', function() {console.log('ALL DONE');})\r\n    .pipe(process.stdout);\r\n```\r\n\r\nThis is the output of the above code:\r\n\r\n![demo output](http://regular.github.io/terminal-status-board/terminal-status-board.gif)\r\n\r\nAPI\r\n---\r\n\r\n### board([options])\r\n\r\nThe returned object is a `Stream` that emits ANSI escape sequences to update the screen.\r\nPipe it to `stdout` to make it visible in the terminal.\r\nThe stream instance originates from [substack/node-charm](http://github.com/substack/node-charm).\r\n\r\nOptions are\r\n  - `template`: a custom template function that renders a line of the board\r\n   \r\n    `function(ctx) -\u003e String`\r\n    \r\n    Where `ctx` has these properties:\r\n    \r\n    - `_index`: zero-based index of the line to render\r\n    - `_totalJobs`: number of jobs in the sequence\r\n    - `_jobIndex`: zero-based index of current job\r\n    - `_job`: the current job\r\n    - `_jobResult`: result of the current job (when job has finished)\r\n    - `_jobFinished`: true, when job has just finished, false when it started\r\n    - `_error`: error object returned by current job (when job has failed)\r\n    - whatever additional properties you passed as `context` to `add()` (see below)\r\n  \r\n  if `template` is not specified, a default template is used.\r\n  \r\n### add( jobs[] or pipeline, [options or string] )\r\n    \r\nAdds a line to the board, displaying the current state of a sequence of async jobs.\r\nJobs can either be defined as an array of async functions, or as an instance of [regular/progress-pipeline](http://github.com/regular/progress-pipeline).\r\n\r\nOptions are:\r\n\r\n- `template`: a custom template function for this sequence (see above)\r\n- `context`: additional properties that will be available to the template function.\r\n  the default template cares about these additional properties:\r\n  - name: the name of the sequence (think \"flight number\")\r\n  - color: Color of this line's name. One of `red`, `green`, `blue`, `yellow` ... (see [substack/node-charm](github.com/substack/node-charm) for details.\r\n  \r\nIf, as the second argument, a String is passed instead of an Object, it is treated as a shortcut for\r\n`{options: context: name: string}}`.\r\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fregular%2Fterminal-status-board","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fregular%2Fterminal-status-board","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fregular%2Fterminal-status-board/lists"}