.NET Licenses Reporter

👋 About

.NET tool to report licenses in a project or solution.

🔥 Getting Started

Make sure you have dotnet installed.

dotnet-licenses-reporter tool can be installed using dotnet CLI.

For advanced users and developers, it can be installed and tested directly from source code (see below for more information).

💻 Installing

From dotnet CLI:

dotnet tool install --global dotnet-licenses-reporter

or inside a specific directory:

dotnet new tool-manifest
dotnet tool install dotnet-licenses-reporter

If tool is already installed and need upgrade:

dotnet tool update dotnet-licenses-reporter

To remove the tool:

dotnet tool uninstall dotnet-licenses-reporter

From code source (for development purpose):

1. Clone this repository with git clone [email protected]:LsquaredTechnologies/dotnet-licenses-reporter.git
2. Compile the application with dotnet build -c Release -o ./artifacts
3. Executable should be located inside artifacts repository

🚀 Usage

Usage:
dotnet licenses [<PROJECT | SOLUTION>] [OPTIONS]
dotnet licenses [COMMAND] [COMMAND_OPTIONS]

Collect and report all licenses used in a project or solution.

Arguments:
  <PROJECT | SOLUTION>  The project or solution to report licenses from.

Options:
  -o, --output <OUTPUT_PATH>      The output directory write files to.
  -f, --output-format <FORMAT>    The output formats to use to display package licenses. []
  --silent                        Suppress output to console.
  -t, --template <TEMPLATE_PATH>  A liquid template file to use to display package licenses when output-formats contain
                                  "template".
  --open                          Open the generated file with the default application.
  --version                       Show version information
  -?, -h, --help                  Show help and usage information

Commands:
  templates  Allows to list and export templates.

Run 'dotnet licenses [COMMAND] --help' for more information on a command.

🤝 Contributing

Contributions, fixes and feature requests are welcome!

For major changes, please open an issue first to discuss what you would like to change.

🤩 Quick start

We support both VSCode and Visual Studio for all .Net developments and VSCode for all other files.

Run tests

cd [Project]/
dotnet test

🎗️ Sponsorships

Follow or ⭐️ this project if it helped you!

🏆 Credits

✍ Author

👤 LionelL2

📝 License

Copyright © 2024 LionelL2

This README was generated with ❤️ by dotnet-readme-generator