Skip to content

Sharkeonix/nmap-unleashed

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Note

At the end of each quarter, there is a patch day. During this release, all accumulated features and bugs are implemented and released together. Only hotfixes and critical bugs are addressed before the scheduled patch day.

Banner Home Installation and Requirements Quick Usage and Examples Commands and Options Docs Changelog License

nmapUnleashed (nu)

Version Status Python Platform License

nmapUnleashed (nu) is a modern CLI wrapper for Nmap, designed to make network scanning more comfortable and effective. Nmap is THE tool for penetration testing and network auditing, you can use nu just like Nmap with all its familiar commands but with extended features such as multithreading, easy scan management, and improved overview of your scans and more.

Dashboard

Contents




✨ Feature Summary

  • Modern Nmap wrapper β€” all Nmap commands, but extended
    Use nu exactly like Nmap while benefiting from additional usability improvements and sensible defaults combined in an appealing CLI-dashboard.

  • Multithreading
    Run scans in parallel and tune concurrency to fit your environment and network bandwidth.

  • Easy scan management β€” appealing overview & live inspection
    Manage queued/active/completed scans, open live results, and get a clear summary view.

  • Network usage monitor
    See throughput and progress in real time to balance speed and network impact including custom warning thresholds.

  • Automatic & manual abort of scans
    Set automatic timeouts for long-running jobs or abort scans manually to avoid runaway tasks.

  • Powerful target specification loader
    Import targets from files, CIDR ranges, host patterns, and combine multiple sources effortlessly.

  • Parameter sets / presets
    Define parameter sets / presets and load any set with a single command to start scans faster.

  • Persistent dashboard and scan summary
    After nmapUnleashed finishes, a dashboard.txt file is generated containing a complete overview of all performed scans and their statuses.
    Also, all scan results are merged into scans.xml and scans.html, for centralized inspection and post-processing.

  • Open Source & Apacheβ€―2.0 License
    Fully open source under the Apacheβ€―2.0 License, allowing commercial use, modification, and redistribution. The license also provides patent protection and does not require derived works to be open-sourced, making nmapUnleashed suitable for professionals, companies, and hobbyists alike.

  • …and more
    Check out the docs and help page for all features.




πŸ“¦ Installation and Requirements

Required Installed Packages (Already installed on Kali)

  • nmap
  • xsltproc
  • grep
sudo apt install -y nmap xsltproc grep

Quick Install using pipx

pipx ensurepath
pipx install git+https://github.com/sharkeonix/nmap-unleashed.git
# now "nu" and "nmapUnleashed" are available

Offline: Quick Install using pipx

cd ./nmap-unleashed #where nmap-unleashed is the repository
pipx ensurepath
pipx install
# now "nu" and "nmapUnleashed" are available



πŸš€ Quick Usage and Examples

nmapUnleashed is intended to feel familiar to Nmap users while adding scan management and productivity features.

After nmapUnleashed finishes, a dashboard.txt file is generated containing a complete overview of all performed scans and their statuses.
Also, all scan results are merged into scans.xml and scans.html, for centralized inspection and post-processing.

Config file location: ~/.config/nmapUnleashed/nmapUnleashed.conf

Basic Scan

# Classic Nmap scan of all ports with version detection.
nu -d -p- -A scanme.nmap.org

Powerfull target loading and custom multithreading

# Scan multiple targets specified as IPs, CIDRs, or files in 8 parallel scans and only create merged scan results (scans.xml, scans.html).
nu -th 8 -p- -A scanme.nmap.org 192.168.178.0/24 targets.txt -os

Using predefined parameter sets / presets (nmap and unleashed parameter)

# Define parameter sets / presets, in config, and load any set with a single command to start scans faster.
# Example: {'basic': '-d -p- -A', 'basic-offline': '-d -p- -A -Pn', 'safe': '-th 8 -kt 120 -d -p - -sV --exclude-ports 9100 --exclude localhost', 'default': '-th 4 -kt 120 --exclude localhost -nwr 5000 -nwt 5000 -d -p- -A'}
nu -ps basic scanme.nmap.org

Parallel scans with auto-abort and bandwitdh usage warning

# 8 threads, auto-abort after 120 min, warn if network >1000 KBps, keep files for non-online targets.
nu -th 8 -kt 120 -nwr 1000 -nwt 1000 -ko -p- -sV scanme.nmap.org

Scan output and files configuration

# Keep scan files for non-online targets, store all scans in the current folder, remove specified file types after scan.
nu -ko -nf -rf "xml;html;gnamp" -p- -A fd12:3456:789a::/28

Define targets and networks, exclude specific targets and set individual nmap parameters

# Specify Nmap parameters and targets, set custom parameters for a target network, and exclude one target of the specified network.
nu -p- -A 10.10.2.1 10.10.2.2 "10.10.1.0/24=--top-ports 100 -A" -ex 10.10.1.5



🧰 Commands and Options

nmapUnleashed provides a set of options which are briefly described down below, these extend the normal option set of Nmap. For the official Nmap parameters, that nmapUnleashed inheritates, please checkout the official Nmap docs. For permanent changes the config file can be edited. For detailed information please visit the docs.

(Only -v, -iL, -oN, -oX, -oS, -oG and -oA are not available as these functions are handeld through nmapUnleashed.)

After nmapUnleashed finishes, a dashboard.txt file is generated containing a complete overview of all performed scans and their statuses.
Also, all scan results are merged into scans.xml and scans.html, for centralized inspection and post-processing.

Usage

Usage: nmapUnleashed [OPTIONS] [TARGETS]...

Arguments

[TARGETS]... β€” Specify one or more targets for the scan.

Targets can be:

  • Single IP addresses (e.g., 192.168.1.1 or fd12:3456:789a::)
  • CIDR ranges (e.g., 10.0.0.0/24 or fd12:3456:789a::/28)
  • Hostnames / DNS names (e.g., scanme.nmap.org)
  • Files containing one target per line (e.g., targets.txt)

You can also assign custom Nmap parameters per target using the syntax: "<target>=<nmapParameter>"

Scan Options

Option Value Type Default Value Description
-th /
--threads
<number> 4 Number of threads (max parallel scans).
-ps /
--parameter-set
<id> None Apply a predefined parameter set / preset (nmap and unleashed parameter) from config, merged with parameters given at runtime.
-kt /
--kill-threshold
<minutes> None Automatically abort a scan if it reaches the specified runtime.
-ex /
--exclude
<target> None Exclude passed target(s) (IP, CIDR, DNS, File) from target list.

Dashboard Options

Option Value Type Default Value Description
-nwr /
--network-warning-receive
<integerInKBp> 0 Warn if incoming network traffic reaches defined KBps (0 to disable).
-nwt /
--network-warning-transmit
<integerInKBp> 0 Warn if outgoing network traffic reaches defined KBps (0 to disable).
-fs /
--fixed-size
N/A False Keep the dashboard size fixed.

Output Options

Option Value Type Default Value Description
-ko /
--keep-offline
N/A False Preserve scan files for non-online targets; they are always listed in dashboard.txt.
-rf /
--remove-files
<listOfFileTypes> None Delete specified scan files after completion (e.g., "xml" or "xml;gnmap").
-nf /
--no-folder
N/A False Store all scan files in the current directory instead of creating a subfolder per scan.
-op /
--output-pattern
<outputPattern> {target} Set the naming pattern for scan files and folders (e.g., {target}_{parameter});{target} is mandatory.
-nd /
--no-dashboard
N/A False Do not create the dashboard.txt file (holding an overview over performed scans and their states).
-ns /
--no-scans
N/A False Do not create the scans.xml and scans.html file (holding the merged scan results).
-os /
--only-scans
N/A False Only create the scans.xml and scans.html file (holding the merged scan results) and no files for each individual scan.
-oc /
--original-colors
N/A False Do not tamper the scans.html and keep nmap's original color scheme.

Misc Options

Option Value Type Default Value Description
-c /
--config
"<configKey>:<value>;..." None Temporarily adjust configuration settings for this run (adjust config file for permanent changes).
-qm /
--quiet-mode
N/A False Enable quiet mode (no banner or version info).
-sm /
--silence-mode
N/A False Enable silent mode (suppress all terminal output).
-v /
--version
N/A N/A Display nmapUnleashed version.
-h /
--help
N/A N/A Display help message.



🎬 Showcase

Detailed information for the dashboard: πŸ“Š Dashboard Overview

Dashboard

The nmapUnleashed dashboard provides a clear, real-time overview of all scans.
It displays queued, active, aborted and completed scans, allows live inspection of results and manual aborting of scans, and monitors network usage and performance at a glance, helping you manage multiple scans efficiently. The dashboard is also outputted with all final results as dashboard.txt, holding information on all performed scans.

Dashboard

Live Results

Navigate through scans in real-time using the arrow keys (↑, ↓), ENTER to view details, q / ESC to quit detailed view, and k to manually abort a scan if it’s taking too long.
(DISCLAIMER: During active Nmap scans, only port information is available; service and version details appear after the scan completes.)

Dashboard




🀝 Contributing / Credits and Contact

The process and possibilities for contribution will be announced soon.


Credits

Special thanks to the beta testers for their participation and feedback, among them were

  • Anton Kettling, wandton

Contact

sharkeonix@pm.me




πŸ“œ Changelog

Version Release Date Description
v1.2.1 17.02.2026 Opening nmapUnleashed for the community and commercial use. Switching license to Apache 2.0.
v1.1.1 08.02.2026 Quickfix. Aborted scans don't have a proper xml file which made the merge scans feature crash. Custom xml elements are now added so aborted scans are listed in scans.xml and scans.html with note that scan was aborted.
v1.1.0 03.02.2026 Adding merged scans feature (scans.xml, scans.html) and relating options (-ns, -os, -oc).
v1.0.0 31.01.2026 Official Release



About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Languages