khalidbelk/licenzio
1
0
Fork 0
mirror of https://github.com/khalidbelk/licenzio.git synced 2026-06-21 03:12:41 +02:00
Code Issues Projects Releases 3 Packages Wiki Activity
A CLI tool for adding license files to projects
23 commits 4 branches 3 tags 101 KiB
  • OCaml 65.1%
  • Makefile 20.2%
  • Dune 14.7%
Find a file
Exact
Khalid 6097c190ae
 Merge pull request #3 from khalidbelk/feat/bsd2-zlib-licenses 
Feat: add BSD 2 Clause and zlib licenses
2026-05-01 19:30:03 +02:00
.github/workflows feat(cd): add opam deps installation step to releases workflow 2026-02-09 20:56:46 +01:00
licenses feat: add BSD 2 license 2026-05-01 19:22:18 +02:00
src chore: bump version 2026-05-01 19:24:39 +02:00
test feat: initial commit 2026-02-04 01:28:20 +01:00
.gitignore feat: embed licenses at compile time with ppx_blob 2026-02-09 20:10:06 +01:00
dune-project feat: embed licenses at compile time with ppx_blob 2026-02-09 20:10:06 +01:00
LICENSE feat: add attribution to licenses 2026-02-08 02:51:07 +01:00
licenzio.opam feat: embed licenses at compile time with ppx_blob 2026-02-09 20:10:06 +01:00
Makefile feat: embed licenses at compile time with ppx_blob 2026-02-09 20:10:06 +01:00
README.md docs: move the usage section before the installation section in README 2026-02-10 11:14:56 +01:00

README.md

Licenzio

Licenzio is a very simple, time-saving CLI tool that makes it easier to add a LICENSE file to your project.

If you're like me, tired of having to search for a license online, copying it, creating the file and pasting it into your new project every time, this simplifies it by putting it just a command away.

Usage

Add a license to your project:

licenzio mit                               # Adds MIT license
licenzio apache                            # Adds Apache 2.0 license
licenzio lgpl -o ~/Desktop/my_old_project/ # Adds LGPL v3 license to the specified directory

See all available licenses and options:

licenzio -h

Installation

Pre-built binaries

To install Licenzio, download the latest release binaries:

Linux:

curl -L -o licenzio https://github.com/khalidbelk/licenzio/releases/latest/download/licenzio-linux
chmod +x licenzio
sudo mv licenzio /usr/local/bin/

or macOS (ARM/M series)

curl -L -o licenzio https://github.com/khalidbelk/licenzio/releases/latest/download/licenzio-macos
chmod +x licenzio
sudo mv licenzio /usr/local/bin/

Then verify the installation with:

licenzio --version

Build from source

Alternatively, if you want to build the project, follow these steps:

Requires: OCaml 5.2, opam, and make

  1. Clone this repository and open it.
git clone git@github.com:khalidbelk/licenzio.git
cd licenzio
  1. Compile with the Make tool (needs to be already installed in your system)
make install && make

This will produce the licenzio executable.

License

This project is licensed under the MIT License - see the LICENSE file for details.