Shumoku Docs

Search documentation

Shared docs and current release

Loading search…

日本語

@shumoku/cli · 0.2.28 · command

shumoku render [options] <input>

Command source

Render NetworkGraph YAML/JSON to SVG/HTML/PNG

Input

<input> — NetworkGraph YAML or JSON file (use - for stdin) Format auto-detected from extension (.yaml, .yml, .json)

Options

Option Description Values Default
-f, --format <type> Output format svg | html | png auto from extension
-o, --output <file> Output file string output.svg
--theme <theme> Theme light | dark light
--scale <number> PNG scale factor string 2
-h, --help Show help boolean
-v, --version Show version boolean

Examples

shumoku render network.yaml -o diagram.svg
shumoku render network.yaml -f html -o diagram.html
shumoku render network.yaml -f png -o diagram.png
shumoku render topology.json -o diagram.svg
cat network.yaml | shumoku render - -o diagram.svg

apps/cli/src/command.ts