Shumoku Docs

Search documentation

Shared docs and current release

Loading search…

日本語

examples/README.md

Examples

Runnable topology YAML files and a sample data-source plugin.

Sample NetworkGraph YAML files and a sample plugin. Render any of them with the CLI:

npx shumoku render examples/full-featured.yaml -o diagram.svg
FileShows
full-featured.yamlA broad feature showcase
device-status.yamlPer-device status visualization
enterprise-ogp.yamlA realistic enterprise network
location-based.yamlGrouping nodes by location
prefix-subgraph.yamlGrouping by IP prefix / subnet
netbox-enhanced.yamlA NetBox-derived topology

sample-plugin/ is a minimal external data-source plugin (sample-hosts) — see its README.

See the YAML Reference for the full format.