Skip to content

Commit 3033fb7

Browse files
committed
Add auto PDF reports + Reacher Dashboard to README
1 parent 108ec86 commit 3033fb7

1 file changed

Lines changed: 51 additions & 0 deletions

File tree

README.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -328,6 +328,57 @@ Pure Rust. Single binary. No Node.js, no Python runtime, no garbage collection.
328328

329329
---
330330

331+
## Auto PDF Reports
332+
333+
When HackCode detects a security audit in its output — vulnerability scans, threat assessments, penetration test results — it **automatically generates a PDF report** and saves it to your current directory.
334+
335+
```
336+
> scan this project for security vulnerabilities
337+
338+
▶ bash $ grep -rn "password|secret|token" ...
339+
...
340+
341+
HACKCODE SECURITY AUDIT REPORT
342+
┌───────────────┬───────────┬──────────────────────────────┐
343+
│ Category │ Severity │ Finding │
344+
├───────────────┼───────────┼──────────────────────────────┤
345+
│ Auth │ ✅ LOW │ No hardcoded API keys │
346+
│ OAuth │ ⚠️ MEDIUM│ Cleartext token storage │
347+
│ Endpoints │ ⚠️ MEDIUM│ API URLs exposed in source │
348+
└───────────────┴───────────┴──────────────────────────────┘
349+
350+
✔ Execution complete
351+
352+
[HackCode] Security report saved → ./hackcode-report-2026-04-13-143022.pdf
353+
```
354+
355+
No extra commands. No flags. It just knows when you ran an audit and drops a clean PDF. Hand it to a client, attach it to a ticket.
356+
357+
---
358+
359+
## Reacher Dashboard
360+
361+
HackCode ships with [Reacher Dashboard](https://github.com/itwizardo/reacher-dashboard) — a self-hosted email verification UI powered by the open-source [Reacher](https://github.com/reacherhq/check-if-email-exists) API.
362+
363+
Verify emails before they hit your mailing list. Catch invalid, disposable, and risky addresses. Export clean lists as CSV.
364+
365+
- **Bulk verification** — drag-drop a CSV, verify thousands of emails
366+
- **5x parallel** — verifies 5 emails at once
367+
- **Filter tabs** — All / Safe / Risky / Invalid / Unknown
368+
- **Separate exports** — export only safe emails, only invalid, or all
369+
- **Self-hosted** — runs on your own server, no third-party SaaS
370+
- **Single HTML file** — zero dependencies, works offline
371+
372+
```bash
373+
# Deploy on any VPS
374+
git clone https://github.com/itwizardo/reacher-dashboard.git
375+
cd reacher-dashboard && docker-compose up -d
376+
```
377+
378+
Open `http://your-server-ip` and start verifying.
379+
380+
---
381+
331382
## Self-Updating
332383

333384
HackCode checks for updates on startup. When a new version is available:

0 commit comments

Comments
 (0)