New ACM paper, free-tier cloud, and open-source license

TypeDB Core installation guide

TypeDB Core can be installed in multiple ways: using Docker image, via package manager, or by manual installation. For self-hosted TypeDB Cloud installation and setup, see the Self-hosted deployment page.

Docker

To pull the latest TypeDB Docker image:

$ docker pull vaticle/typedb:latest

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

Run

To create and run a new Docker container with TypeDB Core server:

$ docker run --name typedb -d -v typedb-data:/opt/ -p 1729:1729 --platform linux/amd64 vaticle/typedb:latest

Where typedb — the name of the container; typedb-data — the name of the volume to persist data.

The --platform linux/amd64 parameter is required to run the TypeDB container on macOS with the arm64 architecture.

To stop a running Docker container:

$ docker stop typedb

To start an existing Docker container again:

$ docker start typedb

Package manager

  • macOS

  • Linux

  • Windows

To install TypeDB via brew:

$ brew tap vaticle/tap
$ brew install vaticle/tap/typedb
  1. Add the TypeDB repository:

    $ 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/vaticle.gpg > /dev/null
    $ echo "deb https://repo.typedb.com/public/public-release/deb/ubuntu trusty main" | sudo tee /etc/apt/sources.list.d/vaticle.list > /dev/null
    $ sudo apt update
  2. Ensure Java 11+ is installed:

    $ sudo apt install default-jre

    TypeDB supports OpenJDK and Oracle JDK.

  3. Install typedb:

    $ sudo apt install typedb

    If you had an older version (≤2.25.5) of TypeDB installed, it might be needed to uninstall older packages to avoid conflicts:

    $ sudo apt remove typedb-server typedb-bin typedb-console

No package manager option is available for Windows. See the Manual install section below.

Run

To start a local TypeDB Core server:

$ typedb server

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

Manual install

Download the latest version of TypeDB Core from the table below.

Release notes macOS Linux Windows

2.27.0

x86_64 / arm64

x86_64 / arm64

x86_64

For all versions, see the Packages page.

  • macOS

  • Linux

  • Windows

  1. Ensure Java 11+ is installed. TypeDB supports OpenJDK and Oracle JDK.

    To check the Java SDK version:

    $ /usr/libexec/java_home -V

    TypeDB runs natively on both arm64 and x86_64 architectures. For the best performance, make sure both TypeDB and Java SDK match your native architecture and are not using Rosetta.

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

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

    $ ln -s /opt/typedb/<filename>/typedb /usr/local/bin/typedb
  1. Ensure Java 11+ is installed. TypeDB supports OpenJDK and Oracle JDK.

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

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

    $ ln -s /opt/typedb/<filename>/typedb /usr/local/bin/typedb
  1. Ensure Java 11+ is installed. TypeDB supports OpenJDK and Oracle JDK.

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

  3. 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 a local TypeDB Core server:

$ typedb server

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

Learn more

Install an IDE that facilitates the development process for TypeDB.

Learn how to run TypeDB, connect to it, and run queries.

Try the features of TypeDB with these carefully selected queries.

Check out our dedicated Learning course for TypeDB.

Provide Feedback