reladraw

reladraw [options] input

reladraw compiles a text file into a standalone SVG. Each node is placed relative to another (`below`, `right of`, `level with`, `between`, or a diagonal such as `above-left of`). The file contains no coordinates, and the tool does not pick the arrangement the way Graphviz or D2 do. A gap is a minimum distance. The resolver finds the tightest layout that satisfies every statement.One statement per line. `node` names a box and the label drawn in it. A dotted name such as `server.docker` puts that node inside `server`. `edge` draws an arrow (`->`, `<-`, or `<->`), with an optional label. `from:` and `to:` name the side the line leaves and the side it arrives on. `//` comments run to the end of the line. Blank lines and indentation do not change the meaning.The command is the npm package reladraw (version 0.4.0). It needs Node.js 18 or newer and has no runtime dependencies. Install it with `npm install -g reladraw`, or run `npx reladraw` without a global install. The same repository ships a browser editor; the shell tool only writes SVG.

INPUT

Path to a reladraw source file. The diagram is not read from standard input.

Where to write the SVG. Defaults to the input path with its extension replaced by `.svg`. Use `-` to write the SVG to standard output. Parent directories are created. When writing a file, the resolved output path is printed on standard error.

Print usage and exit 0. With no arguments, reladraw prints the same usage and exits 1.

The language is early and the syntax is expected to change. A render that succeeds does not yet report overlapping nodes, crossed edges, or text that overflowed its box. An edge that names no route is a straight line between centers and can pass through other nodes. Routing that goes around nodes is not implemented yet.Unknown options are an error. Only SVG is produced. The code is Apache-2.0. The project name and logo are not covered by that license.

d2(1), dot(1), mermaid(1), plantuml(1)

Source code · Documentation