{"id":16641584,"url":"https://github.com/scrwdrv/cli-params","last_synced_at":"2026-04-24T12:34:11.259Z","repository":{"id":57200119,"uuid":"233189647","full_name":"scrwdrv/cli-params","owner":"scrwdrv","description":"cli-params is a simple module that helps your CLI tool parse command line arguments and build parameters format to test if cmd is valid","archived":false,"fork":false,"pushed_at":"2020-01-14T07:12:00.000Z","size":48,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-09-23T04:29:51.790Z","etag":null,"topics":["argument-parser","arguments","cli","cmd","nodejs","parameters","params","tool","typescript"],"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/scrwdrv.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":"2020-01-11T06:51:57.000Z","updated_at":"2024-08-11T12:00:51.000Z","dependencies_parsed_at":"2022-09-16T15:01:07.746Z","dependency_job_id":null,"html_url":"https://github.com/scrwdrv/cli-params","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/scrwdrv/cli-params","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scrwdrv%2Fcli-params","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scrwdrv%2Fcli-params/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scrwdrv%2Fcli-params/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scrwdrv%2Fcli-params/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/scrwdrv","download_url":"https://codeload.github.com/scrwdrv/cli-params/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scrwdrv%2Fcli-params/sbom","scorecard":{"id":806527,"data":{"date":"2025-08-11","repo":{"name":"github.com/scrwdrv/cli-params","commit":"07379e978afba5811e3fb0eae541d9f8888287be"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3,"checks":[{"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":"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/21 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":"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":"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":"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":"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":"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":"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":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":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-23T11:56:02.626Z","repository_id":57200119,"created_at":"2025-08-23T11:56:02.626Z","updated_at":"2025-08-23T11:56:02.626Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32224214,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-24T10:26:35.452Z","status":"ssl_error","status_checked_at":"2026-04-24T10:25:27.643Z","response_time":64,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: 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":["argument-parser","arguments","cli","cmd","nodejs","parameters","params","tool","typescript"],"created_at":"2024-10-12T07:47:08.685Z","updated_at":"2026-04-24T12:34:11.242Z","avatar_url":"https://github.com/scrwdrv.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# cli-params\n cli-params is a simple module that helps your CLI tool parse command line arguments and build parameters format to test if cmd is valid\n\n\n## Installation\n\n```sh\nnpm i cli-params\n```\n\n## Usage\ncli-params works on both regular package and globally installed one.\n\n### Simple Method\nDead simple, use it on the fly.\n```sh\n# node\nnode index.js --p1 --p2 hello\n# global\nyour-cli-tool --p1 --p2 hello\n```\n```js\nimport CLIParams from 'cli-params';\n\nnew CLIParams().exec((err, params) =\u003e {\n    if (err) return console.log(err);\n    console.log(params);\n});\n```\n```json\n{ \"p1\": true, \"p2\": \"hello\" }\n```\n---\n### Prebuilt Format\nUse `add` method to add format(s).\n```sh\nnode index.js -d -i --id scrwdrv --bonus 12.0\n```\n```js\nconst cliParams = new CLIParams();\n\ncliParams.add({\n    params: [\n        {\n            param: 'debug',\n            type: 'boolean', // true or false, no given value will be treated as `true`\n            optional: true, // boolean is optional by default, no param means `false`\n            alias: 'd'\n        },\n        {\n            param: 'interval',\n            type: 'int', // no floating point is allowed,\n            default: 50, // default value when value is not given\n            alias: 'i'\n        },\n        {\n            param: 'id',\n            type: 'string'\n        },\n        {\n            param: 'bonus',\n            type: 'float', // allow both int and float\n            optional: false // which is default\n        }\n    ]\n}, (err) =\u003e {\n    if (err) return console.log(err);\n    cliParams.exec((err, params) =\u003e {\n        if (err) return console.log(err);\n        console.log(params);\n    });\n});\n```\n```json\n{ \"debug\": true, \"interval\": 50, \"id\": \"scrwdrv\", \"bonus\": 12 }\n```\n#### Types for Param\n- int \n- float\n- string\n- boolean\n- array-of-int     (not available for [Target](#target))\n- array-of-float   (not available for [Target](#target))\n- array-of-string  (not available for [Target](#target))\n- array-of-boolean (not available for [Target](#target))\n\n### Mutiple Formats\nYou can pass formats in an array, by array index order, formats will be used to parse given parameters and callback the first successfully parsed one.\n```sh\nnode index.js -h\n```\n```js\ncliParams.add([\n    {\n        params: [\n            {\n                param: 'input',\n                type: 'string',\n                alias: 'i'\n            },\n            {\n                param: 'password',\n                type: 'string',\n                optional: true,\n                alias: 'p'\n            }\n        ],\n        id: 'regular' // id is not optional when multiple formats are submitted\n    },\n    {\n        params: {\n            param: 'help',\n            type: 'boolean',\n            alias: 'h'\n        },\n        id: 'help' // id is not optional when multiple formats are submitted\n    },\n    {\n        params: {\n            param: 'version',\n            type: 'boolean',\n            alias: 'v'\n        },\n        id: 'version' // id is not optional when multiple formats are submitted\n    }\n]).exec((err, params, id) =\u003e {\n    if (err) return console.log(err);\n    console.log(id);\n    // output: help\n    console.log(params);\n});\n\n```\n```json\n{ \"help\": true }\n```\n### \u003cspan id=\"target\"\u003eTrailing Param (Target)\u003c/a\u003e\nParameter with no name and located at the end of command line will be treated as `Target`. Every cmd can only have one target and need to be named beforehand.\n\n```sh\nnode index.js -r 50 https://google.com\n```\n```js\ncliParams.add({\n    params:\n    {\n        param: 'rate',\n        type: 'int',\n        alias: 'r'\n    },\n    target: {\n        param: 'url',\n        type: 'string',\n        optional: false // which is default\n    }\n}, (err) =\u003e {\n    if (err) return console.log(err);\n    cliParams.exec((err, params) =\u003e {\n        if (err) return console.log(err);\n        console.log(params);\n    });\n});\n```\n```json\n{ \"url\": \"https://google.com\", \"rate\": 50 }\n```\n### Array of ...\nPassing multiple values with space as separator to a single parameter.\n```sh\nnode index.js -i 1 2 3 4 5 -s google yahoo myTarget \n```\n```js\nnew CLIParams().add({\n    params: [\n        {\n            param: 'intArr',\n            type: 'array-of-int',\n            alias: 'i'\n        }, {\n            param: 'stringArr',\n            type: 'array-of-string',\n            alias: 's'\n        }\n    ],\n    target: {\n        param: 'target',\n        type: 'string'\n    }\n}).exec(async (err, params) =\u003e {\n    if (err) return console.log(err);\n    console.log(params);\n});\n```\n```json\n{ \"target\": \"myTarget\", \"intArr\": [ 1, 2, 3, 4, 5 ], \"stringArr\": [ \"google\", \"yahoo\" ] }\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscrwdrv%2Fcli-params","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fscrwdrv%2Fcli-params","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscrwdrv%2Fcli-params/lists"}