# Examples

Canonical: https://docs.shumoku.dev/en/library/examples
Language: en

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
```

| File | Shows |
| --- | --- |
| [`full-featured.yaml`](https://github.com/konoe-akitoshi/shumoku/blob/73ebc72ba0bc0d1caf74e1ed34c89a6debcb0e6a/examples/full-featured.yaml) | A broad feature showcase |
| [`device-status.yaml`](https://github.com/konoe-akitoshi/shumoku/blob/73ebc72ba0bc0d1caf74e1ed34c89a6debcb0e6a/examples/device-status.yaml) | Per-device status visualization |
| [`enterprise-ogp.yaml`](https://github.com/konoe-akitoshi/shumoku/blob/73ebc72ba0bc0d1caf74e1ed34c89a6debcb0e6a/examples/enterprise-ogp.yaml) | A realistic enterprise network |
| [`location-based.yaml`](https://github.com/konoe-akitoshi/shumoku/blob/73ebc72ba0bc0d1caf74e1ed34c89a6debcb0e6a/examples/location-based.yaml) | Grouping nodes by location |
| [`prefix-subgraph.yaml`](https://github.com/konoe-akitoshi/shumoku/blob/73ebc72ba0bc0d1caf74e1ed34c89a6debcb0e6a/examples/prefix-subgraph.yaml) | Grouping by IP prefix / subnet |
| [`netbox-enhanced.yaml`](https://github.com/konoe-akitoshi/shumoku/blob/73ebc72ba0bc0d1caf74e1ed34c89a6debcb0e6a/examples/netbox-enhanced.yaml) | A NetBox-derived topology |

[`sample-plugin/`](https://github.com/konoe-akitoshi/shumoku/blob/73ebc72ba0bc0d1caf74e1ed34c89a6debcb0e6a/examples/sample-plugin) is a minimal external data-source plugin (`sample-hosts`) — see its [README](https://github.com/konoe-akitoshi/shumoku/blob/73ebc72ba0bc0d1caf74e1ed34c89a6debcb0e6a/examples/sample-plugin/README.md).

See the [YAML Reference](https://www.shumoku.dev/docs/npm/yaml-reference) for the full format.