TDengine Command Line (CLI)

The TDengine command-line interface (hereafter referred to as TDengine CLI) is the most simplest way for users to manipulate and interact with TDengine instances.

Installation

To run TDengine CLI to access TDengine cloud, please download and install recent TDengine client installation package first.

Config

Config on Linux

Run this command in your Linux terminal to save cloud DSN as variable:

export TDENGINE_CLOUD_DSN="<DSN>"

Config on Windows (beta)

Run this command in your Windows CMD prompt to save cloud DSN as variable:

set TDENGINE_CLOUD_DSN=<DSN>

Or run this command in your Windows PowerShell environment to save cloud DSN as variable:

$env:TDENGINE_CLOUD_DSN='<DSN>'

Config on Mac (beta)

Run this command in your Mac terminal to save cloud DSN as variable:

export TDENGINE_CLOUD_DSN="<DSN>"

IMPORTANT

To obtain the value of cloud DSN, please log in TDengine Cloud and click "Tools" and then select "TDengine CLI".

Connect

Connect on Linux

To access the TDengine Cloud instance, you can execute taos if you already set the environment variable.

taos

If you did not set environment variable for a TDengine Cloud instance, or you want to access other TDengine Cloud instances rather than the instance you already set the environment variable, you can use taos -E <DSN> as below.

taos -E $TDENGINE_CLOUD_DSN

Connect on Windows (beta)

To access the TDengine Cloud, you can execute taos if you already set the environment variable.

taos.exe

If you did not set environment variable for a TDengine Cloud instance, or you want to access other TDengine Cloud instances rather than the instance you already set the environment variable, you can use taos -E <DSN> as below.

taos.exe -E %TDENGINE_CLOUD_DSN%

Connect on Mac (beta)

To access the TDengine Cloud, you can execute taos if you already set the environment variable.

taos

If you did not set environment variable for a TDengine Cloud instance, or you want to access other TDengine Cloud instances rather than the instance you already set the environment variable, you can use taos -E <DSN> as below.

taos -E $TDENGINE_CLOUD_DSN

Using TDengine CLI

TDengine CLI will display a welcome message and version information if it successfully connected to the TDengine service. If it fails, TDengine CLI will print an error message. The TDengine CLI prompts as follows:

Welcome to the TDengine shell from Linux, Client Version:3.0.0.0
Copyright (c) 2022 by TAOS Data, Inc. All rights reserved.

Successfully connect to cloud.tdengine.com:8085 in restful mode

taos>

After entering the TDengine CLI, you can execute various SQL commands, including inserts, queries, or administrative commands. Please see the official document for more details.