d2/docs/INSTALL.md
2022-11-21 09:31:05 -08:00

2.1 KiB

install

This file documents all the ways by which you can install D2.

install.sh

# With --dry-run the install script will print the commands it will use
# to install without actually installing so you know what it's going to do.
curl -fsSL https://d2lang.com/install.sh | sh -s -- --dry-run
# If things look good, install for real.
curl -fsSL https://d2lang.com/install.sh | sh -s --

For help on the terminal run, including the supported package managers and detection methods:

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

macOS (Homebrew)

If you're on macOS, you can alternatively install with brew. (the install script above does this automatically if you have brew installed).

brew tap terrastruct/d2
brew install d2

Standalone

We publish standalone release archives with every release on Github. Download the .tar.gz release for your OS/ARCH combination and then run the following inside the extracted directory to install:

make install

Run the following to uninstall:

make uninstall

You will be prompted for sudo/su/doas if root permissions are required for installation. You can control the Unix hierarchy installation path with PREFIX=. For example:

# Install under ~/.local.
# Binaries will be at ~/.local/bin
# And manpages will be under ~/.local/share/man
# And supporting data like icons and fonts at ~/.local/share/d2
make install PREFIX=$HOME/.local

The install script places the standalone release into $PREFIX/lib/d2/d2-<version> and we recommend doing the same with manually installed releases so that you know where the release directory is for easy uninstall.

warn: Our binary releases aren't fully portable like normal Go binaries due to the C dependency on v8go for executing dagre.

From source

Alternatively, you can always install from source:

go install oss.terrastruct.com/d2/cmd/d2@latest

Coming soon

  • Docker image
  • Windows install
  • rpm and deb packages
  • homebrew core