Install TypeQL Syntax Checker

typeql-check is a small CLI tool that validates the syntax of a TypeQL query without sending it to a TypeDB server. It is useful for linting .tql files in editors and CI pipelines, and for letting AI coding agents self-correct the queries they produce.

It is distributed through the same channels as TypeDB Console.

Install

  • macOS

  • Linux

  • Windows

Install using Homebrew

brew install typedb/tap/typeql-check

Install using apt

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 typeql-check

Download manually

There is no package-manager option on Windows yet. Download the latest typeql-check Windows build from the TypeDB Tools releases page, extract it, and add the extracted directory to your PATH.

Verify

Check that the binary is on your PATH:

which typeql-check

Getting Started

After installation, see TypeQL Syntax Checker for usage and examples.