GH-License

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 45 Open GitHub ↗

Scan your online repo, check if it is missing the license (or install the Git Hooks in your machine)

Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# GitHosting License
[![License](https://img.shields.io/badge/License-MIT%20v1-blue.svg)](https://spdx.org/licenses/MIT.html#licenseText)   
[![License](https://img.shields.io/badge/License-MIT%20v1-blue.svg)](https://spdx.org/licenses/MIT.html#licenseText)   
[![License](https://img.shields.io/badge/License-MIT%20v1-blue.svg)](https://spdx.org/licenses/MIT.html#licenseText)   
[![License](https://img.shields.io/badge/License-MIT%20v1-blue.svg)](https://spdx.org/licenses/MIT.html#licenseText)   
[![License](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](http://www.gnu.org/licenses/gpl-3.0)

This script scans every repo of a user (on GitHub/Bitbucket/GitLab or other providers available) for:

* Check if include a license file
* Download a license to the project folder (automatically execute a `git commit`)
* Adds a license badge in the readme (automatically execute a `git commit`)
* Include git hooks to check if your project has one.

Remember, without a license file your project is proprietary even if it is online!

## Install

```
pip3 install gh-license
```

In case of a git clone:

```
pip3 install -e ./folder-of-the-repo
```

_**Info:** This overwrites the `init.templatedir` global git config after creating a backup of the current value in `~/.gh-license/config.ini` with the key `templatedir` in section `main`.  
The installed git template contains a hook that will be installed every time you run `git init`. The hook reminds you to install a license if you ever forget, and disables itself after adding one._

## Example

gh-license --scan Mte90

With this command you will get a report in a file called Mte90-github-license-report

gh-license --scan Mte90 --provider bitbucket

With this command you will get a report in a file called Mte90-bitbucket-license-report

gh-license --scan Mte90 --report my-report

With this command you will get a report in a file called my-report

gh-license --license-list

With this command will be showed the licenses avalaible

gh-license --license GPLv3

With this command, a GPLv3 license will be downloaded, a shields will be added in the readme and if Git is available a commit will be added and the changes will be pushed to the repo.

gh-license --license GPLv3 -- origin upstream

With this command the commit will be pushed on the upstream origin

[Example of output](https://gist.github.com/Mte90/4c5ec76c94afa61983f8)

GH-License

Download

Today's picks

Was this content helpful?

Recent Feedback

GH-License

Download

Today's picks

Was this content helpful?

Recent Feedback

Download README