Repository files navigation

• Visualize your YAML files as Graph
• Generate additional info from your source code (simply define a YAML block and use this tool)

Takes in input:

• any YAML file
• any text file that has YAML between comments (likefront matter)

Generates adot script forGraphviz.

Given a sampledeployment.yml file:

apiVersion:apps/v1kind:Deploymentmetadata:name:nginx-deploymentlabels:app:nginxspec:replicas:3selector:matchLabels:app:nginxtemplate:metadata:labels:app:nginxspec:containers:      -name:nginximage:nginx:1.14.2ports:        -containerPort:80

Runyml2dot like this:

$ yml2dot deployment.yml| dot -Tpng> deployment.png

and create this graph:

/***Box:  Object:    - set    - get***/publicclassBox {privateObjectobject;publicvoidset(Objectobject) {this.object =object;    }publicObjectget() {returnobject;    }}

Use the-from and-to flags to mark your YAML block.

Runyml2dot like this:

$ yml2dot -from'/***' -to'***/' Box.java| dot -Tpng> Box.java.png

and create this graph:

You can also pipe YAML strings directly intoyml2dot, allowing for dynamic generation and transformation of YAML data. This is particularly useful when combiningyml2dot with other command-line tools in a Unix-style pipeline.

For example, to visualize a YAML string without creating an intermediate file:

echo"apiVersion: v1\nkind: Pod\nmetadata:\n  name: mypod"| yml2dot| dot -Tpng> mypod.png

Or, to dynamically generate a YAML configuration and immediately visualize it:

generate-yaml-config| yml2dot| dot -Tpng> config.png

This feature enhancesyml2dot's flexibility and integration into automated workflows and scripts.

If you havegolang installed:

$ go install github.com/lucasepe/yml2dot@latest

This will create the executable under your$GOPATH/bin directory.

If you don't want to compile the sourcecode yourself,Here you can find the tool already compiled for:

• MacOS
• Linux
• Windows