{"id":15672358,"url":"https://github.com/chimurai/requirements","last_synced_at":"2026-05-23T15:01:46.587Z","repository":{"id":19509010,"uuid":"87204583","full_name":"chimurai/requirements","owner":"chimurai","description":"🚦 Check and align required software versions in your project","archived":false,"fork":false,"pushed_at":"2026-05-15T19:55:55.000Z","size":2643,"stargazers_count":15,"open_issues_count":1,"forks_count":49,"subscribers_count":2,"default_branch":"master","last_synced_at":"2026-05-15T22:45:11.376Z","etag":null,"topics":["bin","cli","linux","macos","project","requirement","software","utility","windows"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/chimurai.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2017-04-04T15:37:13.000Z","updated_at":"2026-05-15T19:49:21.000Z","dependencies_parsed_at":"2023-02-13T00:30:33.143Z","dependency_job_id":"4e2cc3b9-ffde-4fe1-8e1e-8629a5d5c1c9","html_url":"https://github.com/chimurai/requirements","commit_stats":{"total_commits":327,"total_committers":5,"mean_commits":65.4,"dds":0.3486238532110092,"last_synced_commit":"7b0ac6b99f53cbd872da90fe30fc28f66f4a0223"},"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"purl":"pkg:github/chimurai/requirements","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chimurai%2Frequirements","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chimurai%2Frequirements/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chimurai%2Frequirements/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chimurai%2Frequirements/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/chimurai","download_url":"https://codeload.github.com/chimurai/requirements/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chimurai%2Frequirements/sbom","scorecard":{"id":114342,"data":{"date":"2025-08-11","repo":{"name":"github.com/chimurai/requirements","commit":"13949b21bb9445316c7675c47de1855cbbdfb00c"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":5.2,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/3 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":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","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":"Maintained","score":10,"reason":"19 commit(s) and 1 issue activity found in the last 90 days -- score normalized to 10","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"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":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Info: jobLevel 'contents' permission set to 'read': .github/workflows/publish.yml:11","Warn: no topLevel permission defined: .github/workflows/ci.yml:1","Warn: no topLevel permission defined: .github/workflows/publish.yml:1","Info: no jobLevel write permissions found"],"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":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/chimurai/requirements/ci.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/chimurai/requirements/ci.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/chimurai/requirements/ci.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:46: update your workflow using https://app.stepsecurity.io/secureworkflow/chimurai/requirements/ci.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:48: update your workflow using https://app.stepsecurity.io/secureworkflow/chimurai/requirements/ci.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:52: update your workflow using https://app.stepsecurity.io/secureworkflow/chimurai/requirements/ci.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:79: update your workflow using https://app.stepsecurity.io/secureworkflow/chimurai/requirements/ci.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:81: update your workflow using https://app.stepsecurity.io/secureworkflow/chimurai/requirements/ci.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:85: update your workflow using https://app.stepsecurity.io/secureworkflow/chimurai/requirements/ci.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:104: update your workflow using https://app.stepsecurity.io/secureworkflow/chimurai/requirements/ci.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/chimurai/requirements/publish.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/chimurai/requirements/publish.yml/master?enable=pin","Info:   0 out of  11 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   1 third-party GitHubAction dependencies pinned"],"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":"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":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"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":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"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"}},{"name":"Packaging","score":10,"reason":"packaging workflow detected","details":["Info: Project packages its releases by way of GitHub Actions.: .github/workflows/publish.yml:6"],"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":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 30 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"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"}}]},"last_synced_at":"2025-08-16T00:23:38.920Z","repository_id":19509010,"created_at":"2025-08-16T00:23:38.920Z","updated_at":"2025-08-16T00:23:38.920Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33400251,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-23T04:15:53.637Z","status":"ssl_error","status_checked_at":"2026-05-23T04:15:53.242Z","response_time":53,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["bin","cli","linux","macos","project","requirement","software","utility","windows"],"created_at":"2024-10-03T15:24:43.379Z","updated_at":"2026-05-23T15:01:45.104Z","avatar_url":"https://github.com/chimurai.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# requirements\n\n[![npm](https://img.shields.io/npm/v/requirements?style=flat-square)](https://www.npmjs.com/package/requirements)\n[![coveralls](https://img.shields.io/coveralls/chimurai/requirements.svg?style=flat-square)](https://coveralls.io/r/chimurai/requirements)\n[![snyk](https://snyk.io/test/npm/requirements/badge.svg?style=flat-square)](https://snyk.io/test/npm/requirements)\n[![code style: oxfmt](https://img.shields.io/badge/codestyle-oxfmt-turquoise?style=flat-square)](https://oxc.rs/docs/guide/usage/formatter.html)\n\nValidate your project's software requirements.\n\n![requirements-screenshot](https://raw.githubusercontent.com/chimurai/requirements/master/docs/requirements.gif)\n\n## install\n\n```bash\n$ npm install -D requirements\n```\n\n```bash\n$ yarn add --dev requirements\n```\n\n## setup\n\nScaffold a new `requirements.config.mjs` configuration file\n\n```bash\n$ npx requirements --init\n```\n\n## config\n\nConfigure the `requirements.config.mjs` file in your project root.\n\n```js\nexport default {\n  software: {\n    node: '*',\n    yarn: '~1.17.3',\n    nginx: {\n      semver: '\u003e= 1.16.x',\n      optional: true, // optional (won't fail)\n      installMessage: '\u003cinstall instruction\u003e', // custom message when binary is not found\n      updateMessage: '\u003cupdate instruction\u003e', // custom message when binary has wrong version\n    },\n    httpd: {\n      semver: '^1.x',\n      flag: '-v', // custom version flag\n    },\n  },\n  // custom functions to verify requirements which are not related to software versions\n  // see ./tests/custom-check-ssh.config.mjs for an example\n  custom: {\n    'Example title for custom requirements check', {\n      fn: () =\u003e { throw new Error('throw Error when requirement not met.') },\n      errorMessage: 'This error message is shown when the above function throws Error',\n    }\n  }\n};\n```\n\n## check requirements\n\nRun `requirements` command in the project root. By default it will try to find the `requirements.config.mjs` file.\n\n```bash\nnpx requirements\n```\n\nOr use a custom path:\n\n```bash\nnpx requirements --config \u003cfilepath\u003e\n```\n\n## CLI options\n\n```bash\nnpx requirements --help\n```\n\n```shell\nOptions:\n  --help, -h     Show help                                             [boolean]\n  --version, -v  Show version number                                   [boolean]\n  --init, -i     Create a requirements.config.mjs file\n  --config, -c   Path to the configuration file\n                                            [default: \"requirements.config.mjs\"]\n  --force, -f    Succeeds even if not all requirements are satisfied\n                                                      [boolean] [default: false]\n  --quiet, -q    Only output when errors are present                   [boolean]\n  --debug        Print raw data                                        [boolean]\n```\n\n## require('requirements')\n\n```javascript\nconst { checkSoftware, renderTable } = require('requirements');\n\n(async () =\u003e {\n  const result = await checkSoftware({ node: '*' });\n  console.log(renderTable(result));\n})();\n```\n\ncheckSoftware() returns an Array with results\n\n```javascript\n[\n  {\n    bin: 'node',\n    semver: '*',\n    installed: true,\n    version: '24.11.0',\n    satisfies: true,\n  },\n];\n```\n\n## testing\n\n```bash\n# test functionality\nyarn build\nnode bin/requirements.js --config tests/requirements.config.mjs\n\n# unit tests\nyarn test\n```\n\n## license\n\nThe MIT License (MIT)\n\nCopyright (c) 2017-2024 Steven Chim","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchimurai%2Frequirements","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchimurai%2Frequirements","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchimurai%2Frequirements/lists"}