Officially out now: The TypeDB 3.0 Roadmap

TypeDB Console installation guide

TypeDB Console is the built-in CLI client for TypeDB. Both TypeDB Core and TypeDB Cloud are distributed with a compatible version of TypeDB Console. To install TypeDB Console, use the guide below. If you are unsure of the version you need, check the compatibility table below.

GitHub

See source code and release notes.

Downloads

See downloadable packages.

TypeDB Console Manual

See documentation.

Package manager

  • macOS

  • Linux

  • Windows

To install TypeDB via Homebrew:

brew tap typedb/tap
brew install typedb/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/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

  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, you might first need 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.

Manual install

Download the latest version of TypeDB from the table below.

Release notes macOS Linux Windows

2.28.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 run TypeDB Console:

typedb console

For more information on how to use TypeDB Console, see the TypeDB Console page.

Version Compatibility

TypeDB Console Protocol encoding version TypeDB Core TypeDB Cloud

2.28.0

3

2.28.0

2.28.0

2.27.0

3

2.27.0

2.27.0

2.26.6

3

2.26.6

2.26.6

2.25.7

3

2.25.7

2.25.7

2.24.15

2

2.24.17

2.24.17

2.18.0

1

2.18.0 to 2.23.0

2.18.0 to 2.23.0

2.17.0

N/A

2.17.0

2.17.0
See older versions
TypeDB Console Protocol encoding version TypeDB Core TypeDB Cloud

2.16.1

N/A

2.16.1

2.16.1 to 2.16.2

2.15.0

N/A

2.15.0

2.15.0

2.14.2

N/A

2.14.2 to 2.14.3

2.14.1

2.14.0

N/A

2.14.0 to 2.14.1

2.14.1

2.12.0

N/A

2.12.0 to 2.13.0

2.12.0 to 2.13.0

2.11.0

N/A

2.11.0 to 2.11.1

2.11.1 to 2.11.2

2.10.0

N/A

2.10.0

2.10.0

2.9.0

N/A

2.9.0

2.9.0

2.8.0

N/A

2.8.0 to 2.8.1

2.5.0

2.6.1

N/A

2.6.1 to 2.7.1

2.5.0

2.6.0

N/A

2.6.0

2.5.0

2.5.0

N/A

2.5.0

2.3.0

2.4.0

N/A

2.4.0

2.3.0

2.3.2

N/A

2.3.2 to 2.3.3

2.3.0

2.3.1

N/A

2.3.1

2.3.0

2.3.0

N/A

2.3.0

2.3.0

2.1.3

N/A

2.1.3 to 2.2.0

2.1.2

2.1.2

N/A

2.1.2

2.0.3

2.1.1

N/A

2.1.1

2.0.3

2.1.0

N/A

2.1.0

2.0.3

2.0.1

N/A

2.0.1 to 2.0.2

2.0.1 to 2.0.2

2.0.0

N/A

2.0.0

2.0.0

1.0.8

N/A

1.1.0 to 1.8.4

-

Provide Feedback