About
About Shumoku
What is Shumoku
Shumoku is an open-source library for defining network diagrams in YAML/JSON and outputting them as SVG/HTML/PNG.
It aims to help network engineers easily create and manage network diagrams within documentation.
Features
- Text-based — Define networks in YAML. Easy version control and diff review with Git
- Auto layout — Custom hierarchical layout engine purpose-built for network diagrams
- Vendor icons — 900+ icons including Yamaha, Aruba, AWS, Juniper
- Interactive — HTML output with pan/zoom, tooltips, hierarchical navigation
- System integration — Auto-generation from NetBox or custom APIs
Origin of the Name
The name comes from the hanshō (bell) in a Japanese tea room: the stick used to strike the bell is called a shumoku (撞木), and the hook that quietly holds the shumoku is a shumoku-kugi. Just as the hook supports the striker, shumoku aims to be the quiet starting point that supports network operations. See the full story of the name and logo.
License
GNU Affero General Public License v3.0 (AGPL-3.0)