{"id":18828041,"url":"https://github.com/yehiyam/cli-docs","last_synced_at":"2026-01-22T08:30:18.759Z","repository":{"id":57200049,"uuid":"287321760","full_name":"yehiyam/cli-docs","owner":"yehiyam","description":"Command Line for generating Readme.md documentation from yargs based cli tools","archived":false,"fork":false,"pushed_at":"2020-08-26T07:39:56.000Z","size":29721,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-12-30T05:49:25.157Z","etag":null,"topics":["cli","documentation","readme","readme-md","yargs"],"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/yehiyam.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-08-13T15:54:35.000Z","updated_at":"2020-08-26T07:39:59.000Z","dependencies_parsed_at":"2022-09-16T15:12:30.185Z","dependency_job_id":null,"html_url":"https://github.com/yehiyam/cli-docs","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yehiyam%2Fcli-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yehiyam%2Fcli-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yehiyam%2Fcli-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yehiyam%2Fcli-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yehiyam","download_url":"https://codeload.github.com/yehiyam/cli-docs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239763653,"owners_count":19692812,"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","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":["cli","documentation","readme","readme-md","yargs"],"created_at":"2024-11-08T01:21:22.996Z","updated_at":"2026-01-22T08:30:18.684Z","avatar_url":"https://github.com/yehiyam.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# cli-md-docs  \nTool for creating markdown Readme documentation for cli tools created with\n[yargs](https://github.com/yargs/yargs)  \n## Install  \n```shell  \nnpm i -g cli-md-docs  \n```  \n## Usage  \n## cli-md-docs  \n---  \n```shell  \n$ cli-md-docs   \n```  \nTool for creating markdown Readme documentation for cli tools created with\n[yargs](https://github.com/yargs/yargs)    \nOptions:    \n\n  \n|option|description|type|required|default|  \n|---|---|---|---|---|  \n|--help|Show help|boolean|||  \n|--version|Show version number|boolean|||  \n|--path|path to the cli executable|string|true||  \n|--name|real name of the cli. If omitted, the name of the executable is used|string|||  \n|--output, -o|the output file.|string||./Readme.md|  \n|--installTemplate|replaces the default how to install.|string|||","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyehiyam%2Fcli-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyehiyam%2Fcli-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyehiyam%2Fcli-docs/lists"}