Skip to content

UsageLink

Basic UsageLink

License.sh

Usage:
  license-sh config
  license-sh [options]
  license-sh <path> [options]
  license-sh (-h | --help)
  license-sh --version

Options:
  -h --help                           Show this screen.
  -o <reporter> --output <reporter>   Output [default: console].
  -t --tree                           Show full dependency tree.
  -d --debug                          Debug mode
  -p --project <project_type>         Run only specific project [yarn | npm | maven | pipenv]
  --dependencies                      Include dependency license text analysis. Suported: npm, yarn, maven
  -c --config <config_path>           Use custom path to config       
  --version                           Show version.

PrerequisitesLink

Depends on the project you want to test.

Prerequisites

  • Yarn - yarn and node
  • Maven - maven and java
  • Pipenv - python
  • Npm - npm

ConfigurationLink

Stored inside .license-sh.json in the root of the project.

Generate interactively with license-sh config command.

Example:

{
  "ignored_packages": {
    "python_pipenv": [
      "PyInquirer",
      "setuptools"
    ],
    "npm": [],
    "maven": [],
    "yarn": []
  },
  "whitelist": [
    "MIT"
  ]

  • Ignore packagesLink

  "ignored_packages": {
    "python_pipenv": [
      "PyInquirer",
      "setuptools"
    ],
    "npm": [],
    "maven": [],
    "yarn": []
  }

You can ignore specific packages if it's license is unknown or you have some reason hat you don't what to see it as an error

  "whitelist": [
    "MIT"
  ]

Whitelist is a list of green licenses that shouldn't throw an error if found.