@secvisogram/cli

A command-line interface for rendering CSAF (Common Security Advisory Framework) documents (versions 2.0 and 2.1) to HTML, without needing the Secvisogram web app - see issue #606.

It uses @secvisogram/html-template for the actual rendering, and is a thin wrapper around it.

Installation

npm install -g @secvisogram/cli

Usage

secvisogram-render render <input-file.json> [-o <output-file.html>]
secvisogram-render --help
secvisogram-render --version

• <input-file.json> - path to a CSAF 2.0 or 2.1 JSON document.
• --output, -o <output-file.html> - path to write the rendered HTML to. If omitted, the HTML is written to stdout instead.
• --help, -h - print usage information. Works both on its own (secvisogram-render --help) and after a command (secvisogram-render render --help).
• --version, -v - print the installed version of @secvisogram/cli.

Examples

Render to stdout:

secvisogram-render render advisory.json

Render to a file:

secvisogram-render render advisory.json -o advisory.html

The CSAF version (2.0 or 2.1) is read from the document's document.csaf_version field; there's no separate flag to select it. Any other value (or a missing field) is rejected with an error.

The output is a single, self-contained HTML file/string - all CSS is inlined into <style> tags, so it works fully offline and can be opened directly from disk (file://...) without any other files alongside it.

Exit codes

The CLI exits with 1 and prints a message prefixed with error: to stderr (instead of a raw stack trace) for:

• a missing or unreadable input file
• invalid JSON in the input file (a leading UTF-8 byte-order-mark, if present, is stripped automatically before parsing)
• an unsupported or missing document.csaf_version
• a failure while writing the output file
• an unknown or missing command

On success, it exits with 0.

Known limitations

• Only the two bundled templates (for CSAF 2.0 and 2.1) can be used; there's currently no way to supply a custom template (tracked as a follow-up to issue #606, which originally requested this).

Development

git clone https://github.com/secvisogram/cli
cd cli
npm install
npm test   # type-check, prettier --check, and run the test suite