Skip to content

A powerful tool that generates a file with NuGet licenses from your projects and much more!

License

Notifications You must be signed in to change notification settings

RustamIrzaev/NuGetHelper

Repository files navigation

NuGet Helper

🚀 The new version written in Rust is on its way. Check it out - NuGet Scanner 🚀

NuGet Helper is a powerful tool that helps you working with licenses inside projects and much more.

Here are what you can achive using this tool:

  • Generate LICENSE-DEPENDENCIES.md (example) file that contains information about all NuGet packages used in a whole solution (including version, link to a license file and more)
  • Supports both: .Net Core and .Net Framework projects structure
  • Show information about each *.csproj file (detects framework version, checks if the project is .Net Core or .Net Framework project)
  • Check and parse packages.config file

image

image


Download

Get the latest binaries from here (supports Windows, MacOS and Linux).

There are two kind of archives per each platform: with and without full suffix.

If you are not sure which to download, use _full version.

_full suffix

Packages with _full suffix are self-contained applications, thus do not require dotnet framework to be installed, while packages without that suffix are framework-dependent applications and they do need standalone dotnet framework installed.

How to use (easy way)

All parameters will be set to their default values as specified in Parameters section.

Mac\Linux

  • Change permissions for executing the script

    chmod +x ./run.sh
  • Execute the script

    # PROJECT_FOLDER is a full folder path to your .Net project
    ./run.sh "<PROJECT_FOLDER>"

Windows

  • Execute the script

    .\run.ps1 "<PROJECT_FOLDER>"

And do not forget to visit this page to check if a new version is available.

How to use (advanced way)

Run the tool with parameters you need directly using dotnet cli.

For example

dotnet NuGetHelper.Tool.dll --solution-folder "<PROJECT_FOLDER>" --generate-license

Parameters

Parameter Required? Description Default value
--solution-folder or --folder yes A path to a folder where the projects is located -
-generate-license or --license no Generates LICENSE-DEPENDENCIES.md file true
--load-metadata no Loads package information from NuGet (Tags, Summary, Description and more) true
--ignore-cli-tools no Ignores CLITools
(Works only on .Net Core projects)
false
--ignore-packages-config no Ignores packages.config file processing false
--print-results no Writes all information to console false
--short no Ignores the metadata if set to true false

Building the tool (advanced users)

Follow this guide.

Contributing

Feel free to create pull requests.

License

This project is licensed under terms of the MIT license. See the LICENSE.md file.


Made with ❤️ by Rustam Irzaev