# install

This file documents how the install.sh script installs d2 and how you can
manually install yourself.

<!-- toc -->

- [install.sh](#installsh)
- [Standalone](#standalone)
- [macOS (Homebrew)](#macos-homebrew)

<!-- tocstop -->

## install.sh

```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 see:

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

## Standalone

We publish standalone release archives with every release on github.
Download the `.tar.gz` release for your OS/ARCH combination and then run:

```sh
make install
```

Inside the extracted directory to install.

```sh
make uninstall
```

To 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.

We have releases with identical process for tala at https://github.com/terrastruct/TALA/releases

## macOS (Homebrew)

For macOS you may install as so:

```sh
brew tap terrastruct/d2
brew install d2
brew test d2
```

For closed source TALA [https://github.com/terrastruct/tala]:

```sh
brew tap terrastruct/d2
brew install tala
brew test tala
```

You don't have to run the `brew test` command but we recommend it to ensure d2 is
functioning correctly after installation.