Help & Support Getting Started


How to get PackageDump

  1. Choose your version - Pro, Basic or Trial.
  2. You will be prompted to create a guest or full account, or sign in to an existing account. Your account will allow you to manage your license key(s).
  3. Download and install PackageDump.
  4. Follow the Licensing instructions below.
  5. Run PackageDump with the first time usage instructions below!

Licensing

To license PackageDump on the system where it was installed, run the register command. This can be repeated on as many systems as you purchased licenses for. This applies to the Basic and Trial versions as well.

> BluePasserine.PackageDump.exe register --key=LICENSE_KEY --email=ACCOUNT_EMAIL

License Re-validation

If you need to force your license to refresh from the BluePasserine licensing system, you can issue the --revalidate command.

After renewing a license, or performing an upgrade it may be necessary to re-validate.

General Command Line Options

  • help display the top level help text or use help <command> to display the help text for a specific command.
  • --prompt force the application to prompt before exiting.
  • --verbosity=[Debug,Info,Warn,Error,Fatal]
  • --base-dir=C:\Temp the fully qualified base directory which all paths will become relative to, if they are not already fully qualified. If not specified, then the base directory is assumed to be the application directory.
  • --logger=[Aggregate,File,Console] the type of logger to use (Aggregate logs to both File and Console).

Running PackageDump for the first time

After opening a command prompt as Administrator and changing to the installation directory, here are a few basic commands to get started with...

Run PackageDump against a Config File

To run PackageDump against a NuGet Packages.config or NPM package.json file, or a directory structure containing these files, use the following commands.

> PackageDump.Cli.exe all --package-path=ThePathToYourProject --reporters=json,html --report-title="A title for your report"
NuGet
> PackageDump.Cli.exe nuget --package-path=SomePathTo\packages.Config --reporters=json,html --report-title="A title for your report"
NPM
> PackageDump.Cli.exe npm --package-path=SomePathTo\package.json --reporters=json,html --report-title="A title for your report"
Understanding the Arguments
  • all, npm, and nuget indicate the package manager being targeted or both.
  • --package-path indicates the relative path to the NuGet Packages.config, NPM package.json file or a root directory which has subdirectories containing either file types. PackageDump will load the dependencies listed in these files, call NPM or NuGet for the package details. Once the details have been loaded, PackageDump will iterate the dependencies, and so on, until all dependencies have been loaded.
  • --reporters contains a list of reporting methods (read more about Reporters). The json flag will produce a JSON formatted report. The basichtml flag will produce a basic flat HTML file report. A more advanced html reporter is also available in the Pro Version.
  • --report-title an optional friendly title to add to the report output.
A Note about Versioning

PackageDump follows the SemVer versioning scheme, as do the Package Managers it integrates with. PackageDump looks to the latest version first, in the case of version ranges, but whenever possible will attempt to resolve the specific version. For NuGet packages, the legacy NuGet versioning scheme is also considered as part of the version resolution.