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

The TypeDB Console CLI is packaged and distributed together with the TypeDB CE database server.

Install

  • macOS

  • Linux

  • Windows

Install using the install script

Use the TypeDB install script. This script securely downloads the latest version of TypeDB and installs it to $HOME/.typedb.

curl -sSL https://typedb.com/install.sh | sh && export PATH="$HOME/.typedb:$PATH"

Or install using Homebrew

Install the TypeDB Homebrew package using the command:

brew install typedb/tap/typedb

Install using the install script

Use the TypeDB install script. This script securely downloads the latest version of TypeDB and installs it to $HOME/.typedb.

curl -sSL https://typedb.com/install.sh | sh && export PATH="$HOME/.typedb:$PATH"

Or install using apt

Install the TypeDB apt package using the following commands.

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
sudo apt install typedb

Install using the install script

Use the TypeDB install script. This script securely downloads the latest version of TypeDB and installs it to %LOCALAPPDATA%\TypeDB.

iwr https://typedb.com/install.ps1 -useb | iex

Run

TypeDB Console can connect to TypeDB CE, TypeDB Cloud instances, or TypeDB Enterprise deployments. Running TypeDB Console initiates a network connection to a TypeDB server.

Connect to TypeDB
typedb console --address=<server-address> --username=<username>

You will be prompted for a password.

Use --tls-disabled to connect to a server without encryption.

The default username and password are admin and password. After connecting for the first time, you will be able to change the password.

As a result, you get a welcome message from TypeDB Console followed by a command line prompt.

Welcome to TypeDB Console.

>>

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