TypeDB 3.0 is live! Get started for free.

Install tools

You can connect to TypeDB and begin developing in several ways.

A command-line tool for interacting with TypeDB.

A GUI tool for developing with TypeDB.

SDKs to programmatically query & manage TypeDB.

TypeDB Console

TypeDB Console is a lightweight and powerful CLI tool to manage and query your TypeDB databases.

Installation

  • macOS

  • Linux

  • Windows

Install TypeDB Console using Homebrew:

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

Or download and install manually:

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

  2. Download the right package for your system: TypeDB Console x86_64 / arm64

  3. Extract the archive and optionally create a symlink:

    sudo mkdir /opt/typedb
    unzip ~/Downloads/<ARCHIVE_FILENAME>.zip -d /opt/typedb
    ln -s /opt/typedb/<ARCHIVE_FILENAME>/typedb /usr/local/bin/typedb

Install TypeDB Console using APT:

  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

Or download and install manually:

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

  2. Download the right package for your system: TypeDB Console x86_64 / arm64

  3. Extract the archive and optionally create a symlink:

    mkdir /opt/typedb
    tar -xzf ~/Downloads/<ARCHIVE_FILENAME>.tar.gz -C /opt/typedb
    ln -s /opt/typedb/<ARCHIVE_FILENAME>/typedb /usr/local/bin/typedb
  1. Ensure Java 11+ is installed. TypeDB supports OpenJDK and Oracle JDK.

  2. Download and unzip the archive: x86_64

  3. (Optional) Add the extracted archive path to your PATH environment variable.

Using Console

Launch TypeDB Console with the command:

typedb console

To list all available TypeDB Console command use:

typedb console --help

For a complete usage guide, visit the TypeDB Console Manual.

TypeDB Studio

TypeDB Studio is a graphical tool for managing and querying TypeDB databases.

With Studio, developers can efficiently manage databases, execute queries, and explore query results, all within a unified environment.

Launch TypeDB Studio directly from your web browser.

The GitHub repository with the source code and release notes.

Desktop builds will be published soon, powered by Tauri.

If you’re using TypeDB 3.0 or 3.1, you can still access the (unmaintained) legacy TypeDB Studio application in Cloudsmith.

Using Studio

TypeDB Studio allows users to:

  • Connect to TypeDB and manage databases.

  • Run TypeQL queries on your database and display query results.

For a more detailed TypeDB Studio usage guide, visit the TypeDB Studio Manual.

TypeDB Drivers

See the dedicated Driver documentation for details on installation and usage of language drivers for TypeDB.

OSZAR »