https://github.com/ishbguy/license
An opensource software license generator written in shell.
https://github.com/ishbguy/license
bash cli license shell
Last synced: about 1 month ago
JSON representation
An opensource software license generator written in shell.
- Host: GitHub
- URL: https://github.com/ishbguy/license
- Owner: ishbguy
- License: mit
- Created: 2018-03-02T17:44:15.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2025-03-17T14:33:32.000Z (over 1 year ago)
- Last Synced: 2026-05-03T21:37:16.465Z (about 1 month ago)
- Topics: bash, cli, license, shell
- Language: Shell
- Homepage:
- Size: 93.8 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# [license](https://github.com/ishbguy/license)
[![Travis][travissvg]][travis] [![Codecov][codecovsvg]][codecov] [![Codacy][codacysvg]][codacy] [![Version][versvg]][ver] [![License][licsvg]][lic]
[travissvg]: https://www.travis-ci.org/ishbguy/license.svg?branch=master
[travis]: https://www.travis-ci.org/ishbguy/license
[codecovsvg]: https://codecov.io/gh/ishbguy/license/branch/master/graph/badge.svg
[codecov]: https://codecov.io/gh/ishbguy/license
[codacysvg]: https://api.codacy.com/project/badge/Grade/03ce339293c24c08870ebde7e0b793e4
[codacy]: https://www.codacy.com/app/ishbguy/license?utm_source=github.com&utm_medium=referral&utm_content=ishbguy/license&utm_campaign=Badge_Grade
[versvg]: https://img.shields.io/badge/version-v0.1.0-lightgrey.svg
[ver]: https://img.shields.io/badge/version-v0.1.0-lightgrey.svg
[licsvg]: https://img.shields.io/badge/license-MIT-green.svg
[lic]: https://github.com/ishbguy/baux/blob/master/LICENSE
An opensource software license generator written in shell script base on [baux](https://github.com/ishbguy/baux) and powered by [GitHub's licenses API](https://developer.github.com/v3/licenses/).
## Table of Contents
+ [:art: Features](#art-features)
+ [:straight_ruler: Prerequisite](#straight_ruler-prerequisite)
+ [:rocket: Installation](#rocket-installation)
+ [:memo: Configuration](#memo-configuration)
+ [:notebook: Usage](#notebook-usage)
+ [:hibiscus: Contributing](#hibiscus-contributing)
+ [:boy: Authors](#boy-authors)
+ [:scroll: License](#scroll-license)
## :art: Features
+ Support all licenses available on GitHub.
+ Less dependences.
+ Generate without network (except on first run).
+ Configurable.
## :straight_ruler: Prerequisite
> + [`bash`](https://www.gnu.org/software/bash/bash.html)
> + [`coreutils`](https://www.gnu.org/software/coreutils/coreutils.html)
> + [`sed`](https://www.gnu.org/software/sed/)
> + [`curl`](https://curl.haxx.se/)
> + [`jq`](https://stedolan.github.io/jq/)
## :rocket: Installation
You can get this program with `git`:
```
$ git clone https://github.com/ishbguy/license
```
## :memo: Configuration
You can set you own config in `$HOME/.licenserc`:
```
# uncomment to set your own config
# all this three config can write in UPPER-CASE,
# so set AUTHOR, LICENSE_DIR, LICENSE_NAME is OK
# the name who has the copyright
author=ishbguy
# licenses download directory
license_dir=~/.license
# backgroup jobs when downloading licenses
license_jobs=8
```
## :notebook: Usage
Generate a license to standard output
```
$ license.sh mit
```
Generate a license to a file:
```
$ license.sh -o LICENSE.txt mit
```
Specify the year and the author name:
```
$ license.sh -y 2018 -n ishbguy mit
```
Specify a license directory:
```
$ license.sh -d lic mit
```
Download(if no licenses exist in the specify directory) or update licenses:
```
$ license.sh -d lic -u
```
List all available licenses:
```
$ license.sh -l
```
Show information for choosing a license:
```
$ license.sh -c
```
## :hibiscus: Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
## :boy: Authors
+ [ishbguy](https://github.com/ishbguy)
## :scroll: License
Released under the terms of [MIT License](https://opensource.org/licenses/MIT).