TypeDB Console CLI

TypeDB Console is a standalone TypeDB client with a command line interface (CLI). It serves as a lightweight and powerful CLI tool to manage and query TypeDB databases.

Console is the default client distributed with TypeDB, but it can also be installed separately.

GitHub

The GitHub repository with the source code and release notes.

Download TypeDB Console

See the Console’s downloadable packages for macOS, Linux, and Windows.

Install

If using versions previous to 3.1.0, you will need to install Java 11+.

If you are using a distribution of TypeDB CE (TypeDB server), you may already have TypeDB Console included and can skip this step! To verify, just run typedb --help.

For installation instructions of only the Console distribution, follow the steps below for your OS:

  • macOS

  • Linux

  • Windows

  1. Download the latest package for your system architecture: x86_64 / arm64

    For other versions, see the Downloads repository page.

  2. Extract the archive into a new directory:

    $ sudo mkdir /opt/typedb-console
$ unzip ~/Downloads/<filename>.zip -d /opt/typedb-console

    Where <filename> is the name of the archive.

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

    $ ln -s /opt/typedb-console/<filename>/typedb /usr/local/bin/typedb

  1. Download the latest package for your system architecture: x86_64 / arm64

    For other versions, see the Downloads repository page.

  2. Extract the archive into a new directory:

    $ mkdir /opt/typedb-console
$ tar -xzf ~/Downloads/<filename>.tar.gz -C /opt/typedb-console

    Where <filename> is the name of the archive.

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

    $ ln -s /opt/typedb-console/<filename>/typedb /usr/local/bin/typedb

  1. Download the latest package for your system architecture: x86_64

    For other versions, see the Downloads repository page.

  2. Extract the archive into a new directory:

    $ mkdir "C:\Program Files\TypeDB Console"
$ tar xvf "C:\Users\username\Downloads\<filename>.zip" -C "C:\Program Files\TypeDB Console"

    Where <filename> is the name of the archive.

  3. Update the PATH environment variable:

    $ setx /M PATH "%path%;C:\Program Files\TypeDB Console\<filename>"

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

Getting Started

After installation, you can connect to TypeDB servers. For detailed connection instructions and usage guides, see:

  • TypeDB Console - Complete Console documentation and connection guide