marrow-cli
v0.1.0
Published
Compile network-topology YAML into self-contained, offline, interactive HTML diagrams. You declare structure; the engine computes the layout.
Maintainers
Readme
marrow-cli
Compile network-topology YAML into a single self-contained, offline, interactive HTML diagram. You declare structure — the engine computes the layout.
npm i -g marrow-cli
marrow validate net.yaml # schema + reference check
marrow build net.yaml # → net.html (one file, works offline)
marrow icons search switch # find real vendor icon idsA minimal topology:
marrow: 2
name: Small Office
devices:
- { id: edge, icon: cisco/routers/router, tier: edge }
- { id: core, icon: cisco/switches/layer-3-switch, tier: core }
- { id: acc, icon: cisco/switches/workgroup-switch, tier: access }
links:
- { from: edge, to: core, speed: 10G }
- { from: core, to: acc, mode: trunk, vlans: "10,20,30" }Commands
| Command | Purpose |
| --- | --- |
| marrow validate <file...> | Schema + reference check (exit 1 on errors) |
| marrow build <file> [-o OUT] | Compile to HTML; auto-splits into a site above ~150 devices |
| marrow serve <file-or-dir> | Live-reload preview server |
| marrow snapshot <file> [-o OUT.png] | Render to PNG (needs npm i -D playwright && npx playwright install chromium) |
| marrow icons search <keyword> | Find icon ids |
| marrow icons fetch [pack...] | Install the aws/azure/gcp packs from the vendors |
| marrow import <v1-file> | Convert legacy v1 YAML |
| marrow schema | Emit the JSON Schema |
Bundled icon packs: cisco, affinity, generic, k8s (~2,000 icons). The
aws / azure / gcp packs are fetched on demand with marrow icons fetch
(vendor terms forbid redistribution).
Full documentation: https://marrow-docs.vercel.app
MIT © Marrow
