You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+28-42Lines changed: 28 additions & 42 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,25 +2,23 @@
2
2
3
3
> **Formerly NetAlert-3.0**
4
4
5
-
YODA is a voice-activated **Intrusion Detection System** designed for real-time LAN monitoring. Built with a hacker-themed dashboard and live network visualization, YODA tracks every device on your networkand provides instant status updates.
5
+
YODA is a voice-activated **Intrusion Detection System** designed for real-time LAN monitoring. The core feature is **voice control** - use natural language commands to manage your network, including kicking devices off your network, querying the number of active devices, and requesting detailed node information. All data is visualized through a hacker-themed dashboard with live network monitoring and Matrix-style effects.
6
6
7
-
**🤖 AI-Powered (Coming Soon)** - We're working on integrating AI for intelligent threat detection and anomaly analysis. Contributions welcome!
7
+
**🤖 AI-Powered (Coming Soon)** - Integrating AI for intelligent threat detection and anomaly analysis. Contributions welcome!
8
8
9
9
---
10
10
11
-
## ✨ Features
11
+
## Features
12
12
13
-
- 🔍 **Real-time device discovery** via ARP scanning
14
-
- 🎨 **Hacker-themed web dashboard** with Matrix effects
15
-
- 📊 **Live monitoring** of IP, MAC, hostname, vendor info
16
-
- 🗣️ **Voice commands** (hold spacebar to activate)
17
-
- 🔴 **Online/Offline tracking** for all network nodes
18
-
- ⚡ **No symlinks required** - data served directly from memory
19
-
- 🌐 **Cross-platform** support (Linux, macOS, Windows)
13
+
- Real-time device discovery via ARP scanning
14
+
- Hacker-themed web dashboard with Matrix effects
15
+
- Live monitoring of IP, MAC, hostname, vendor info
16
+
- Voice commands for network management
17
+
- Online/Offline tracking for all network nodes
20
18
21
19
---
22
20
23
-
## 🚀 Quick Start
21
+
## Quick Start
24
22
25
23
1.**Clone and navigate**
26
24
```bash
@@ -30,20 +28,29 @@ YODA is a voice-activated **Intrusion Detection System** designed for real-time
30
28
2.**Setup virtual environment**
31
29
```bash
32
30
python3 -m venv venv
33
-
source venv/bin/activate# On Windows: venv\Scripts\activate
31
+
source venv/bin/activate
34
32
```
35
33
36
34
3.**Install dependencies**
37
35
```bash
38
36
pip install -r ../requirements.txt
39
37
```
40
38
41
-
4.**Run YODA**
39
+
4.**Install mpg123 (required for voice commands)**
40
+
```bash
41
+
# Debian/Ubuntu
42
+
sudo apt install mpg123
43
+
44
+
# Arch
45
+
sudo pacman -S mpg123
46
+
```
47
+
48
+
5.**Run YODA**
42
49
```bash
43
50
sudo venv/bin/python nsm_main.py
44
51
```
45
52
46
-
5.**Access the dashboard**
53
+
6.**Access the dashboard**
47
54
- The program will prompt you for:
48
55
-**Interface** (e.g., `eth0`, `wlan0`)
49
56
-**Subnet** (e.g., `192.168.1.0/24`)
@@ -52,7 +59,7 @@ YODA is a voice-activated **Intrusion Detection System** designed for real-time
52
59
53
60
---
54
61
55
-
## 🎮 Usage
62
+
## Usage
56
63
57
64
-**Auto-refresh**: Dashboard updates every 2 seconds (configurable)
58
65
-**Search & Filter**: Find nodes by IP, hostname, vendor, or MAC
@@ -62,37 +69,16 @@ YODA is a voice-activated **Intrusion Detection System** designed for real-time
62
69
63
70
---
64
71
65
-
## 🤝 Contributing
72
+
## Contributing
66
73
67
-
Contributions are **welcome**, especially for:
68
-
-🤖 **AI integration** for threat detection
69
-
-🔒 **Automated blocking/prevention** features
70
-
-🎤 **Enhanced voice commands**
71
-
-📡 **Port scanning integration**
74
+
Contributions are welcome, especially for:
75
+
- AI integration for threat detection
76
+
- Automated blocking/prevention features
77
+
- Enhanced voice commands
78
+
- Port scanning integration
72
79
73
80
Submit PRs to [github.com/nsm-barii/netalert-3.0](https://github.com/nsm-barii/netalert-3.0)
74
81
75
82
---
76
83
77
-
## 📋 Requirements
78
-
79
-
- Python 3.x
80
-
- Scapy
81
-
- Rich (for CLI)
82
-
- See `requirements.txt` for full dependencies
83
-
84
-
---
85
-
86
-
## 📁 Project Structure
87
-
88
-
```
89
-
nsm_modules/ # Backend Python modules
90
-
web_modules/ # Frontend (HTML/CSS/JS)
91
-
├── yoda.html # Main dashboard
92
-
├── css/ # Styles
93
-
└── js/ # JavaScript + Matrix effects
94
-
```
95
-
96
-
---
97
-
98
84
**Built by NSM Barii** | [GitHub](https://github.com/nsm-barii/netalert-3.0) | Contributions Welcome
0 commit comments