Skip to content

Commit 482b320

Browse files
fix(docs): apply only required PR review fixes
Fix badges, trim TOC to existing sections, use working logo URLs, and split Quick Install into Option A/B. Drop the earlier extra rewrite. Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent f4eebd4 commit 482b320

6 files changed

Lines changed: 36 additions & 325 deletions

File tree

README.md

Lines changed: 36 additions & 196 deletions
Original file line numberDiff line numberDiff line change
@@ -1,271 +1,111 @@
11
# Kali-Linux-for-Android — Kali Magic 🎩🔐
22

3-
> Transform your Android device into a **portable cybersecurity playground** — run Kali / NetHunter tools on Android (Termux / LinuxDroid integration).
3+
> Transform your Android device into a **portable cybersecurity playground** — run Kali / NetHunter tools on Android (Termux / LinuxDroid integration). 🚀💻📱
44
55
[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
66
[![Releases](https://img.shields.io/github/v/release/AryanVBW/Kali-Linux-for-Android)](https://github.com/AryanVBW/Kali-Linux-for-Android/releases)
77
[![Downloads](https://img.shields.io/github/downloads/AryanVBW/Kali-Linux-for-Android/total)](https://github.com/AryanVBW/Kali-Linux-for-Android/releases)
88

9-
<p align="center">
10-
<a href="https://github.com/AryanVBW/LinuxDroid">
11-
<img src="https://github.com/AryanVBW/ParrotSecurityOsForAndroid/releases/download/Gif/visithere.gif" alt="Visit LinuxDroid" width="520">
12-
</a>
13-
</p>
14-
159
---
1610

1711
## 📖 Table of Contents
1812

19-
- [About](#about)
20-
- [Supported Operating Systems](#supported-operating-systems)
21-
- [Features](#features)
22-
- [Prerequisites](#prerequisites)
13+
- [About](#about)
14+
- [Supported Operating Systems](#supported-operating-systems)
15+
- [Features](#features)
16+
- [Prerequisites](#prerequisites)
2317
- [Quick Install](#quick-install)
24-
- [Manual Installation](#manual-installation)
25-
- [Kali NetHunter (Rootless)](#kali-nethunter-rootless)
26-
- [Visual Demos](#visual-demos)
27-
- [Nmap](#nmap)
28-
- [Metasploit](#metasploit)
29-
- [Wireshark](#wireshark)
30-
- [Installer Walkthrough](#installer-walkthrough)
31-
- [Usage Examples](#usage-examples)
32-
- [Installation Link](#installation-link)
33-
- [Security and Legal Notice](#security-and-legal-notice)
34-
- [Contributing and Support](#contributing-and-support)
35-
- [Credits and License](#credits-and-license)
3618

3719
---
3820

3921
## 🧠 About
4022

41-
**Kali Magic** lets you experience **Kali Linux / Parrot OS / NetHunter** tools right on Android — perfect for **students, researchers, and ethical hackers** learning on the go.
23+
**Kali Magic** lets you experience **Kali Linux / Parrot OS / NetHunter** tools right on Android — perfect for **students, researchers, and ethical hackers** learning on the go.
24+
25+
Run full penetration-testing environments inside **Termux + LinuxDroid**.
26+
It’s portable, rootless, and visually documented with live demos.
4227

43-
Run full penetration-testing environments inside **Termux + LinuxDroid**. It is portable, rootless, and documented with clear install paths and usage examples.
28+
[![Visit LinuxDroid](https://github.com/AryanVBW/ParrotSecurityOsForAndroid/releases/download/Gif/visithere.gif)](https://github.com/AryanVBW/LinuxDroid)
4429

4530
---
4631

4732
## 🐧 Supported Operating Systems
4833

4934
| OS | Version | Description | Logo |
5035
|----|---------|-------------|------|
51-
| **Kali Linux** | Rolling | Advanced penetration testing and security distro. | <img src="assets/gifs/kali-logo.svg" alt="Kali Logo" width="48"> |
52-
| **Parrot Security OS** | Rolling | Forensics, pen-testing, privacy, and developer tools. | <img src="assets/gifs/parrot-logo.svg" alt="Parrot Logo" width="48"> |
53-
| **Ubuntu** | 20.04+ | General-purpose Linux for development and scripting. | <img src="assets/gifs/ubuntu-logo.svg" alt="Ubuntu Logo" width="48"> |
54-
| **Debian** | 11+ | Stable, server-ready Linux distribution. | <img src="assets/gifs/debian-logo.svg" alt="Debian Logo" width="48"> |
36+
| **Kali Linux** | Rolling | Advanced penetration testing & security distro. | <img src="https://www.kali.org/images/kali-logo.svg" alt="Kali Logo" width="40"> |
37+
| **Parrot Security OS** | Rolling | Forensics, pen-testing, privacy & dev tools. | <img src="https://cdn.jsdelivr.net/gh/simple-icons/simple-icons/icons/parrotsecurity.svg" alt="Parrot Logo" width="40"> |
38+
| **Ubuntu** | 20.04+ | General-purpose Linux for dev & scripting. | <img src="https://assets.ubuntu.com/v1/ce518a18-CoF-2022_solid+O.svg" alt="Ubuntu Logo" width="40"> |
39+
| **Debian** | 11+ | Stable, server-ready Linux distribution. | <img src="https://www.debian.org/logos/openlogo-nd.svg" alt="Debian Logo" width="40"> |
5540

5641
---
5742

5843
## 🌟 Features
5944

60-
- Mobile-optimized environment for Kali / NetHunter tools
61-
- Run powerful pentest tools inside Termux / proot (rootless)
62-
- Quick installer with two clear install paths
63-
- Copy-paste-ready commands for common tools
64-
- Safe for educational and ethical security labs
45+
- Mobile-optimized environment for Kali / NetHunter tools.
46+
- Run powerful pentest tools inside Termux/proot (rootless).
47+
- Quick installer + visual setup walkthrough.
48+
- Lightweight GIF demos and prebuilt commands.
49+
- Safe for educational / ethical security labs.
6550

6651
---
6752

6853
## ⚙️ Prerequisites
6954

70-
- Android 7.0+
71-
- [Termux](https://f-droid.org/packages/com.termux/) (from F-Droid)
72-
- `termux-setup-storage` permission granted
73-
- Disk: ~38 GB free space
74-
- (Optional) Root access for Wi-Fi injection or OTG tools
55+
- Android 7.0+
56+
- Termux (from F-Droid)
57+
- `termux-setup-storage` permission granted
58+
- Disk: ~3-8 GB free space
59+
- (Optional) Root access for Wi-Fi injection or OTG tools
7560

76-
> Always inspect scripts before running:
61+
> 💡 Always inspect scripts before running:
7762
> ```bash
78-
> cat install-nethunter-termux
63+
> cat install.sh
7964
> ```
8065
8166
---
8267
8368
## 🚀 Quick Install
8469
85-
Choose **one** path below — do not run both.
86-
87-
### Option A: Direct Termux (NetHunter Rootless)
88-
89-
Best for a quick Kali NetHunter rootless setup inside Termux.
70+
### Option A: Direct Termux
9071
9172
```bash
9273
pkg update && pkg upgrade -y
9374
pkg install wget curl proot -y
9475
95-
# Download and run Kali NetHunter installer
76+
# Download & run Kali NetHunter installer
9677
wget -O install-nethunter-termux https://offs.ec/2MceZWr
9778
chmod +x install-nethunter-termux
9879
./install-nethunter-termux
9980
100-
# Optional: LinuxDroid menu helpers
101-
wget https://raw.githubusercontent.com/AryanVBW/LinuxDroid/main/Scripts/menu.sh
102-
chmod +x menu.sh
81+
# Optional extras (LinuxDroid)
82+
wget https://raw.githubusercontent.com/AryanVBW/LinuxDroid/main/Scripts/menu.sh && chmod +x menu.sh
10383
104-
# Optional: bash presets
105-
cp ~/.bashrc ~/.bashrc.backup 2>/dev/null || true
84+
# Optional bash presets
85+
cp ~/.bashrc ~/.bashrc.backup || true
10686
wget https://raw.githubusercontent.com/AryanVBW/LinuxDroid/main/Scripts/default.bashrc -O ~/.bashrc
10787
108-
# Start GUI (after install completes)
88+
# Start GUI
10989
nethunter kex &
11090
./menu.sh
11191
```
11292
11393
### Option B: Debian via proot-distro
11494

115-
Best if you want a full Debian container, then install Kali tools inside it.
116-
11795
```bash
118-
pkg update && pkg upgrade -y
119-
pkg install wget curl proot-distro -y
120-
96+
pkg install proot-distro
12197
proot-distro list
12298
proot-distro install debian
12399
proot-distro login debian
124100
```
125101

126-
Inside the Debian container:
102+
Inside Debian:
127103

128104
```bash
129105
apt update && apt upgrade -y
130106
apt install kali-tools-top10 -y
131-
132-
# Optional: NetHunter-style tooling inside the container
133107
wget -O install-nethunter-termux https://offs.ec/2MceZWr
134108
chmod +x install-nethunter-termux
135109
./install-nethunter-termux
110+
nethunter kex &
136111
```
137-
138-
---
139-
140-
## 🛠️ Manual Installation
141-
142-
1. Install Termux from F-Droid (not Play Store).
143-
2. Open Termux and grant storage access:
144-
```bash
145-
termux-setup-storage
146-
```
147-
3. Follow **Option A** or **Option B** in [Quick Install](#quick-install).
148-
4. For a multi-distro Android Linux experience, use [LinuxDroid](https://github.com/AryanVBW/LinuxDroid).
149-
150-
---
151-
152-
## 🐉 Kali NetHunter (Rootless)
153-
154-
Kali NetHunter Rootless runs on stock, unrooted Android via Termux. It is based on Kali Linux and provides a mobile penetration-testing platform for learning and research.
155-
156-
With NetHunter Rootless you can:
157-
158-
- Practice ethical hacking and security research on Android
159-
- Use common Kali tools in a portable environment
160-
- Learn without requiring a rooted device
161-
162-
After installation:
163-
164-
```bash
165-
nethunter # enter NetHunter CLI
166-
nethunter kex & # start KeX GUI session (if configured)
167-
```
168-
169-
Official guide: [Kali NetHunter Rootless](https://www.kali.org/docs/nethunter/nethunter-rootless/)
170-
171-
---
172-
173-
## 🎬 Visual Demos
174-
175-
### Nmap
176-
177-
Scan a local subnet (replace with a network you own or have permission to test):
178-
179-
```bash
180-
nmap -sS 192.168.1.0/24
181-
nmap -A 192.168.1.1
182-
```
183-
184-
### Metasploit
185-
186-
```bash
187-
msfconsole
188-
```
189-
190-
### Wireshark
191-
192-
On devices with GUI / KeX support:
193-
194-
```bash
195-
wireshark
196-
# or capture from CLI
197-
tshark -i any -c 50
198-
```
199-
200-
### Installer Walkthrough
201-
202-
1. Update Termux packages
203-
2. Run the NetHunter installer (**Option A**) or set up Debian (**Option B**)
204-
3. Launch `nethunter` / `menu.sh`
205-
4. Install tools as needed (`nmap`, `metasploit-framework`, etc.)
206-
207-
<p align="center">
208-
<a href="https://github.com/AryanVBW/LinuxDroid">
209-
<img src="https://github.com/AryanVBW/ParrotSecurityOsForAndroid/releases/download/Gif/visithere.gif" alt="Installer walkthrough" width="480">
210-
</a>
211-
</p>
212-
213-
---
214-
215-
## 💡 Usage Examples
216-
217-
```bash
218-
# List tools (Debian / Kali container)
219-
ls /usr/share/
220-
221-
# Network discovery (authorized networks only)
222-
nmap -sn 192.168.1.0/24
223-
224-
# Start Metasploit
225-
msfconsole
226-
227-
# LinuxDroid helper menu (if installed)
228-
./menu.sh
229-
```
230-
231-
---
232-
233-
## 🔗 Installation Link
234-
235-
Primary project for multi-OS Android Linux installs:
236-
237-
**[LinuxDroid](https://github.com/AryanVBW/LinuxDroid)** — install Kali, Parrot, Ubuntu, Debian, and more on Android.
238-
239-
This repository focuses on the Kali / NetHunter experience. For the full LinuxDroid installer and OS list, use the link above.
240-
241-
---
242-
243-
## ⚠️ Security and Legal Notice
244-
245-
Use these tools **only** on systems and networks you own or have explicit permission to test.
246-
247-
Unauthorized access, scanning, or exploitation of systems is illegal. The authors and contributors are not responsible for misuse. This project is intended for education, research, and ethical security practice.
248-
249-
---
250-
251-
## 🤝 Contributing and Support
252-
253-
- Report issues, suggest enhancements, or open pull requests
254-
- Keep documentation clear and commands copy-paste ready
255-
- For maintainer GIF optimization:
256-
257-
```bash
258-
./scripts/optimize_gifs.sh 640 15
259-
```
260-
261-
See [`scripts/optimize_gifs.sh`](scripts/optimize_gifs.sh) for details.
262-
263-
---
264-
265-
## 📜 Credits and License
266-
267-
- [Kali Linux / Offensive Security](https://www.kali.org/)
268-
- [LinuxDroid](https://github.com/AryanVBW/LinuxDroid) by [AryanVBW](https://github.com/AryanVBW)
269-
- Community contributors
270-
271-
Licensed under the terms of this repository. See the project license for details.

assets/gifs/debian-logo.svg

Lines changed: 0 additions & 86 deletions
This file was deleted.

assets/gifs/kali-logo.svg

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)