{"id":20671094,"url":"https://github.com/allnulled/progene","last_synced_at":"2025-08-26T02:07:06.231Z","repository":{"id":57331005,"uuid":"185811445","full_name":"allnulled/progene","owner":"allnulled","description":"Customize and reuse parametrizable Node.js commands accessible from terminal across software projects.","archived":false,"fork":false,"pushed_at":"2019-05-14T14:09:02.000Z","size":93,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-08-04T00:00:07.244Z","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/allnulled.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":"2019-05-09T14:07:24.000Z","updated_at":"2019-05-14T14:09:03.000Z","dependencies_parsed_at":"2022-09-16T09:51:06.609Z","dependency_job_id":null,"html_url":"https://github.com/allnulled/progene","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/allnulled/progene","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/allnulled%2Fprogene","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/allnulled%2Fprogene/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/allnulled%2Fprogene/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/allnulled%2Fprogene/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/allnulled","download_url":"https://codeload.github.com/allnulled/progene/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/allnulled%2Fprogene/sbom","scorecard":{"id":185834,"data":{"date":"2025-08-11","repo":{"name":"github.com/allnulled/progene","commit":"b9fc36bb549f1f9946a2fc7b23c53e710954e85f"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.3,"checks":[{"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":"Code-Review","score":0,"reason":"Found 0/11 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":"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":"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":"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":"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":"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":"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":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"}},{"name":"Vulnerabilities","score":8,"reason":"2 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-phwq-j96m-2c2q","Warn: Project is vulnerable to: GHSA-ghr5-ch3p-vcr6"],"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-16T19:47:06.729Z","repository_id":57331005,"created_at":"2025-08-16T19:47:06.729Z","updated_at":"2025-08-16T19:47:06.729Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":272160241,"owners_count":24883779,"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-26T02:00:07.904Z","response_time":60,"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-16T20:25:01.146Z","updated_at":"2025-08-26T02:07:06.171Z","avatar_url":"https://github.com/allnulled.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Progene\n\n![](https://img.shields.io/badge/version-1.0.0-green.svg) ![](https://img.shields.io/badge/tests-passing-green.svg) ![](https://img.shields.io/badge/coverage-98%25-green.svg) \n\nCustomize and reuse parametrizable Node.js commands accessible from terminal across software projects.\n\n[![NPM](https://nodei.co/npm/progene.png?stars\u0026downloads)](https://www.npmjs.com/package/progene)\n\n## Index\n\n1. [Installation](#installation)\n2. [Usage](#installation)\n3. [Commands](#installation)\n4. [How it works](#how-it-works)\n5. [API](#api)\n6. [Issues](#issues)\n7. [License](#license)\n8. [Collaboration](#collaboration)\n\n## Installation\n\n`$ npm i --g progene`\n\n## Usage\n\nTo see the help of a command, run `progene` or any of its commands with the `--help` flag.\n\n### Explanation\n\n1. you write your own Node.js commands (separated by a namespace).\n\n2. you start `progene` in any project you are developing.\n\n3. you add your created `progene` command namespaces.\n\n4. you run any of the commands you have coded before, comfortably from your fresh project.\n\n## Commands\n\n`[...]`: optional parameters.\n\n`\u003c...\u003e`: required parameters.\n\n```\nprogene init [directory]\nprogene add \u003cnamespace-path\u003e [options]\nprogene run \u003cnamespace/command\u003e [options]\nprogene remove \u003cnamespace\u003e [options]\n```\n\n### Initialize progene\n\n`$ progene init .`\n\n### Write commands\n\nFile: `commands/namespace/progene.json`\n\nContents:\n\n```js\n{}\n```\n\n---\n\nFile: `commands/namespace/first.js`\n\nContents:\n\n```js\nmodule.exports = function(options) {\n  console.log(options.one + \" - \" + options.two);\n};\n```\n\n---\n\nFile: `commands/namespace/hello.js`\n\nContents:\n\n```js\nmodule.exports = function(options) {\n  console.log(\"Hello \" + (options.name || \"world\") + \"!\");\n};\n```\n\n### Add commands\n\n`$ progene add commands/namespace`\n\n### Run commands\n\n`$ progene run namespace/first --one 1 2 3 --two a b c`\n\nIt prints: `1 2 3 - a b c`\n\n`$ progene run namespace/hello --name developer`\n\nIt prints: `Hello developer!`\n\n## How it works\n\nProgene creates a `.progene` folder when you run `progene init`.\n\nUnder the `.progene` folder, you find the **namespaces** of your commands.\n\nUnder each **namespace** folder, you find its corresponding **commands**, as `*.js` files.\n\nUnder each **namespace** folder, you also find its corresponding `progene.json` metadata file.\n\nThe `progene.js` only has to be a valid JSON file, nothing is required inside.\n\nThis way, one can reuse all the commands that it writes in one project, for different projects.\n\n### Workflow\n\nThe idea is that you start having:\n\n  - `path/to/project`\n\nAnd, on the other hand, your commands:\n\n  - `path/to/commands/namespace/progene.json`: a valid JSON file.\n  - `path/to/commands/namespace/command-1.js`: a `module.exports = function(options) {...}` file.\n  - `path/to/commands/namespace/command-2.js`: a `module.exports = function(options) {...}` file.\n  - `path/to/commands/namespace/command-3.js`: a `module.exports = function(options) {...}` file.\n\nThen you initialize `progene`:\n\n  - `$ cd path/to/project`\n  - `$ progene init`\n\n...in order to have:\n\n  - `path/to/project/.progene`: a folder for all the currently available commands in a project.\n\nThen you add `progene` command namespaces:\n\n  - `progene add path/to/commands/namespace`\n\n...in order to have:\n\n  - `path/to/project/.progene/namespace`: a namespace of commands.\n  - `path/to/project/.progene/namespace/command-1.js`: a command.\n  - `path/to/project/.progene/namespace/command-2.js`: a command.\n  - `path/to/project/.progene/namespace/command-3.js`: a command.\n\nThen you run `progene` commands:\n\n  - `$ progene run namespace/command-1 --one 1 --two 2 --three 3`\n  - `$ progene run namespace/command-2 --one 1 --two 2 --three 3`\n  - `$ progene run namespace/command-3 --one 1 --two 2 --three 3`\n\nThis way, you can reuse your commands across projects, polluting the least your projects' workspace.\n\n## API\n\nYou can also use the programmatic API.\n\n### Usage\n\nThe API module works almost the same way that the command-line interface, but passing objects to every method, instead.\n\n#### 1. Import module\n\n```js\nconst Progene = require(\"progene\");\n```\n\n#### 2. Use the commands as static methods\n\n##### To initialize a project:\n\n```js\nProgene.init();\n```\n\nOr, alternatively, specify the directory:\n\n```js\nProgene.init({\n  base: __dirname + \"/my/project\" // 'base' is by default: process.cwd()\n});\n```\n\n##### To add commands to the project:\n\n```js\nProgene.add({ \n  command: \"/path/of/commands/namespace\",\n  base: __dirname + \"/my/project\" // 'base' is by default: process.cwd()\n});\n```\n\n##### To run a command:\n\n```js\nProgene.run({ \n  command: \"namespace/command\",\n  base: __dirname + \"/my/project\", // 'base' is by default: process.cwd()\n  name: \"Nobody\",\n  surname: \"None\",\n  age: 88,\n  place: \"The World\"\n});\n```\n\nNote: what the function at `/my/project/.progene/namespace/command.js` returns is what this method will return.\n\n##### To remove a command:\n\n```js\nProgene.remove({ \n  command: \"namespace/command\",\n  base: __dirname + \"/my/project\", // 'base' is by default: process.cwd()\n});\n```\n\n----\n\nAll the methods are chainable because they return the `Progene` class again. \n\nAll the methods are chainable, except the `Progene.run({ ... })`, which returns what the specified command itself returns, letting you use your own command-line interface also as programmatic APIs.\n\n## Issues \n\nExpose any issue [here](https://github.com/allnulled/progene/issues/new).\n\nVisit open issues [here](https://github.com/allnulled/progene/issues).\n\n## License\n\nThis is a project under [WTFL](https://es.wikipedia.org/wiki/WTFPL), which means basically that you can do whatever you want with it.\n\n## Collaboration\n\nFeel free to create your own branches.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fallnulled%2Fprogene","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fallnulled%2Fprogene","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fallnulled%2Fprogene/lists"}