TypeDB Community Edition

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

Install

  • macOS

  • Linux

  • Windows

Install using the install script

Use the TypeDB 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"

Or install using Homebrew

Install the TypeDB Homebrew package using the command:

brew install typedb/tap/typedb

Install using the install script

Use the TypeDB 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"

Or install using apt

Install the TypeDB apt package using the following commands.

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

Install using the install script

Use the TypeDB 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].

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:/opt/typedb-all-linux-x86_64/server/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.

You will have to use -v typedb-data:/opt/typedb-all-linux-arm64/server/data if you are running the arm64 image.

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

docker start typedb

To stop a running Docker container:

docker stop typedb