d2(1)

📦
version 0.9.0 · 3 versions
, in arch rolling, nixpkgs unstable

d2(1) 🎀

okay so this is the General Commands Manual page for d2(1) — yes, the diagram compiler — and we're gonna get you comfy with it, bestie. ✨

💖 NAME 💖

d2 — compiles and renders d2 diagrams into svgs.

✨ SYNOPSIS ✨

d2 [--watch false] [--theme 0] [--salt string] file.d2
   [file.svg | file.png | file.pdf | file.pptx | file.gif | file.txt]
d2 layout [name]
d2 fmt file.d2 ...
d2 play file.d2
d2 validate file.d2

🌸 DESCRIPTION 🌸

d2 compiles and renders file.d2 to file.svg | file.png | file.pdf | file.pptx | file.gif | file.txt.

It defaults to file.svg if no output path is passed. 🫶

Pass - to have d2 read from stdin or write to stdout.

PNG exports support up to 32768 pixels per dimension, subject to rendering resource limits.

bestie, listen: never use the presence of the output file to check for success. Always use the exit status of d2. This is because sometimes when errors occur while rendering, d2 still write out a partial render anyway to enable iteration on a broken diagram. So yeah — exit status is the main character here. 💅

See more docs, the source code and license at https://github.com/d2lang/d2.

Hosted icons at https://icons.d2lang.com.

Playground runner at https://play.d2lang.com.

💅 OPTIONS 💅

  • -w, --watch false — watch for changes to input and live reload. Use $PORT and $HOST to specify the listening address.
  • -h, --host localhost — host listening address when used with watch.
  • -p, --port 0 — port listening address when used with watch.
  • -t, --theme 0 — set the diagram theme ID.
  • --dark-theme -1 — the theme to use when the viewer's browser is in dark mode. When left unset, --theme is used for both light and dark mode. Be aware that explicit styles set in D2 code will still be applied and this may produce unexpected results. We plan on resolving this by making style maps in D2 light/dark mode specific. See https://github.com/d2lang/d2/issues/831.
  • -s, --sketch false — renders the diagram to look like it was sketched by hand.
  • --center flag — center the SVG in the containing viewbox, such as your browser screen.
  • --scale -1 — scale the output. E.g., 0.5 to halve the default size. Default -1 means that SVG's will fit to screen and all others will use their default render size. Setting to 1 turns off SVG fitting to screen.
  • --font-regular — path to .ttf file to use for the regular font. If none provided, Source Sans Pro Regular is used.
  • --font-italic — path to .ttf file to use for the italic font. If none provided, Source Sans Pro Regular-Italic is used.
  • --font-bold — path to .ttf file to use for the bold font. If none provided, Source Sans Pro Bold is used.
  • --font-semibold — path to .ttf file to use for the semibold font. If none provided, Source Sans Pro Semibold is used.
  • --font-mono — path to .ttf file to use for the monospace font. If none provided, Source Code Pro Regular is used.
  • --font-mono-bold — path to .ttf file to use for the monospace bold font. If none provided, Source Code Pro Bold is used.
  • --font-mono-italic — path to .ttf file to use for the monospace italic font. If none provided, Source Code Pro Italic is used.
  • --font-mono-semibold — path to .ttf file to use for the monospace semibold font. If none provided, Source Code Pro Semibold is used.
  • --pad 100 — pixels padded around the rendered diagram.
  • --animate-interval 0 — if given, multiple boards are packaged as 1 SVG which transitions through each board at the interval (in milliseconds). Can only be used with SVG or GIF exports. For GIF exports, defaults to 1000ms if not specified.
  • --browser true — browser executable that watch opens. Setting to 0 opens no browser.
  • -l, --layout dagre — set the diagram layout engine to the passed string. For a list of available options, run layout.
  • -b, --bundle true — bundle all assets and layers into the output svg.
  • --force-appendix false — an appendix for tooltips and links is added to PNG exports since they are not interactive. Setting this to true adds an appendix to SVG exports as well.
  • --target — target board to render. Pass an empty string to target root board. If target ends with '*', it will be rendered with all of its scenarios, steps, and layers. Otherwise, only the target board will be rendered. E.g. --target='' to render root board only or --target='layers.x.*' to render layer 'x' with all of its children.
  • -d, --debug — print debug logs.
  • --img-cache true — in watch mode, images used in icons are cached for subsequent compilations. This should be disabled if images might change.
  • --timeout 120 — the maximum number of seconds that D2 runs for before timing out and exiting. When rendering a large diagram, it is recommended to increase this value.
  • --check false — check that the specified files are formatted correctly.
  • --salt string — add a salt value to ensure the output uses unique IDs. This is useful when generating multiple identical diagrams to be included in the same HTML doc, so that duplicate id's do not cause invalid HTML. The salt value is a string that will be appended to IDs in the output.
  • -h, --help — print usage information and exit.
  • -v, --version — print version information and exit.
  • --stdout-format string — set the output format when writing to stdout. Supported formats are: png, svg, ascii, txt, pdf, pptx, gif. Only used when output is set to stdout (-).
  • --no-xml-tag false — omit XML tag (<?xml ...?>) from output SVG files. Useful when generating SVGs for direct HTML embedding.
  • --omit-version false — omit D2 version from generated image.
  • --ascii-mode extended — ASCII rendering mode for text outputs. Options: 'standard' (basic ASCII chars) or 'extended' (Unicode chars).

🦋 SUBCOMMANDS 🦋

  • layout — lists available layout engine options with short help.
  • layout [name] — display long help for a particular layout engine, including its configuration options.
  • themes — lists available themes.
  • fmt file.d2 ... — format all passed files.
  • play file.d2 — opens the file in playground, an online web viewer (https://play.d2lang.com).
  • validate file.d2 — validates file.d2.

🌈 ENVIRONMENT VARIABLES 🌈

Many flags can also be set with environment variables. iykyk. 💜

  • D2_WATCH — see -w[atch] flag.
  • D2_LAYOUT — see -l[ayout] flag.
  • D2_THEME — see -t[heme] flag.
  • D2_DARK_THEME — see --dark-theme flag.
  • D2_PAD — see --pad flag.
  • D2_CENTER — see --center flag.
  • D2_SKETCH — see -s[ketch] flag.
  • D2_BUNDLE — see -b[undle] flag.
  • D2_FORCE_APPENDIX — see --force-appendix flag.
  • D2_FONT_REGULAR — see --font-regular flag.
  • D2_FONT_ITALIC — see --font-italic flag.
  • D2_FONT_BOLD — see --font-bold flag.
  • D2_FONT_SEMIBOLD — see --font-semibold flag.
  • D2_FONT_MONO — see --font-mono flag.
  • D2_FONT_MONO_BOLD — see --font-mono-bold flag.
  • D2_FONT_MONO_ITALIC — see --font-mono-italic flag.
  • D2_FONT_MONO_SEMIBOLD — see --font-mono-semibold flag.
  • D2_ANIMATE_INTERVAL — see --animate-interval flag.
  • D2_TIMEOUT — see --timeout flag.
  • D2_CHECK — see --check flag.
  • D2_ASCII_MODE — see --ascii-mode flag.
  • DEBUG — see -d[ebug] flag.
  • IMG_CACHE — see --img-cache flag.
  • HOST — see -h[ost] flag.
  • PORT — see -p[ort] flag.
  • BROWSER — see --browser flag.
  • D2_STDOUT_FORMAT — see --stdout-format flag.
  • D2_NO_XML_TAG — see --no-xml-tag flag.
  • OMIT_VERSION — see --omit-version.

👑 AUTHORS 👑

D2 contributors — iconic behavior, honestly. 💖

okay bye bestie — this page is from Debian, dated $Mdocdate$, and it's the d2(1) manual. periodt. 💅

📦 where this page comes from