Skip to content
This repository was archived by the owner on Feb 6, 2026. It is now read-only.

Commit e76b84c

Browse files
authored
Update README.md
1 parent 7e1d962 commit e76b84c

1 file changed

Lines changed: 49 additions & 54 deletions

File tree

README.md

Lines changed: 49 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1,97 +1,92 @@
1-
# 🚀 IP Scanner Tool
2-
***version 1.0.1***
3-
![image](https://github.com/user-attachments/assets/abfdc378-9b38-4bd4-9a3d-67580176ca91)
1+
# 🚀 IP Scanner Pro
42

5-
Welcome to the IP Scanner Tool! This handy Bash script lets you uncover detailed information about any IPv4 or IPv6 address with ease. Whether you're a network administrator, a security enthusiast, or just curious about IPs, this tool has got you covered!
3+
![GitHub CI](https://github.com/trmxvibs/IPScanPro/actions/workflows/ci.yml/badge.svg)
4+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
5+
![Version](https://img.shields.io/badge/Version-1.1.0-blue.svg)
6+
![Made with](https://img.shields.io/badge/Made%20with-Bash-1f425f.svg)
7+
![Platforms](https://img.shields.io/badge/Platform-Termux%20%7C%20Linux%20%7C%20macOS-lightgrey.svg)
68

7-
# 🛠 Features
9+
Welcome to IP Scanner Pro! This handy Bash script lets you uncover detailed information about any IPv4 or IPv6 address with ease. It's built for security, portability, and power.
810

9-
**🔍 IP Address Details:** Get comprehensive information about IP addresses, including location, organization, timezone, and more.
1011

11-
**⚙️ Easy Updates & Removal:** Easily update or remove the tool with built-in options.
12+
---
1213

13-
**💾 Save Results:** Automatically save your scan results to neatly organized files in your home directory.
14+
## Features
1415

16+
* **Multi-OS Support:** A smart installer that works on Termux, Debian (Kali, Ubuntu), Arch, Fedora, and macOS.
17+
* **IP Details:** Get comprehensive info: location, organization, timezone, and more.
1518

1619

20+
## 💻 Supported Operating Systems
21+
The installer will automatically detect and work on:
1722

23+
- `Termux (Android)`
1824

25+
- `Debian-based Linux (Ubuntu, Kali Linux, Parrot OS)`
1926

20-
# 📥 Installation
21-
Prepare Your System:
27+
- `Arch-based Linux (Manjaro, Garuda)`
2228

23-
Ensure you have `figlet` and `Python3` with the `requests` module installed. You can install them with the following commands:
29+
- `Fedora-based Linux`
2430

31+
- `macOS (using Homebrew)`
32+
33+
34+
## Installation
35+
36+
The smart installer handles all dependencies (like `python`, `jq`, `figlet`, `nmap`) for you.
37+
38+
39+
## 1. Clone the repository
2540
```bash
26-
pkg install -y git python python2 jq python3 && pkg install figlet -y && pip3 install requests lolcat
41+
git clone https://github.com/trmxvibs/IPScanPro
2742
```
43+
## 2. Navigate into the directory
2844
```bash
29-
git clone https://github.com/trmxvibs/IPScanPro && cd IPScanPro
45+
cd IPScanPro
3046
```
31-
**Make the Script Executable:**
47+
48+
## 3. Make the installer executable
3249
```bash
3350
chmod +x install.sh
3451
```
35-
**Run the Script:**
52+
53+
## 4. Run the installer (use sudo if on Linux/macOS)
3654
```bash
3755
./install.sh
3856
```
39-
# *OR*
40-
```
41-
bash install.sh
57+
## or for Linux/macOS:
58+
```bash
59+
sudo ./install.sh
4260
```
43-
![image](https://github.com/user-attachments/assets/569e045b-d0a2-49f6-bd10-fb95039f6f37)
44-
61+
- After installation, restart your terminal and run the tool from anywhere using the ip command.
4562

63+
# Important: API Key Setup
64+
- ***This tool uses the ipinfo.io API, which requires a free access token.***
4665

66+
- Go to [ipinfo](https://ipinfo.io/signup) to get your free API token.
4767

48-
# 🛠 Usage
68+
- Run the install.sh script. It will automatically ask you to paste your token.
4969

50-
**🔍 Scan IPv4/IPv6:** Enter an IP address to fetch its details.
70+
- Your token is saved securely in $HOME/.config/ipscanner/config.
5171

52-
**⬆️ Update Tool:** Simulate an update process with a visual progress bar.
53-
54-
**🗑 Remove Tool:** Completely remove the tool from your system.
55-
56-
**❌ Exit:** Close the script.
57-
58-
# 🎨 Screenshot
59-
Here’s a sneak peek of the IP Scanner Tool in action:
60-
61-
![image](https://github.com/user-attachments/assets/0f8255b1-67b6-4dae-af4e-a4d0ec628f7c)
62-
63-
64-
65-
📚 Example Output
66-
When you scan an IP, you'll see detailed information like this:
67-
68-
```bash
72+
- The tool will not work without this token.
73+
## Example Output
74+
```python
6975
--- IP Address Details ---
7076
IP Address: 8.8.8.8
7177
Hostname: dns.google
7278
City: Mountain View
7379
Region: California
7480
Country: US
75-
Location: 37.4056,-122.0775
76-
Organization: Google LLC
81+
Location: 37.4056,-22.0775
82+
Organization: AS15169 Google LLC
7783
Postal Code: 94043
7884
Timezone: America/Los_Angeles
79-
Anycast: No
80-
Carrier: N/A
81-
Internet ID: AS15169
8285
----------------------------
86+
Details saved to: /home/user/IP_Scanner_Results/8.8.8.8_Report.txt
8387
```
8488

85-
# 🚀 How to Contribute
86-
Feel free to fork the repository and submit pull requests! If you find any bugs or have feature requests, open an issue to let us know.
87-
88-
# 📜 License
89-
This script is provided as-is. No warranties or guarantees are provided. Use at your own risk.
9089

91-
# 👨‍💻 Author
92-
**Lokesh Kumar**
93-
[GitHub Profile](https://github.com/trmxvibs)
9490

9591

96-
# My other videos on Youtube
97-
[![WhatsApp Hacking](https://img.youtube.com/vi/jfPqGalt5CQ/maxresdefault.jpg)](https://youtu.be/jfPqGalt5CQ?si=IBOvM3iOB8-03ccd)
92+

0 commit comments

Comments
 (0)