Network Playbook

Network documentation that survives a move: scan and probe a home network, then keep a printable rebuild playbook (Typst PDF) and an agent-readable JSON definition.

About This Project

Network-Playbook is a tool designed to generate comprehensive infrastructure documentation, enabling users to rebuild a complex home network after a relocation. By maintaining a single JSON definition, the project produces both a human-readable Typst PDF playbook for manual assembly and a machine-readable JSON format for automated recovery agents. It functions by probing network infrastructure, performing ARP and mDNS scans, and documenting hardware layouts and cable schedules.

The project draws from professional standards including TIA-606 labeling and aviation-style checklists to ensure a reliable reconstitution process. It is intended for power users and systems administrators who require a structured, documented approach to managing home network topology, DHCP reservations, and remote access configurations. The tool prioritizes security by excluding sensitive credentials from the documentation files, instead referencing their external storage locations.

Project Details

Explore More Projects