cgx - GitLite

KO | EN

gitlite — search

#python #hacktoberfest #typescript #llm #android #deep-learning #linux #macos #windows #pytorch #security #ios #mcp #open-source

cgx

(★ 264)

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

File Explorer

Download Latest Version (.zip)

- - bug_report.md
  - feature_request.md
- - pull_request_template.md
- - nodejs.yml
- cgx
- - bitbucket.actions.spec.ts
  - bitbucket.actions.ts
  - codecommit.actions.spec.ts
  - codecommit.actions.ts
  - github.actions.spec.ts
  - github.actions.ts
  - gitlab.actions.spec.ts
  - gitlab.actions.ts
  - index.ts
- - choice.ts
  - commit-data.ts
  - console-message.ts
  - file.ts
  - path.ts
- - bitbucket-file.question.ts
  - codecommit-file.question.ts
  - github-file.question.ts
  - gitlab-file.question.ts
  - index.ts
  - license.question.ts
  - overwrite-file.question.ts
  - provider.question.ts
  - username.question.ts
- - checker.util.spec.ts
  - checker.util.ts
  - logger.util.ts
- cgx.spec.ts
- cgx.ts
- index.ts
- mocha.require.ts
.editorconfig
.gitignore
.mocharc.js
.npmignore
.npmrc
cgx-demo-license.gif
cgx-demo.gif
CODE_OF_CONDUCT.md
community-score.png
CONTRIBUTING.md
LICENSE
package-lock.json
package.json
README.md
tsconfig.json
tslint.json

# Installation Guide

1. Get the code

git clone https://github.com/jeroenouw/cgx

Downloads the entire project code from GitHub to your computer.

cd cgx

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended

Prerequisites

Node.js Node.js must be installed to use npm.

npm install -g cgx

Installs the package published on the npm registry globally — no need to clone the source.

✅ After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Node.js

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm install -g cgx

Installs the package published on the npm registry globally — no need to clone the source.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

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

[![npmversion](https://img.shields.io/npm/v/cgx.svg)](https://github.com/jeroenouw/cgx)
[![npmlicense](https://img.shields.io/npm/l/cgx.svg)](https://github.com/jeroenouw/cgx/blob/master/LICENSE/)
[![downloads](https://img.shields.io/npm/dy/cgx.svg)](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
<p align="center"><img src="/cgx-demo.gif?raw=true"/></p>

> Generate a license
<p align="center"><img src="/cgx-demo-license.gif?raw=true"/></p>

## 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

![](https://raw.githubusercontent.com/jeroenouw/cgx/master/community-score.png)

## Quickstart

Install the CGX CLI as a global CLI.

```shell
npm install -g cgx

cd <your-repo-location>

# Then you run
cgx
```

Or just use via npx:

```shell
cd <your-repo-location>

# 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
```