🚀 nmaping

nmaping is a simple, colorful, menu-based tool that helps you run Nmap scans without remembering any commands. Pick a scan from the menu, enter a target, and get your results. Everything is saved automatically.

Made by Mr Tan.

📖 What Does It Do?

Nmap is a powerful network scanner, but its commands are long and hard to remember. nmaping does the hard part for you:

• Shows all scan types in a clean numbered menu
• Asks for your target (IP address, website, or a whole network range)
• Lets you choose how fast or how quiet the scan should be
• Runs the scan and shows the result on screen
• Saves the result to a file and keeps a history of everything you scanned

✅ Before You Start

You need two things on your computer:

1. Python 3.8 or newer
2. Nmap

Install Nmap:

📦 How to Install

Linux (recommended: pipx)

sudo apt install -y pipx
pipx ensurepath

Close and reopen your terminal, then:

pipx install nmaping

Linux / Mac (using pip)

New Linux versions don't allow plain pip install, so create a small environment first:

python3 -m venv ~/.nmaping-venv
source ~/.nmaping-venv/bin/activate
pip install nmaping

Every time you want to use it later, run source ~/.nmaping-venv/bin/activate first.

Windows

Open PowerShell and run:

python -m pip install --user pipx
python -m pipx ensurepath

Close and reopen PowerShell, then:

pipx install nmaping

▶️ How to Run

Just type:

nmaping

🧭 How to Use (Step by Step)

1. Run nmaping. The main menu appears with the logo and a live clock.
2. Type the number of the scan you want and press Enter.
3. Enter your target, for example:
   • 192.168.1.1 (one device)
   • example.com (a website)
   • 192.168.1.0/24 (a whole network)
4. Confirm that you have permission to scan the target (type y).
5. Choose a speed from 0 to 5 (just press Enter for the default).
6. Wait for the scan to finish. The result is shown and saved automatically.
7. Press Enter to return to the menu.

In the main menu:

• Type H to see your scan history
• Type 0 to exit

🔍 Scan Types Explained

⏱️ Speed Levels

⌨️ Quick Commands (Without the Menu)

If you already know what you want, skip the menu:

nmaping -t 192.168.1.1 -s 2 -T 4

Meaning: scan 192.168.1.1, scan type 2 (Version Detection), speed 4.

More examples:

nmaping -t example.com -s 6 -p 80,443
nmaping -t 192.168.1.0/24 -s 5
nmaping --list

🔑 Scans That Need Root (Linux)

Scans 1, 4, 8, 17, 18, 19 (and some others) need administrator rights. Run:

sudo "$(which nmaping)"

When run with sudo, files are saved in /root/.nmaping/ instead of your own folder.

🔄 How to Update to a New Version

When a new version is released, update with one command.

If you installed with pipx:

pipx upgrade nmaping

If it says nothing changed, force the update:

pipx install --force nmaping

If you installed with pip:

pip install --upgrade --force-reinstall nmaping

(Activate your environment first if you used one: source ~/.nmaping-venv/bin/activate)

The logo shows your current version (v=1.0). Check the GitHub page to see if a newer one is available.

🗑️ How to Uninstall

pipx uninstall nmaping

or, if you used pip:

pip uninstall nmaping

Your saved results stay in ~/.nmaping/. Delete that folder if you want to remove them too.

📁 Where Are My Results?

Each result file is named with the target, scan type, and date/time.

🛠️ Problems and Fixes

⚠️ Legal Notice

Use this tool only on systems you own or have written permission to test. Scanning other people's networks without permission can be illegal and may lead to serious consequences. nmaping asks you to confirm permission before every scan, but you are fully responsible for how you use it.

📜 License

For educational and ethical use only. See LICENSE for details.