Install tools
You can connect to TypeDB and begin developing in several ways.
TypeDB Studio
Install a powerful GUI tool that facilitates development on TypeDB with a schema manager, result visualizer, and more.
-
macOS
-
Linux
-
Windows
Install TypeDB Studio using Homebrew:
brew tap typedb/tap
brew install --cask typedb/tap/typedb-studio
Install TypeDB Studio using apt
:
-
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
-
Install the application:
sudo apt install typedb-studio
Download the installer: TypeDB Studio (x86_64)
The installation wizard will guide you through the process of installing TypeDB Studio.
Quickstart
For a 5-minute tutorial on the basics of TypeDB and Studio, visit the Quickstart.
Or, for a complete TypeDB Studio usage guide, visit the TypeDB Studio Manual.
Use with older TypeDB versions
For older TypeDB versions, you’ll need a compatible version of TypeDB Studio. Select the correct TypeDB Studio version from the version compatibility table, and download it from Cloudsmith.
Version compatibility table
TypeDB Console
Install a lightweight and powerful CLI tool to manage and query your TypeDB databases.
-
macOS
-
Linux
-
Windows
Install TypeDB Console using Homebrew:
brew tap typedb/tap
brew install typedb/tap/typedb
Or download and install manually:
-
Ensure Java 11+ is installed. TypeDB supports OpenJDK and Oracle JDK.
-
Download the right package for your system: TypeDB Console x86_64 / arm64
-
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:
-
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
-
Ensure Java 11+ is installed:
sudo apt install default-jre
TypeDB supports OpenJDK and Oracle JDK.
-
Install
typedb
:sudo apt install typedb
If you had an older version (≤
2.25.5
) oftypedb
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:
-
Ensure Java 11+ is installed. TypeDB supports OpenJDK and Oracle JDK.
-
Download the right package for your system: TypeDB Console x86_64 / arm64
-
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
-
Ensure Java 11+ is installed. TypeDB supports OpenJDK and Oracle JDK.
-
Download the archive: TypeDB Console (x86_64)
-
Extract the archive and optionally update your
PATH
environment variable:mkdir "C:\Program Files\TypeDB" tar xvf "C:\Users\<USERNAME>\Downloads\<ARCHIVE_FILENAME>.zip" -C "C:\Program Files\TypeDB" setx /M PATH "%path%;C:\Program Files\TypeDB\<ARCHIVE_FILENAME>"
Open a new terminal window for changes to environment variables to take effect.
Quickstart
Run TypeDB Console:
typedb console
List all available TypeDB Console commands:
typedb console --help
For a complete usage guide, visit the TypeDB Console Manual.
Use with older TypeDB versions
For older TypeDB versions, you’ll need a compatible version of TypeDB Console. Select the correct TypeDB Console version from the version compatibility table, and download it from Cloudsmith.
Version compatibility table
TypeDB Console | TypeDB Cloud | TypeDB Community Edition |
---|---|---|
2.28.0 |
2.28.0 |
|
2.27.0 |
2.27.0 |
|
2.26.6 |
2.26.6 |
|
2.25.7 |
2.25.7 |
|
2.24.17 |
2.24.17 |
|
2.18.0 to 2.23.0 |
2.18.0 to 2.23.0 |
|
2.17.0 |
2.17.0 |
|
2.16.1 |
2.16.1 to 2.16.2 |
2.16.1 |
2.15.0 |
2.15.0 |
2.15.0 |
2.14.2 |
2.14.2 to 2.14.3 |
2.14.1 |
2.12.0 |
2.12.0 to 2.13.0 |
2.12.0 to 2.13.0 |
2.11.0 |
2.11.0 to 2.11.1 |
2.11.1 to 2.11.2 |
2.10.0 |
2.10.0 |
2.10.0 |
2.9.0 |
2.9.0 |
2.9.0 |
2.8.0 |
2.8.0 to 2.8.1 |
2.5.0 |
2.6.1 |
2.6.1 to 2.7.1 |
2.5.0 |
2.5.0 |
2.5.0 |
2.3.0 |
2.4.0 |
2.4.0 |
2.3.0 |
2.3.2 |
2.3.2 to 2.3.3 |
2.3.0 |
2.1.3 |
2.1.3 to 2.2.0 |
2.1.2 |
2.0.1 |
2.0.1 to 2.0.2 |
2.0.1 to 2.0.2 |
1.0.8 |
- |
1.1.0 to 1.8.4 |
TypeDB Drivers
Official driver libraries for building applications on TypeDB.