Licensor

Create LICENSE file into your project.

create-demo

Usage

Commands

  • -l, --list: See all available licenses.
  • -v, --version: Print the version.
  • create <LICENSE>: Create a license file.
  • help [COMMAND]: Describe available commands or one specific command.
  • show <LICENSE>: Show a license text.

Options

  • -f, --filename <FILENAME>: The output filename. Default value is `LICENSE'.
  • -n, --name <NAME>: The name to use. Default value is obtained from git.
  • -y, --year <YEAR>: The year to use. Default value is this year.

Examples

options-demo

default-demo

Installation

$ gem install licensor

Available Licenses

Run licensor --list to see all available licenses.

  • apache
  • artistic
  • bsd
  • eclipse
  • gpl
  • lgpl
  • mit
  • mozilla
  • nysl
  • zlib
  • no-license
  • unlicense

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment. Run bundle exec licensor to use the gem in this directory, ignoring other installed copies of this gem.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/tatzyr/licensor.

Licence

See LICENSE.

Author

OTSUKA Tatsuya