Install tools
You can connect to TypeDB and begin developing in several ways.
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:
-
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 and unzip the archive: x86_64
-
(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 powerful GUI tool that facilitates development on TypeDB.
Installation
-
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: x86_64
The installation wizard will guide you through the process of installing TypeDB Studio.
Using Studio
TypeDB Studio allows users to:
-
Open a project folder containing their TypeQL files.
-
Connect to a TypeDB database and view the database schema.
-
Run TypeQL queries on your database and display query results.
For a complete 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.