GitHub Command line interface templates TypeScript template gitlab bitbucket Markdown aws-codebuild Amazon Web Services community Documentation generator
Need help with cgx?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.
jeroenouw

Description

💻🔥CLI to generate the recommended documentation/files to improve contribution (Github, Gitlab, CodeCommit and Bitbucket)

183 Stars 14 Forks Other 94 Commits 0 Opened issues

Services available

Need anything else?

CGX - CLI to Generate recommended documentation/files to improve contribution

npmversion npmlicense downloads

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.

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
  • 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.

npm install -g cgx

cd

Then you run

cgx

Or just use via npx:

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: CODEOFCONDUCT.md... GENERATE: CONTRIBUTING.md... GENERATE: bugreport.md... GENERATE: featurerequest.md... GENERATE: pullrequesttemplate.md... CREATE: bugreport.md in .github/ISSUETEMPLATE/bugreport.md CREATE: CODEOFCONDUCT.md.md CREATE: CONTRIBUTING.md CREATE: featurerequest.md in .github/ISSUETEMPLATE/featurerequest.md CREATE: pullrequesttemplate.md in .github/PULLREQUESTTEMPLATE/pullrequesttemplate.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

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.