lice
v1.3.0
Published
An open source license generator.
Downloads
65
Maintainers
Readme
lice
An open source license generator and license viewer.
Installation
You probably want to install this globally, so you can easily add LICENSE
files to all your open source projects.
npm install -g lice
Usage
lice
# follow the prompts
Non-interactive mode
Usage:
lice [options]
Options:
-h, --help Display the help menu
-g, --generate Generate a license [default `true`]
-l, --license The type of license to generate, [default `mit`]
-n, --name The name of the generated license, [default `LICENSE`]
-p, --path License generation file path, [default `current working dir`]
-s, --show Show the contents of a license
-u, --user The name to use in the generated license [default `$LICE_USER`]
-v, --version Display the version
-y, --year Year placeholder [default `current year`]
Available licenses:
aal Attribution Assurance License (AAL)
afl-3.0 Academic Free License 3.0 (AFL-3.0)
apl-1.0 Adaptive Public License (APL-1.0)
agpl-3.0 Affero GNU Public License 3.0 (AGPL-3.0)
apache-2.0 Apache License, Verison 2.0 (Apache-2.0)
apsl-2.0 Apple Public Source License (APSL-2.0)
artistic-2.0 Artistic License (Artistic-2.0)
bsd-2-clause BSD 2-Clause "Simplified" or "FreeBSD" License (BSD-2-Clause)
bsd-3-clause BSD 3-Clause "New" or "Revised" License (BSD-3-Clause)
bsl-1.0 Boost Software License (BSL-1.0)
catosl-1.1 Computer Associates Trusted Open Source License 1.1 (CATOSL-1.1)
cddl-1.0 Computer Associates Trusted Open Source License 1.0 (CDDL-1.0)
cecill-2.1 CeCILL License (CECILL-2.1)
cpal-1.0 Common Public Attribution License 1.0 (CPAL-1.0)
cua-opl-1.0 CUA Office Public License Version 1.0 (CUA-OPL-1.0)
ecl-2.0 Educational Community License, Version 2.0 (ECL-2.0)
entessa Entessa Public License Version 1.0 (Entessa)
eudatagrid EU Datagrid Software License (EUDatagrid)
eupl European Union Public License v. 1.2
facebook.tos.txt Terms of Service Didn"t Read Facebook License (tosdr_facebook)
gpl-3.0 GNU General Public License 3.0 (GPL-3.0)
isc ISC License (ISC)
mit The MIT License (MIT) [default]
mpl-2.0 Mozilla Public License Version 2.0 (MPL-2.0)
ms-pl Microsoft Public License (MS-PL)
onur_dev onur_dev license (onur_dev license)
transcopyright Transcopyright License (Transcopyright)
copyright Copyright license (Copyright)
w3c The W3C SOFTWARE NOTICE AND LICENSE (W3C)
zlib-libpng The zlib/libpng License (Zlib)
Example
Let's say you want an MIT license for your project. Switch to the directory
where you want the license generated, run lice
and follow the prompts:
cd /your/project/dir
lice
#follow the prompts, your license will be generated in /your/project/dir
Or if you prefer non-interactive mode:
lice -g -l mit -u 'John Doe' # see above for flag definitions or run `lice -h`
Note
You may provide a path to where you want the license generated via the -p
option.
Contributing
Please help add more licenses! Submit a PR and I will get it merged ASAP.
- Add a text file with your license content in the licenses dir.
- Edit licenses.js
- Update the
Available licenses
section in README.md - Update the help file
Available licenses
section in help.txt
A good place to find licenses to add is the Open Source Initiative license page
Thanks, related projects
- AudreyFeldroy/Choosea License: Choose a License is a Cookiecutter plugin for selecting an open-source license.
- Bisaloo/Licenses_Talk: How to choose a license for an academic project?
- Composer/Spdx Licenses: Tools for working with the SPDX license list and validating licenses.
- ClaudiuCeia/Licensor Cli: 📜 Easily choose an Open Source license for your awesome project
- Daald/Dpkg Licenses: A command line tool which lists the licenses of all installed packages in a Debian-based system (like Ubuntu)
- Nevir/Readable-Licenses: Make your open source license text more pleasant to read.
- Onur/Cargo License: Cargo subcommand to see license of dependencies
- Open Source Initiative for providing the license content.
- Ufal/Public License Selector: Tool that will help you select the right open license for your data or software