Install TypeDB Community Edition

You can run TypeDB Community Edition (CE) locally or inside a Docker container. TypeDB CE is free & open source!

Installer script

  • macOS

  • Linux

  • Windows

Install using the install script

This script securely downloads the latest version of TypeDB and installs it to $HOME/.typedb.

curl -sSL https://typedb.com/install.sh | sh && export PATH="$HOME/.typedb:$PATH"

Install using the install script

This script securely downloads the latest version of TypeDB and installs it to $HOME/.typedb.

curl -sSL https://typedb.com/install.sh | sh && export PATH="$HOME/.typedb:$PATH"

Install using the install script

This script securely downloads the latest version of TypeDB and installs it to %LOCALAPPDATA%\TypeDB.

iwr https://typedb.com/install.ps1 -useb | iex

Run

To start the server:

typedb server

To stop a local TypeDB server, close the terminal where it runs or press kbd:[Ctrl+C].

Package manager

  • macOS

  • Linux

  • Windows

Install using Homebrew

brew install typedb/tap/typedb

Install using apt

sudo apt install software-properties-common apt-transport-https gpg
gpg --keyserver hkp://keyserver.ubuntu.com:80 --recv-key 17507562824cfdcc
gpg --export 17507562824cfdcc | sudo tee /etc/apt/trusted.gpg.d/typedb.gpg > /dev/null
echo "deb https://repo.typedb.com/public/public-release/deb/ubuntu trusty main" | sudo tee /etc/apt/sources.list.d/typedb.list > /dev/null
sudo apt update
sudo apt install typedb

Package manager installation is not yet available for Windows. Use the easy installer script or perform a manual installation instead.

Run

To start the server:

typedb server

To stop a local TypeDB server, close the terminal where it runs or press kbd:[Ctrl+C].

Docker

Download

To pull the latest TypeDB CE Docker image:

docker pull typedb/typedb:latest

You can replace latest with a version number to get a specific version of TypeDB CE. To check the list of available versions, see the Releases page.

Run

To create a new Docker container with TypeDB CE server:

docker volume create typedb-data
docker create --name typedb -v typedb-data:/var/lib/typedb/data -p 1729:1729 -p 8000:8000 typedb/typedb:latest

Where typedb is the name of the container, and typedb-data is the name of the volume to persist data. -p 1729:1729 -p 8000:8000 forward the ports 1729 and 8000 on the host machine to the container’s ports 1729 and 8000 respectively.

For TypeDB 3.7.0 and older

For TypeDB versions older than 3.7.1, use platform-specific volume paths:

docker volume create typedb-data
docker create --name typedb -v typedb-data:/opt/typedb-server-linux-x86_64/server/data -p 1729:1729 -p 8000:8000 typedb/typedb:3.7.0

For arm64 images, use -v typedb-data:/opt/typedb-server-linux-arm64/server/data.

To start the created Docker container or restart a stopped container:

docker start typedb

To stop a running Docker container:

docker stop typedb

Manual install

Download the latest distribution of TypeDB CE from the table below.

Release notes macOS Linux Windows

latest

x86_64 / arm64

x86_64 / arm64

x86_64

For all versions, see the Packages page.

  • macOS

  • Linux

  • Windows

  1. Extract the archive with TypeDB into a new directory:

    sudo mkdir /opt/typedb
unzip ~/Downloads/<filename>.zip -d /opt/typedb

    Where <filename> is the name of the archive.

  2. Add a symlink to the TypeDB executable in the /usr/local/bin directory:

    ln -s /opt/typedb/<filename>/typedb /usr/local/bin/typedb

  1. Extract the archive with TypeDB into a new directory:

    mkdir /opt/typedb
tar -xzf ~/Downloads/<filename>.tar.gz -C /opt/typedb

    Where <filename> is the name of the archive.

  2. Add a symlink to the TypeDB executable in the /usr/local/bin directory:

    ln -s /opt/typedb/<filename>/typedb /usr/local/bin/typedb

  1. Extract the archive with TypeDB into a new directory:

    mkdir "C:\Program Files\TypeDB"
tar xvf "C:\Users\username\Downloads\<filename>.zip" -C "C:\Program Files\TypeDB"

    Where <filename> is the name of the archive.

  2. Update the PATH environment variable:

    setx /M PATH "%path%;C:\Program Files\TypeDB\<filename>"

    Restart the terminal window for the changes to environment variables to take effect.

Run

To start the server:

typedb server

To stop a local TypeDB server, close the terminal where it runs or press kbd:[Ctrl+C].

Next steps

Now that you have TypeDB server running, you can connect with TypeDB Studio or TypeDB Console, or install and use a Driver.