{"id":13559056,"url":"https://github.com/jeroenouw/cgx","last_synced_at":"2025-04-06T04:08:17.738Z","repository":{"id":43781398,"uuid":"190005910","full_name":"jeroenouw/cgx","owner":"jeroenouw","description":"💻🔥CLI to generate the recommended documentation/files to improve contribution (Github, Gitlab, CodeCommit and Bitbucket)","archived":false,"fork":false,"pushed_at":"2023-07-24T12:23:01.000Z","size":1177,"stargazers_count":259,"open_issues_count":1,"forks_count":20,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-30T03:03:21.788Z","etag":null,"topics":["aws","aws-codebuild","aws-codecommit","aws-codedeploy","bitbucket","cli","community","documentation","documentation-generator","generator","github","gitlab","markdown","markdown-documentation","markdown-generator","project-documentation","template","templates","typescript"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/cgx","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/jeroenouw.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2019-06-03T12:59:19.000Z","updated_at":"2025-02-24T17:31:54.000Z","dependencies_parsed_at":"2023-09-27T03:37:51.430Z","dependency_job_id":null,"html_url":"https://github.com/jeroenouw/cgx","commit_stats":{"total_commits":91,"total_committers":5,"mean_commits":18.2,"dds":"0.39560439560439564","last_synced_commit":"3a83edaa1b9cf7c460ad9f27baff8dff4019e7de"},"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jeroenouw%2Fcgx","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jeroenouw%2Fcgx/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jeroenouw%2Fcgx/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jeroenouw%2Fcgx/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jeroenouw","download_url":"https://codeload.github.com/jeroenouw/cgx/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247430869,"owners_count":20937874,"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":["aws","aws-codebuild","aws-codecommit","aws-codedeploy","bitbucket","cli","community","documentation","documentation-generator","generator","github","gitlab","markdown","markdown-documentation","markdown-generator","project-documentation","template","templates","typescript"],"created_at":"2024-08-01T12:05:19.083Z","updated_at":"2025-04-06T04:08:17.647Z","avatar_url":"https://github.com/jeroenouw.png","language":"TypeScript","funding_links":[],"categories":["TypeScript","cli","github"],"sub_categories":[],"readme":"# CGX - CLI to Generate recommended documentation/files to improve contribution\n\n[![npmversion](https://img.shields.io/npm/v/cgx.svg)](https://github.com/jeroenouw/cgx)\n[![npmlicense](https://img.shields.io/npm/l/cgx.svg)](https://github.com/jeroenouw/cgx/blob/master/LICENSE/)\n[![downloads](https://img.shields.io/npm/dy/cgx.svg)](https://github.com/jeroenouw/cgx)\n\nDo you want people to contribute to your project? Make it easy for your contributors. Generate all the recommended documentation/files (pre-filled) for the Github and Gitlab community standards. Files for CodeCommit (AWS) or Bitbucket can be generated too. This project has 99+% type coverage checked by [tscov](https://github.com/jeroenouw/liftr-tscov).\n\n\u003e Generate multiple files at once\n\u003cp align=\"center\"\u003e\u003cimg src=\"/cgx-demo.gif?raw=true\"/\u003e\u003c/p\u003e\n\n\u003e Generate a license\n\u003cp align=\"center\"\u003e\u003cimg src=\"/cgx-demo-license.gif?raw=true\"/\u003e\u003c/p\u003e\n\n## Files that can be generated\nMore files \u0026 providers in future versions.\n\n### Github, Gitlab, CodeCommit and Bitbucket\n* License \n  - MIT\n  - ISC\n  - Apache 2.0\n  - BSD 2-Clause\n  - GPLv3\n  - CCOv1\n* Changelog\n* Contributing\n* Readme\n* Todo\n* Code of Conduct\n* Dockerfile\n\n### Github specific\n* Bug report (issue)\n* Security vulnerability report\n* Feature request (issue)\n* Pull request template\n* CodeQL Analysis\n* Node CI\n* All files at once\n\n### Gitlab specific\n* CI template\n* Bug (issue)\n* Feature proposal (issue)\n* Merge request\n* All files at once\n\n### CodeCommit specific\n* Buildspec (AWS CodeBuild)\n* Appspec (AWS CodeDeploy)\n* All files at once\n\n### Bitbucket specific\n* In future versions\n\n## Useful for every project\n* Existing or new\n* Large or small\n* Every language\n* Github, Gitlab, CodeCommit (AWS) or Bitbucket\n\n![](community-score.png)\n\n## Quickstart\n\nInstall the CGX CLI as a global CLI.\n\n```shell\nnpm install -g cgx\n\ncd \u003cyour-repo-location\u003e\n\n# Then you run\ncgx\n```\n\nOr just use via npx:\n\n```shell\ncd \u003cyour-repo-location\u003e\n\n# Then you run\nnpx cgx\n```\n\nThis should start the CLI and ask for questions about which files you want to add!\n\n## Example\n\nGenerate all Github files example:\n```shell\n   ____    ____  __  __\n  / ___|  / ___| \\ \\/ /\n | |     | |  _   \\  /\n | |___  | |_| |  /  \\\n  \\____|  \\____| /_/\\_\\\n\nGenerate all the recommended markdown documentation/templates for the Github and Gitlab community standards.  \nFiles for CodeCommit (AWS) or Bitbucket can be generated too\n? Select a Git hosting provider: Github\n? Which Github files do you want to generate? All recommended files (other files can be generated separate)\nINFO: Start generating all recommended files...\n\nGENERATE: CODE_OF_CONDUCT.md...\nGENERATE: CONTRIBUTING.md...\nGENERATE: bug_report.md...\nGENERATE: feature_request.md...\nGENERATE: pull_request_template.md...\nCREATE: bug_report.md in .github/ISSUE_TEMPLATE/bug_report.md\nCREATE: CODE_OF_CONDUCT.md.md\nCREATE: CONTRIBUTING.md\nCREATE: feature_request.md in .github/ISSUE_TEMPLATE/feature_request.md\nCREATE: pull_request_template.md in .github/PULL_REQUEST_TEMPLATE/pull_request_template.md\n```\n\nGit provider question:\n```shell\n? Select a Git hosting provider: (Use arrow keys)\n❯ Github\n  Gitlab\n  CodeCommit (AWS)\n  Bitbucket\n```\n\nGenerate file question: \n```shell  \n? Which Gitlab files do you want to generate? (Use arrow keys)\n❯ All recommended files (other files can be generated separate)\n  License\n  Changelog\n  Code of conduct\n  Contributing\n  Bug report (issue)\n  Feature request (issue)\n  Pull request template\n  Readme\n  Todo\n  Dockerfile\n```\n\nGenerate license example:  \n```shell  \n? Select a Git hosting provider: Github\n? Which Gtihub files do you want to generate? License\nGENERATE: LICENSE...\n? Which type of license do you want to generate? MIT License\n? Please fill in your Git username: Jeroenouw\nCREATE: LICENSE\n```\n\nFile already exists example:\n```shell\n? Select a Git hosting provider: Bitbucket\n? Which Bitbucket files do you want to generate? Contributing\nGENERATE: CONTRIBUTING.md...\n? This file already exists. Do you want to overwrite it? Yes\nUPDATE: CONTRIBUTING.md\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjeroenouw%2Fcgx","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjeroenouw%2Fcgx","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjeroenouw%2Fcgx/lists"}