Skip to content

kieler/elk-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ELK-CLI

This is a simple wrapper around elkjs to enable its usage directly from the commandline. It can be supplied with a graph from a file or directly over standard input. The expected format is the elkj format. When passing it directly in the commandline, care must be taken to correctly escape all quotes in the JSON object. The layouted graph is written elkj format to standard output.

Installation

The elk cli tool can be installed using node:

> npm install -g @kieler/elk-cli

and then run as

> elk -f <inputfile>

You can also run it directly using npx

> npx @kieler/elk-cli -f <inputfile>

Usage

Layout a graph provided in a json file:

> elk -f examples/graph.json

Layout a graph directly as an argument:

> elk -g "{\"id\": \"root\"}"

When passing in the graph as a string directly make sure to escape all double quotes that are part of the JSON.

Generate SVGs

You can automatically generate a simple SVG of the laid out graph using the -s <output.svg> option. A css file for styling may be supplied using the -c <style.css> file. The examples folder contains an example style file.