Skip to content

Commit 790d368

Browse files
Create README.md
1 parent 82543e0 commit 790d368

1 file changed

Lines changed: 59 additions & 0 deletions

File tree

README.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# ⚡ Mesh-Pulse CLI
2+
3+
4+
5+
**A lightweight, TUI-based Network Mesh & System Resource Monitor.**
6+
7+
Mesh-Pulse turns your terminal into a Command Center for your local network — discover peers, monitor system health in real-time, and transfer files securely with AES-256 encryption.
8+
9+
## Features
10+
11+
- **P2P Discovery** — Automatic peer detection via UDP broadcast
12+
- **System Monitoring** — Live CPU, RAM, Disk I/O, and Network metrics
13+
- **Secure File Transfer** — AES-256-GCM encrypted TCP transfers with progress tracking
14+
- **TUI Dashboard** — Beautiful terminal UI with live-updating panels
15+
16+
## Quick Start
17+
18+
```bash
19+
# Install dependencies
20+
pip install -r requirements.txt
21+
22+
# Run the dashboard
23+
python -m mesh_pulse
24+
25+
# Or with options
26+
python -m mesh_pulse --broadcast-port 9999 --transfer-port 10000
27+
```
28+
29+
## Send a File
30+
31+
Press `S` in the dashboard, then enter the peer IP and file path. All transfers are encrypted with AES-256-GCM.
32+
33+
```bash
34+
# Set encryption key (or pass via --key)
35+
set MESH_PULSE_KEY=my-secret-key
36+
python -m mesh_pulse
37+
```
38+
39+
## Architecture
40+
41+
```
42+
mesh_pulse/
43+
├── core/ # P2P discovery, file transfer, system monitor
44+
├── tui/ # Textual dashboard and widgets
45+
└── utils/ # Crypto, config, logging
46+
```
47+
48+
## Keyboard Shortcuts
49+
50+
| Key | Action |
51+
|-----|--------|
52+
| `Q` | Quit |
53+
| `S` | Send file to a peer |
54+
| `R` | Force refresh metrics |
55+
| `T` | Toggle dark/light theme |
56+
57+
## License
58+
59+
MIT

0 commit comments

Comments
 (0)