npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

licensegenie

v1.0.0

Published

LicenseGenie is a command-line tool to generate open-source licenses.

Downloads

37

Readme

LicenseGenie

Description

LicenseGenie is a command-line tool to generate open-source licenses for your projects. It comes with built-in support for common licenses like MIT, Apache 2.0, and GPL 3.0, and also allows users to add their custom license templates.

Installation

npm install -g licensegenie

Usage

After installing, you can generate a license by simply running:

licensegenie

You'll be prompted to choose a license from a list and, depending on the license you choose, you may be asked to provide the copyright holder's name.

The license will be saved in the current directory with the filename LICENSE.

Configuration

You can customize LicenseGenie by adding a configuration file located at ~/.config/licensegenie/config.json.

Sample Configuration

Here's a sample config.json file:

{
  "customLicenses": ["MyCustomLicense1", "MyCustomLicense2"],
  "licenseMetadata": {
    "MyCustomLicense1": {
      "requiresName": true
    },
    "MyCustomLicense2": {
      "requiresName": false
    }
  },
  "customLicenseDir": "/path/to/custom/licenses"
}

Configuration Fields

  • customLicenses: An array of strings specifying the names of the custom licenses.
  • licenseMetadata: An object where each key is a custom license name and the value is an object with additional metadata.
    • requiresName: A boolean that indicates whether the license requires a copyright holder's name.
  • customLicenseDir: The directory where your custom license templates are stored. Each license should be a text file with the name format: LicenseName.txt.

Adding Custom Licenses

To add a custom license, create a text file in your specified customLicenseDir. Use placeholders like [year] and [name] in the license text, which will be replaced when generating the license.