A Hotay project. If you like our work, please follow us on GitHub!
A convenient tool to export npm audit results to a comprehensive offline HTML page, providing a clear overview of your project's vulnerabilities.
Inspired by npm-audit-html, but with more Node.js versions supported, offline support and lightweight ⚡
- Lightweight & Efficient
- Fully Offline Functionality
- Advanced Filters, Search, and Ordering
- Tags Filtering Supported
- Supports projects since Node v10
- Download results as CSV or JSON
This package supports Node.js versions 10 through 22, as well as future versions.
This tool processes the JSON output from your audit tool. It works with:
npm audit --json
pnpm audit --json
yarn audit --json
Install globally using your preferred package manager:
npm install -g audit-export
pnpm install -g audit-export
yarn global add audit-export
Pipe the JSON output from your audit command into audit-export
:
npm audit --json | audit-export
pnpm audit --json | audit-export
yarn audit --json | audit-export
Customize the output path and HTML title:
npm audit --json | audit-export --path <output_path> --title <report_title> [--open]
-
--path
: output file or directory (default:./audit-report.html
) -
--title
: HTML report title (default:NPM Audit Report
) -
--open
: automatically open the report in your default browser
For all options and advanced usage, run:
audit-export --help
In versions lower or equal than 3, folder and file were separate parameters. After version 4 both were merged into a single --path
parameter, that can be the folder, the file, or both. Previously it was --folder
and --file
, now removed parameters.
We welcome contributions from the community! Feel free to open issues and submit pull requests on our GitHub Issues page. Your feedback and suggestions are highly appreciated.
You can download the package from npm.
This project is licensed under the MIT License - see the LICENSE file for details.
Happy auditing! 🛡️🚀