Skip to content

Commit b06ce82

Browse files
committed
1.1.5
0 parents  commit b06ce82

File tree

15 files changed

+611
-0
lines changed

15 files changed

+611
-0
lines changed

β€Ž.gitignoreβ€Ž

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
node_modules/
2+
engines.dat
3+
dist/
4+
.env

β€ŽCHANGELOG.mdβ€Ž

Whitespace-only changes.

β€ŽCONTRIBUTING.mdβ€Ž

Whitespace-only changes.

β€ŽLICENSEβ€Ž

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 0xGrayy
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

β€ŽREADME.mdβ€Ž

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
# πŸ•΅οΈβ™‚οΈ Malware Sniffer Β· [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
2+
3+
_A cybersecurity companion that sniffs out suspicious URLs with style_ πŸ”βœ¨
4+
5+
<div align="center">
6+
<img src="./assets/demo.gif" alt="Animated demo showing scanning process" width="800">
7+
<p><em>Watch Malware Sniffer in action – from scanning to detailed report</em></p>
8+
</div>
9+
10+
## 🌟 Why Malware Sniffer?
11+
12+
In today's digital jungle, every click matters. Malware Sniffer is your trusty sidekick that:
13+
14+
βœ… **Instant Safety Check**: Scan any URL against 70+ security engines in real-time
15+
βœ… **Beautiful Reports**: Get clear, color-coded results with emoji storytelling
16+
βœ… **Developer Friendly**: Perfect for integrating into your security workflows
17+
βœ… **Zero Hassle**: Set up in 2 minutes with automatic progress tracking
18+
19+
## πŸš€ Getting Started
20+
21+
### πŸ“¦ Installation
22+
23+
```bash
24+
git clone https://github.com/0xGrayy/malwareSniffer.git
25+
cd malwareSniffer
26+
npm install
27+
```
28+
29+
### πŸ” Configuration
30+
31+
1. Get your free API key from [VirusTotal](https://www.virustotal.com)
32+
2. Create `.env` file:
33+
34+
```env
35+
VIRUSTOTAL_API_KEY=your_actual_key_here
36+
```
37+
38+
### πŸ•ΉοΈ Quick Start
39+
40+
```typescript
41+
import { scanUrl } from "./virusTotal";
42+
43+
// Be the cybersecurity hero your app needs 🦸
44+
scanUrl("https://your-url-here.com");
45+
```
46+
47+
## πŸ“Š What You'll See
48+
49+
![Sample Scan Output](./assets/image-2.png)
50+
_Real scan results showing safety breakdown and detection details_
51+
52+
## πŸ› οΈ Tech Stack
53+
54+
- **`axios`** β†’ Smooth API communication
55+
- **`chalk`** β†’ Terminal colors
56+
- **`cli-progress`** β†’ That satisfying progress bar
57+
- **`figlet`** β†’ Fancy ASCII art headers
58+
- **`moment`** β†’ Precision timing metrics
59+
60+
## πŸ–ŒοΈ Feature Highlights
61+
62+
### 🎨 Visual Progress Tracking
63+
64+
![Progress Bar Demo](./assets/image-1.png)
65+
_Watch the scan unfold with live ETA updates_
66+
67+
### πŸ” Deep Analysis
68+
69+
```markdown
70+
πŸ“Œ Google Safebrowsing β†’ πŸ›‘ Malicious (blacklist)
71+
πŸ“Œ CRDF β†’ ⚠️ Suspicious (heuristic)
72+
πŸ“Œ Quttera β†’ βœ… Harmless (signature)
73+
```
74+
75+
### πŸ“ˆ Safety at a Glance
76+
77+
```
78+
Safety Score: 92% 🟩🟩🟩🟩🟩🟩🟩🟩🟩πŸŸ₯
79+
```
80+
81+
## 🀝 Join the Security Squad
82+
83+
We welcome contributors! Here's how to help:
84+
85+
1. πŸ› **Report bugs** – Help us squash them!
86+
2. πŸ’‘ **Suggest features** – What's missing?
87+
3. πŸ“– **Improve docs** – Make things clearer
88+
4. πŸ§ͺ **Write tests** – Keep things reliable
89+
90+
**First time contributing?** Check our [contribution guide](CONTRIBUTING.md)!
91+
92+
## ⚠️ Important Notes
93+
94+
- This tool **doesn't guarantee 100% safety** – always practice defense-in-depth
95+
- API rate limits apply – be kind to VirusTotal's servers
96+
- Keep your API key secret – treat it like your WiFi password πŸ”‘
97+
98+
## πŸ“œ License
99+
100+
MIT Licensed - Go build something secure! πŸ›‘οΈ
101+
102+
---
103+
104+
Made with ❀️ by [0xGrayy] · [Report Issue](https://github.com/0xGrayy/malwareSniffer/issues)

β€Žassets/image-1.pngβ€Ž

88 KB
Loading

β€Žassets/image-2.pngβ€Ž

227 KB
Loading

β€Žassets/image-3.pngβ€Ž

336 KB
Loading

β€Žassets/image-4.pngβ€Ž

304 KB
Loading

0 commit comments

Comments
Β (0)