TypeDB Fundamentals Lecture Series: from Nov 16 to Jan 9

Install and Run

TypeDB Cloud

TypeDB Cloud hero image

Log in to TypeDB Cloud and create a new deployment on the Deployments page.

TypeDB Enterprise

To get your Enterprise license from our sales team, contact us via E-mail or contact form.

To deploy and run your on-premise cluster of TypeDB Enterprise, see the Enterprise Deployment page.

TypeDB Core

TypeDB Core is the open-source edition of TypeDB. It supports all features of TypeQL. For more information on the difference between TypeDB editions, see the Deploy page.

TypeDB Core also supports all TypeDB Clients, including: TypeDB Console, TypeDB Studio, and TypeDB Drivers.

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

Via package manager

  • macOS

  • Linux

  • Windows

To install TypeDB via brew:

brew tap vaticle/tap
brew install vaticle/tap/typedb

For arm64 architecture (e.g., a MacBook with M1 processor), we don’t recommend installing TypeDB versions prior to 2.19.0 via Homebrew; see the Running TypeDB on an M1 MacBook and use the manual installation instead.

  1. Add the TypeDB repository:

    sudo apt install software-properties-common apt-transport-https gpg
gpg --keyserver hkp://keyserver.ubuntu.com:80 --recv-key 8F3DA4B5E9AEF44C
gpg --export 8F3DA4B5E9AEF44C | sudo tee /etc/apt/trusted.gpg.d/vaticle.gpg > /dev/null
echo "deb https://repo.vaticle.com/repository/apt/ 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 download and install section below.

Manual download and install

Download the latest version of TypeDB Core from the table below or go to the Releases page for past versions.

Release notes macOS Linux Windows

2.25.7

x86_64 / arm64

x86_64 / arm64

x86_64

  • 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/typedb-all-mac-x86_64-2.25.7.zip -d /opt/typedb

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

    ln -s /opt/typedb/typedb-all-mac-x86_64-2.25.7/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/typedb-all-linux-x86_64-2.25.7.tar.gz -C /opt/typedb

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

    ln -s /opt/typedb/typedb-all-linux-x86_64-2.25.7/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\typedb-all-windows-x86_64-2.25.7.zip" -C "C:\Program Files\TypeDB"

  3. Update the PATH environment variable:

    setx /M PATH "%path%;C:\Program Files\TypeDB\typedb-all-windows-x86_64-2.25.7"

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

Run TypeDB Core

Start

To start a local TypeDB Core server:

typedb server

To run TypeDB Core in a new Docker container:

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

To learn how to use TypeDB, see the Quickstart guide, TypeDB in 25 queries page, and the TypeDB documentation.

Stop

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

For a Docker container:

docker stop typedb

TypeDB Console

TypeDB Console is the default CLI client for TypeDB. Both TypeDB Core and TypeDB Enterprise are usually distributed with a compatible version of TypeDB Console.

To install TypeDB Console separately, use the guide below. If you are not sure which version of TypeDB Console you need, check the compatibility table.

  • macOS

  • Linux

  • Windows

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

  2. Navigate to the Releases page, select a required version. Depending on your architecture, download the typedb-console-mac-x86_64 or the typedb-console-mac-arm64 archive.

  3. Extract the archive with TypeDB Console into a new directory:

    sudo mkdir /opt/typedb-console
unzip ~/Downloads/typedb-console-mac-x86_64-2.25.7.zip -d /opt/typedb-console

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

    ln -s /opt/typedb-console/typedb-console-mac-x86_64-2.25.7/typedb /usr/local/bin/typedb

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

  2. Navigate to the Releases page, select a required version. Depending on your architecture, download the typedb-console-linux-x86_64 or the typedb-console-linux-arm64 archive.

  3. Extract the archive with TypeDB Console into a new directory:

    mkdir /opt/typedb-console
tar -xzf ~/Downloads/typedb-console-linux-x86_64-2.25.7.tar.gz -C /opt/typedb-console

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

    ln -s /opt/typedb-console/typedb-console-linux-x86_64-2.25.7/typedb /usr/local/bin/typedb

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

  2. Navigate to the Releases page, select a required version, download the typedb-console-windows-x86_64 archive.

  3. Extract the archive with TypeDB Console into a new directory:

    mkdir "C:\Program Files\TypeDB Console"
tar xvf "C:\Users\username\Downloads\typedb-console-windows-x86_64-2.25.7.zip" -C "C:\Program Files\TypeDB Console"

  4. Update the PATH environment variable:

    setx /M PATH "%path%;C:\Program Files\TypeDB Console\typedb-console-windows-x86_64-2.25.7"

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

Run TypeDB Console

To run TypeDB Console:

typedb console

The above command will try to establish a connection with a TypeDB server on the default address of localhost:1729. To connect to a different address use the --server argument followed by a TypeDB server IP address and port: 10.0.0.1:1729.

If the typedb command is not recognized, it means that the path to TypeDB binary is not set in the system. You can find TypeDB binary in the TypeDB distributive. To start TypeDB Console from its binary, navigate into the directory with unpacked distributive and run:

./typedb console

To learn how to use TypeDB Console, see the Quickstart guide and the TypeDB Console page.

TypeDB Studio

TypeDB Studio is an IDE for TypeDB. To install and run TypeDB Studio, use the guide below.

If you are not sure which version of TypeDB Studio you need, check the compatibility table.

Install with a package manager

  • macOS

  • Linux

  • Windows

You can use the following commands:

brew tap vaticle/tap
brew install --cask vaticle/tap/typedb-studio

No package manager available for Linux, use the Download and install manually section below.

No package manager available for Windows, use the Download and install manually section below.

Download and install manually

  • macOS

  • Linux

  • Windows

  1. Navigate to the Releases page, select a required version, download the typedb-studio-mac artifact depending on your architecture.

  2. Open the .dmg file, agree with the license agreement.

  3. Drag and drop the TypeDB Studio executable to the Application folder.

  1. Navigate to the Releases page, select a required version, download the typedb-studio-linux artifact depending on your architecture.

  2. Extract the archive with TypeDB Studio into a new directory:

    mkdir /opt/typedb-studio
tar -xzf ~/Downloads/typedb-studio-linux-x86_64-2.24.15.tar.gz -C /opt/typedb-studio

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

    ln -s /opt/typedb-studio/typedb-studio-linux-x86_64-2.24.15/typedb-studio /usr/local/bin/typedb-studio

  1. Navigate to the Releases page, select a required version, download the typedb-studio-windows artifact for the selected version.

  2. Run the downloaded .exe file and follow the installation wizard.

Run TypeDB Studio

TypeDB Studio is a standalone TypeDB Client with GUI that needs to be launched separately from a TypeDB server. To launch TypeDB Studio, locate its binary file and run it.

To learn more on how to use TypeDB Studio, see the Quickstart guide and the TypeDB Studio page.

TypeDB Drivers

  • Rust

  • Python

  • Java

  • Node.js

Please follow the installation guide to add TypeDB Rust Driver to a project/application.

To download TypeDB Rust Driver, you can use any of the following options:

For more information on the Driver versions, check the version compatibility table and release notes.

Please follow the installation guide to add TypeDB Python Driver to a project/application.

To download TypeDB Python Driver, you can use any of the following options:

For more information on the Driver versions, check the version compatibility table and release notes.

Please follow the installation guide to add TypeDB Java Driver to a project/application.

Alternatively, you can download TypeDB Java Driver by the following link:

For more information on the Driver versions, check the version compatibility table and release notes.

Please follow the installation guide to add TypeDB Node.js Driver to a project/application.

To download TypeDB Node.js Driver, you can use the following command:

  • npm install typedb-driver

For more information on the Driver versions, check the version compatibility table and release notes.

Provide Feedback