From d0fc79c5bb961943234d095491787b5be41d6e7a Mon Sep 17 00:00:00 2001 From: Rony Xavier Date: Mon, 15 Feb 2021 22:00:37 -0500 Subject: [PATCH] Update readme Signed-off-by: Rony Xavier --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 8ceb9a9..9472a5a 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,7 @@ HeimdallTools supplies several methods to convert output from various tools to " - **nessus_mapper** - commercial vulnerability scanner - **snyk_mapper** - commercial package vulnerability scanner - **nikto_mapper** - open-source web server scanner +- **jfrog_xray_mapper** - package vulnerability scanner Ruby 2.4 or higher (check using "ruby -v") @@ -181,6 +182,21 @@ FLAGS: example: heimdall_tools nikto_mapper -j nikto_results.json -o nikto_results.json ``` +## jfrog_xray_mapper + +jfrog_xray_mapper translates an JFrog Xray results JSON file into HDF format JSON to be viewable in Heimdall + +``` +USAGE: heimdall_tools jfrog_xray_mapper [OPTIONS] -j -o + +FLAGS: + -j : path to xray results JSON file. + -o --output : path to output scan-results json. + -V --verbose : verbose run [optional]. + +example: heimdall_tools jfrog_xray_mapper -j xray_results.json -o xray_results_hdf.json +``` + ## version Prints out the gem version