Install

The easiest way to install is with our install script:

curl -fsSL https://d2lang.com/install.sh | sh -s --

To uninstall:

curl -fsSL https://d2lang.com/install.sh | sh -s -- --uninstall

For detailed installation docs, with alternative methods and examples for each OS, see
./docs/INSTALL.md.

D2 as a library

In addition to being a runnable CLI tool, D2 can also be used to produce diagrams from
Go programs.

import (
  "github.com/terrastruct/d2/d2compiler"
  "github.com/terrastruct/d2/d2exporter"
  "github.com/terrastruct/d2/d2layouts/d2dagrelayout"
  "github.com/terrastruct/d2/d2renderers/textmeasure"
  "github.com/terrastruct/d2/d2themes/d2themescatalog"
)

func main() {
  graph, err := d2compiler.Compile("", strings.NewReader("x -> y"), &d2compiler.CompileOptions{ UTF16: true })
  ruler, err := textmeasure.NewRuler()
  err = graph.SetDimensions(nil, ruler)
  err = d2dagrelayout.Layout(ctx, graph)
  diagram, err := d2exporter.Export(ctx, graph, d2themescatalog.NeutralDefault)
  ioutil.WriteFile(filepath.Join("out.svg"), d2svg.Render(*diagram), 0600)
}

D2 is built to be hackable — the language has an API built on top of it to make edits
programmatically.

import (
  "github.com/terrastruct/d2/d2oracle"
  "github.com/terrastruct/d2/d2format"
)

// ...modifying the diagram `x -> y` from above
// Create a shape with the ID, "meow"
graph, err = d2oracle.Create(graph, "meow")
// Style the shape green
graph, err = d2oracle.Set(graph, "meow.style.fill", "green")
// Create a shape with the ID, "cat"
graph, err = d2oracle.Create(graph, "cat")
// Move the shape "meow" inside the container "cat"
graph, err = d2oracle.Move(graph, "meow", "cat.meow")
// Prints formatted D2 code
println(d2format.Format(graph.AST))

This makes it easy to build functionality on top of D2. Terrastruct uses the above API to
implement editing of D2 from mouse actions in a visual interface.

Themes

D2 includes a variety of official themes to style your diagrams beautifully right out of
the box. See ./d2themes to browse the available themes and make or
contribute your own creation.

Fonts

D2 ships with “Source Sans Pro” as the font in renders. If you wish to use a different
one, please see ./d2renderers/d2fonts.

Export file types

D2 currently supports SVG exports. More coming soon.

Language tooling

D2 is designed with language tooling in mind. D2’s parser can parse multiple errors from a
broken program, has an autoformatter, syntax highlighting, and we have plans for LSP’s and
more. Good language tooling is necessary for creating and maintaining large diagrams.

The extensions for VSCode and Vim can be found in the Related section.

Plugins

D2 is designed to be extensible and composable. The plugin system allows you to
change out layout engines and customize the rendering pipeline. Plugins can either be
bundled with the build or separately installed as a standalone binary.

Layout engines:

• dagre (default, bundled): A fast, directed graph
  layout engine that produces layered/hierarchical layouts. Based on Graphviz’s DOT
  algorithm.
• ELK (bundled): A directed graph layout engine
  particularly suited for node-link diagrams with an inherent direction and ports.
• TALA (binary): Novel layout engine designed
  specifically for software architecture diagrams. Requires separate install, visit the
  Github page for more.

D2 intends to integrate with a variety of layout engines, e.g. dot, as well as
single-purpose layout types like sequence diagrams. You can choose whichever layout engine
you like and works best for the diagram you’re making.

Comparison

For a comparison against other popular text-to-diagram tools, see
https://text-to-diagram.com.

Contributing

Contributions are