File tree Expand file tree Collapse file tree 2 files changed +47
-0
lines changed
Expand file tree Collapse file tree 2 files changed +47
-0
lines changed Original file line number Diff line number Diff line change @@ -4,6 +4,10 @@ A tool that allows you to convert NMAP XML output to html/csv/json/markdown.
44
55## Usage
66
7+ ```
8+ nmap-formatter [path-to-nmap.xml] [html|csv|md|json] [flags]
9+ ```
10+
711Convert XML output to nicer HTML
812
913```
@@ -16,4 +20,47 @@ or Markdown
1620nmap-formatter [path-to-nmap.xml] md > some-markdown.md
1721```
1822
23+ ### Flags
24+
25+ * ` --down-hosts ` includes hosts that are down in the template (html, md)
26+ * ` -f, --file [filename] ` outputs result to the file (by default output goes to STDOUT)
27+ * ` --help ` display help message
28+
29+ ## Installation
30+
31+ ### Using Go
32+
33+ ```
34+ go install github.com/vjdagilev/nmap-formatter@latest
35+ ```
36+
37+ ### Download Binary
38+
39+ Choose version from Release page and download it:
40+
41+ ```
42+ curl https://github.com/vdjagilev/nmap-formatter/releases/download/v0.0.2-alpha/nmap-formatter-linux-amd64.tar.gz --output nmap-formatter.tar.gz -L
43+ tar -xzvf nmap-formatter.tar.gz
44+ ./nmap-formatter --help
45+ ```
46+
47+ ### Compile
48+
49+ ```
50+ git clone [email protected] :vdjagilev/nmap-formatter.git 51+ cd nmap-formatter
52+ go mod tidy
53+ go build
54+ # or
55+ go run . path/to/nmap.xml html
56+ ```
57+
58+ ## Example
59+
60+ Example of HTML generated output from (https://nmap.org/book/output-formats-xml-output.html )
61+
62+ ```
63+ nmap-formatter basic-example.xml html
64+ ```
1965
66+ ![ Basic HTML Example] ( docs/images/basic-example-html.png )
You can’t perform that action at this time.
0 commit comments