Licensr

License your projects with a nice CLI tool!

Usage

Just run licensr an follow the guide!

If you choose to use Licensr as a node module you can use super greats Promises or you can stick with the node's callbacks, it is you choice.

var licensr = require('licensr');

// Super cool Promise-style
licensr.command('git config --get user.name')
  .then(function (username) {
    // on fulfill
    console.log(username);
  }, function (err) {
    // on reject
    console.error(err);
  });

// Callback-style
licensr.command('git config --get user.name', function (err, username) {
  if (err) { return console.error(err); }
  console.log(username);
});

Installation

Configure your git environement and install Licensr as global node module.

Git is not a requirement but it will autocomplete fields for you!

git config --global user.name "John Doe"
git config --global user.email [email protected]
npm install -g licensr

API

Intro lincensr.intro

Displays the introduction header.

Return values

• intro The introduction text.

Command

Run a command in the shell and get the result.

Arguments

• cmd The command to run.

Return values

• stdout The result of the command.
• err The error as issued by child_process.exec.

Prompt License lincensr.promptLicense

Ask user about the license they want.

Return values

• licence A license's name.

Prompt Info lincensr.promptInfo

Ask user about information required by the license.

Arguments

• license A license's name.
• infoDefault Default values issued by a previous command.

Return values

• answers Information about the user.

Write

Write the license.

Arguments

• data The summary fo needed data.

Return values

• err If there is any error.
• content Your pimped license!

With :heart: from quentinrossetti