User and developer documentation for NetSweep 5.2.x.
Start with the project README for a short overview, then use the guides below.
| Document | Audience | Description |
|---|---|---|
| Installation | Everyone | Python env, pip install, optional Scapy, OS tools |
| Quick start | Operators | First LAN and host scans |
| CLI reference | Operators | All entrypoints and flags |
| Configuration | Operators / admins | ~/.netsweep/config.json, security limits |
| Library API | Developers | Embed scanners in Python code |
| Architecture | Developers | Package layout, layers, shims |
| Scanning deep dive | Operators / researchers | LAN, host, ports, services, SADP |
| Security | Everyone | Authorized use, hardening, secrets |
| Performance | Operators | Threads, FD budget, large CIDRs |
| Testing | Contributors | pytest, coverage, writing tests |
| Experimental tools | Advanced | SADP, netscan.sh |
| FAQ | Everyone | Common questions |
| Contributing | Contributors | Issues, PRs, code style |
- CHANGELOG.md — version history
- SECURITY.md — vulnerability disclosure
- LICENSE — MIT
Documentation targets NetSweep 5.2.0 (package-first layout). Behavior from 5.0.x hardening still applies; see the changelog for details.