Skip to content

A tool that allows you to convert NMAP results to html, csv, json, markdown, graphviz (dot) or sqlite. Simply put it's nmap converter.

License

Notifications You must be signed in to change notification settings

vdjagilev/nmap-formatter

Repository files navigation

NMAP-Formatter

build status codecov Maintainability


Examples

HTML: nmap-example-html Graphviz: nmap-example-graphviz

A tool that allows you to convert NMAP XML output to html/csv/json/markdown/dot/sqlite.

Installation

It's possible to install it using go install command

go install github.com/vdjagilev/nmap-formatter/v2@latest

All other options can be found on Installation Wiki page.

Usage

nmap-formatter [html|csv|md|json|dot|sqlite] [path-to-nmap.xml] [flags]

Or alternatively you can read file from stdin and parse it

cat some.xml | nmap-formatter json

Convert XML output to nicer HTML

nmap-formatter html [path-to-nmap.xml] > some-file.html

or Markdown

nmap-formatter md [path-to-nmap.xml] > some-markdown.md

or JSON

nmap-formatter json [path-to-nmap.xml]
# This approach is also possible
cat nmap.xml | nmap-formatter json

or Graphviz (dot)

cat example.xml | nmap-formatter dot | dot -Tsvg > test.svg
# open test.svg with browser

or SQLite

cat example.xml | nmap-formatter sqlite --sqlite-dsn nmap.sqlite
# open nmap.sqlite with any database tool

More examples can be found on Usage Wiki page

Flags

  • -f, --file [filename] outputs result to the file (by default output goes to STDOUT)
  • --help display help message
  • --version display version (also can be used: ./nmap-formatter version)

It's also possible to change various output options. More examples on Usage Wiki Page - Flags.

Screenshots of various formats available here

Use as a library

Examples on how to use this project as a library in golang: Use as a library Wiki page