🚀 PNPM Audit HTML

Generate beautiful HTML reports from your pnpm audit results. This tool provides a clear and concise view of vulnerabilities in your project, making it easier to track and fix issues.

✨ Features

• Easy to Use: Simple CLI commands to generate reports.
• Beautiful Reports: Generates well-structured and visually appealing HTML reports.
• Customizable Output: Choose your output file name and location.

📦 Installation

To install pnpm-audit-html, follow these steps:

# Ensure you have pnpm installed
npm install -g pnpm

# Install pnpm-audit-html globally
pnpm install -g pnpm-audit-html

Or, install it as a dev dependency in your project:

pnpm add -D pnpm-audit-html

🚀 Usage

After installation, you can generate an HTML report from your pnpm audit results with a single command.

Basic Usage

pnpm-audit-html

This command will generate an HTML report in the current directory with the default name pnpm-audit-report.html.

Custom Output File

To specify a custom output file, use the -o or --output option:

pnpm-audit-html --output report.html

Example Commands

# Generate report with default file name
pnpm-audit-html

# Generate report with a custom file name
pnpm-audit-html --output security-report.html

🔧 Configuration

pnpm-audit-html uses sensible defaults for most configurations. However, you can customize the output file name and other options directly via CLI flags.

Available Options

• -o, --output <file>: Specify the output HTML file (default: pnpm-audit-report.html).
• -V, --version: Output the version number.
• -h, --help: Display help for the command.

🤝 Contributing

Contributions are welcome! Feel free to open issues or submit pull requests on GitHub.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

📞 Support

If you encounter any issues or have questions, please open an issue on the GitHub repository.

🎉 Acknowledgments

Thanks to all contributors and the open-source community for making this project possible.