diff --git a/README.md b/README.md index 2e727df..8323bcf 100644 --- a/README.md +++ b/README.md @@ -170,12 +170,12 @@ before. ## All options in alphabetical order: - `--angularCli` is just a synonym for `--plainVertical` -- `--clarificationsFile` A file that describe the license clarifications for each package, see clarificationExample.json, any field available to the customFormat option can be clarified. The clarifications file can also be used to specify a subregion of a package's license file (instead reading the entire file). +- `--clarificationsFile [filepath]` A file that describe the license clarifications for each package, see clarificationExample.json, any field available to the customFormat option can be clarified. The clarifications file can also be used to specify a subregion of a package's license file (instead reading the entire file). - `--csv` output in csv format. - `--csvComponentPrefix` prefix column for component in csv format. - `--customPath` to add a custom Format file in JSON - `--development` only show development dependencies. -- `--direct` look for direct dependencies only +- `--direct [boolean|number]` look for direct dependencies only if "true" or look for "number" of levels of dependencies - `--excludeLicenses [list]` exclude modules which licenses are in the comma-separated list from the output - `--excludePackages [list]` restrict output to the packages (either "package@fullversion" or "package@majorversion" or only "package") not in the semicolon-seperated list - `--excludePackagesStartingWith [list]` exclude modules which names start with the comma-separated list from the output (useful for excluding modules from a specific vendor and such). Example: `--excludePackagesStartingWith "webpack;@types;@babel"` diff --git a/lib/usageMessage.js b/lib/usageMessage.js index 3588127..b90dde0 100644 --- a/lib/usageMessage.js +++ b/lib/usageMessage.js @@ -2,12 +2,12 @@ const usageMessage = [ 'All options in alphabetical order:', '', ' --angularCli is just a synonym for --plainVertical', - " --clarificationsFile A file that describe the license clarifications for each package, see clarificationExample.json, any field available to the customFormat option can be clarified. Can also be used to specify a subregion of a package's license file (instead reading the entire file).", + " --clarificationsFile [filepath] A file that describe the license clarifications for each package, see clarificationExample.json, any field available to the customFormat option can be clarified. Can also be used to specify a subregion of a package's license file (instead reading the entire file).", ' --csv output in csv format.', ' --csvComponentPrefix column prefix for components in csv file', ' --customPath to add a custom Format file in JSON', ' --development only show development dependencies.', - ' --direct look for direct dependencies only', + ' --direct [boolean|number] look for direct dependencies only if "true" or look for "number" of levels of dependencies', ' --excludeLicenses [list] exclude modules which licenses are in the comma-separated list from the output', ' --excludePackages [list] restrict output to the packages (either "package@fullversion" or "package@majorversion" or only "package") not in the semicolon-seperated list', ' --excludePackageStartingWith [list] excludes packages starting with anything the comma-separated list',