Awesome
license-generator
A Command line tool that generates LICENSE
file.
Installation
Install with Cargo:
cargo install license-generator
Usage
$ license-generator --author <name> [LICENSE_TYPE]
[LICENSE_TYPE]:
- AGPL
- Apache
- CC-BY
- CC-BY-NC
- CC-BY-NC-SA
- CC-BY-SA
- CC0
- GPL
- LGPL
- MIT
- MPL
- Unlicense
Options:
-l, --list lists the available licenses
--author input author name. Default: `GitName <GitEmail>`
--project input project name that is required by some license
--year input license year
--output path to the output. Default: ./LICENSE
Supported Licenses
This CLI supports the following licenses:
- AGPL-3.0
- Apache-2.0
- CC-BY-4.0
- CC-BY-NC-4.0
- CC-BY-NC-SA-4.0
- CC-BY-SA-4.0
- CC0-1.0
- GPL-3.0
- LGPL-3.0
- MIT
- MPL-2.0
- Unlicense
Examples
Generate MIT LICENSE
license-generator MIT
Output to stdout
license-generator MIT --output /dev/stdout
Multi LICENSE
license-generator MIT Apache
# generates `LICENSE-MIT` and `LICENSE-APACHE`
Specify year and author
license-generator MIT --author azu --year 2024
Tests
cargo test
Releases
Use cargo-release.
cargo release --execute --publish {patch,minor,major}
Contributing
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature
- Commit your changes:
git commit -am 'Add some feature'
- Push to the branch:
git push origin my-new-feature
- Submit a pull request :D
License
MIT © azu