{"library":"snyk-to-md","title":"Snyk JSON to Markdown Converter","type":"library","description":"This utility package, `snyk-to-md` (current stable version 1.0.0), provides a command-line interface for transforming the JSON output generated by the `snyk test --json` command into a human-readable Markdown report. It simplifies the process of integrating Snyk vulnerability reports into documentation workflows or sharing findings without requiring users to navigate complex JSON structures. The package's primary function is to consume the JSON stream via standard input (stdin) or a file, then output a formatted Markdown file, typically named `Snyk_Report.md` by default or a user-specified path. Its release cadence is likely infrequent, as it serves a specific, stable transformation purpose. Key differentiators include its singular focus on Markdown output, direct piping capability, and ease of use as a global CLI tool for local reporting.","language":"javascript","status":"active","last_verified":"Sun Apr 19","install":{"commands":["npm install snyk-to-md"],"cli":{"name":"snyk-to-md","version":null}},"imports":["npm install -g snyk-to-md"],"auth":{"required":false,"env_vars":[]},"links":{"homepage":null,"github":"https://github.com/HunterJS-bit/snyk-to-md","docs":null,"changelog":null,"pypi":null,"npm":"https://www.npmjs.com/package/snyk-to-md","openapi_spec":null,"status_page":null,"smithery":null},"quickstart":{"code":"// This package is primarily a Command Line Interface (CLI) tool.\n// To use it, you first need to install it globally:\n// npm install -g snyk-to-md\n\n// You also need the Snyk CLI installed to generate the input JSON:\n// npm install -g snyk\n// (Optionally, run 'snyk auth' if you haven't authenticated with Snyk)\n\n// Then, generate a Snyk vulnerability report in JSON format\n// and pipe its output directly to snyk-to-md.\n\n// Example 1: Generate a report and save it to a default file (Snyk_Report.md)\n// from your project root:\n// snyk test --json | snyk-to-md\n// This command will create 'Snyk_Report.md' in the current directory.\n\n// Example 2: Generate a report and specify a custom output path and filename:\n// snyk test --json | snyk-to-md -o ./reports/my-snyk-vulnerabilities.md\n// Ensure the 'reports' directory exists or adjust the path accordingly.\n\n// You can verify the generated Markdown file by opening it in a text editor\n// or a Markdown viewer.","lang":"typescript","description":"Demonstrates the global installation and primary command-line usage of `snyk-to-md` to convert Snyk JSON vulnerability reports into a Markdown file.","tag":null,"tag_description":null,"last_tested":null,"results":[]},"compatibility":null}