# Rustsploit Wiki

Welcome to the Rustsploit documentation hub. Use the links below to navigate to the relevant guide.

> ⚠️ Rustsploit is intended for **authorized security testing and research only**. Always obtain explicit written permission before targeting any system you do not own.

---

## 📖 Documentation Index

| Document | Description |
|----------|-------------|
| [Getting Started](Getting-Started.md) | Installation, build, quick-start, Docker deployment |
| [Interactive Shell](Interactive-Shell.md) | Shell walkthrough, command palette, chaining, shortcuts |
| [CLI Reference](CLI-Reference.md) | Command-line flags, non-shell usage, output formats |
| [API Server](API-Server.md) | WebSocket API, PQ encryption, endpoints, rate limiting |
| [API Usage Examples](API-Usage-Examples.md) | Practical curl workflows, request/response samples |
| [Module Catalog](Module-Catalog.md) | All 240 modules by category — 183 exploits, 27 scanners, 29 creds, 1 plugin |
| [Module Development](Module-Development.md) | How to author new modules, lifecycle, dispatcher |
| [Security & Validation](Security-Validation.md) | Input validation constants, security patterns, honeypot detection |
| [Credential Modules Guide](Credential-Modules-Guide.md) | Best practices for 29 cred modules — mass scan, cfg_prompt_*, concurrency |
| [Exploit Modules Guide](Exploit-Modules-Guide.md) | Best practices for 183 exploit modules — multi-target, cfg_prompt_*, validation |
| [Utilities & Helpers](Utilities-Helpers.md) | `utils.rs` public API, target normalization, honeypot check |
| [Testing & QA](Testing-QA.md) | Build checks (0 errors, 0 warnings), smoke tests, wordlist validation |
| [Changelog](Changelog.md) | Release notes and version history (current: v0.4.8) |
| [Contributing](Contributing.md) | Fork guide, PR checklist, code style |
| [Credits](Credits.md) | Authors, acknowledgements, legal notice |
| [Future Features](Future-Features.md) | Roadmap and completed features (plugins, metadata, global options, etc.) |
| [About Me](About-Me.md) | Information about the author |
| [Donation](Donation.md) | Ways to support the project |

---

## Quick Navigation

- **New user?** → Start with [Getting Started](Getting-Started.md)
- **Writing a module?** → See [Module Development](Module-Development.md)
- **Using the API?** → See [API Server](API-Server.md) + [API Usage Examples](API-Usage-Examples.md)
- **Running from CLI?** → See [CLI Reference](CLI-Reference.md)