https://github.com/jeroenouw/cgx
💻🔥CLI to generate the recommended documentation/files to improve contribution (Github, Gitlab, CodeCommit and Bitbucket)
https://github.com/jeroenouw/cgx
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
Last synced: 16 days ago
JSON representation
💻🔥CLI to generate the recommended documentation/files to improve contribution (Github, Gitlab, CodeCommit and Bitbucket)
- Host: GitHub
- URL: https://github.com/jeroenouw/cgx
- Owner: jeroenouw
- License: mit
- Created: 2019-06-03T12:59:19.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-07-24T12:23:01.000Z (over 1 year ago)
- Last Synced: 2025-03-30T03:03:21.788Z (23 days ago)
- 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
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/cgx
- Size: 1.12 MB
- Stars: 259
- Watchers: 2
- Forks: 20
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-starred-test - jeroenouw/cgx - 💻🔥CLI to generate the recommended documentation/files to improve contribution (Github, Gitlab, CodeCommit and Bitbucket) (TypeScript)
- awesome-starred - jeroenouw/cgx - 💻🔥CLI to generate the recommended documentation/files to improve contribution (Github, Gitlab, CodeCommit and Bitbucket) (cli)
README
# CGX - CLI to Generate recommended documentation/files to improve contribution
[](https://github.com/jeroenouw/cgx)
[](https://github.com/jeroenouw/cgx/blob/master/LICENSE/)
[](https://github.com/jeroenouw/cgx)Do 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).
> Generate multiple files at once
> Generate a license
## Files that can be generated
More files & providers in future versions.### Github, Gitlab, CodeCommit and Bitbucket
* License
- MIT
- ISC
- Apache 2.0
- BSD 2-Clause
- GPLv3
- CCOv1
* Changelog
* Contributing
* Readme
* Todo
* Code of Conduct
* Dockerfile### Github specific
* Bug report (issue)
* Security vulnerability report
* Feature request (issue)
* Pull request template
* CodeQL Analysis
* Node CI
* All files at once### Gitlab specific
* CI template
* Bug (issue)
* Feature proposal (issue)
* Merge request
* All files at once### CodeCommit specific
* Buildspec (AWS CodeBuild)
* Appspec (AWS CodeDeploy)
* All files at once### Bitbucket specific
* In future versions## Useful for every project
* Existing or new
* Large or small
* Every language
* Github, Gitlab, CodeCommit (AWS) or Bitbucket
## Quickstart
Install the CGX CLI as a global CLI.
```shell
npm install -g cgxcd
# Then you run
cgx
```Or just use via npx:
```shell
cd# Then you run
npx cgx
```This should start the CLI and ask for questions about which files you want to add!
## Example
Generate all Github files example:
```shell
____ ____ __ __
/ ___| / ___| \ \/ /
| | | | _ \ /
| |___ | |_| | / \
\____| \____| /_/\_\Generate all the recommended markdown documentation/templates for the Github and Gitlab community standards.
Files for CodeCommit (AWS) or Bitbucket can be generated too
? Select a Git hosting provider: Github
? Which Github files do you want to generate? All recommended files (other files can be generated separate)
INFO: Start generating all recommended files...GENERATE: CODE_OF_CONDUCT.md...
GENERATE: CONTRIBUTING.md...
GENERATE: bug_report.md...
GENERATE: feature_request.md...
GENERATE: pull_request_template.md...
CREATE: bug_report.md in .github/ISSUE_TEMPLATE/bug_report.md
CREATE: CODE_OF_CONDUCT.md.md
CREATE: CONTRIBUTING.md
CREATE: feature_request.md in .github/ISSUE_TEMPLATE/feature_request.md
CREATE: pull_request_template.md in .github/PULL_REQUEST_TEMPLATE/pull_request_template.md
```Git provider question:
```shell
? Select a Git hosting provider: (Use arrow keys)
❯ Github
Gitlab
CodeCommit (AWS)
Bitbucket
```Generate file question:
```shell
? Which Gitlab files do you want to generate? (Use arrow keys)
❯ All recommended files (other files can be generated separate)
License
Changelog
Code of conduct
Contributing
Bug report (issue)
Feature request (issue)
Pull request template
Readme
Todo
Dockerfile
```Generate license example:
```shell
? Select a Git hosting provider: Github
? Which Gtihub files do you want to generate? License
GENERATE: LICENSE...
? Which type of license do you want to generate? MIT License
? Please fill in your Git username: Jeroenouw
CREATE: LICENSE
```File already exists example:
```shell
? Select a Git hosting provider: Bitbucket
? Which Bitbucket files do you want to generate? Contributing
GENERATE: CONTRIBUTING.md...
? This file already exists. Do you want to overwrite it? Yes
UPDATE: CONTRIBUTING.md
```
