35 lines
1.6 KiB
Markdown
35 lines
1.6 KiB
Markdown
# ODIT.Services - License Exporter
|
|
|
|
[](https://ci.odit.services/odit/license-exporter)
|
|
|
|
A simple license exporter that crawls your package.json and provides you with information about your dependencies' licenses.
|
|
You can export this information into json(even prettyfied) and markdown.
|
|
We use this in our open source projects to credit the awesome work of other open source contributors.
|
|
|
|
## Install
|
|
Via yarn/npm:
|
|
```bash
|
|
yarn add @odit/license-exporter
|
|
# Or
|
|
npm i @odit/license-exporter
|
|
```
|
|
|
|
## CLI Usage
|
|
|
|
Export only your dependencies to json: `licenseexporter --json`
|
|
Export all dependencies to json: `licenseexporter --json --recursive`
|
|
|
|
Export only your dependencies to markdown: `licenseexporter --md`
|
|
Export all dependencies to markdown: `licenseexporter --md --recursive`
|
|
|
|
## Options
|
|
Arg | Description | Type | Default
|
|
| - | - | - | -
|
|
\-j, --json | Exports the license information into ./licenses.json as json. | flag/[boolean] | N/A
|
|
\-p, --pretty | Prettify the json output.|flag/[boolean] | N/A
|
|
\-m, --markdown | Exports the license information into ./licenses.md as markdown. | flag/[boolean] | N/A
|
|
\-r, --recursive | Include all of the dependencies' subdependencies. | flag/[boolean] | N/A
|
|
\-o, --output | Output folder for the exports. | [string] | Current folder
|
|
\-i, --input | Path to the input folder containing your package.json and node_modules | [string] | Current folder
|
|
\-h, --help | Show help | flag/[boolean] | N/A
|
|
\-v, --version | Show version number | flag/[boolean] | N/A |