From d8232586a9425ebbdb589b09cbd1307a69d5e627 Mon Sep 17 00:00:00 2001 From: Shuduo Sang Date: Wed, 8 Jun 2022 00:17:32 +0800 Subject: [PATCH] docs: update cloud doc cli (#13584) * docs: describe how tdengine cli connect to cloud. * docs: fix install link mistake * docs: fix install client driver link * docs: refine 07-tools/01-cli.md * docs: refine 07-tools/01-cli.md * docs: fix code block * docs: refine 07-tools/01-cli.md * docs: refine 07-tools/01-cli.md * docs: refine 07-tools/01-cli.md * docs: refine docs-en/07-tools/01-cli.md * docs: update 07-tools/01-cli.md --- docs-en/07-tools/01-cli.md | 26 +++++++++++++++++++++----- 1 file changed, 21 insertions(+), 5 deletions(-) diff --git a/docs-en/07-tools/01-cli.md b/docs-en/07-tools/01-cli.md index c60c8ffeb5..5a4f844ec3 100644 --- a/docs-en/07-tools/01-cli.md +++ b/docs-en/07-tools/01-cli.md @@ -7,11 +7,11 @@ description: Instructions and tips for using the TDengine CLI to connect TDengin import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -The TDengine command-line application (hereafter referred to as `TDengine CLI`) is the most simplest way for users to manipulate and interact with TDengine instances. +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 -If executed on the TDengine server-side, there is no need for additional installation steps to install TDengine CLI as it is already included and installed automatically. To run TDengine CLI on the environment which no TDengine server running, the TDengine client installation package needs to be installed first. For details, please refer to [Install Client Driver](/reference/connector/#install-client-driver). +To run TDengine CLI to access TDengine cloud, please install [TDengine client installation package](/download/TDengine-client-2.6.0.2-Linux-x64.tar.gz) first. @@ -49,17 +49,29 @@ export TDENGINE_CLOUD_TOKEN= -To access the TDengine Cloud, you can execute `taos -R -h $TDENGINE_CLOUD_URL -t $TDENGINE_CLOUD_TOKEN` command-line utility from a Linux terminal. +To access the TDengine Cloud, you can execute below command from a Linux terminal. + +``` +taos -R -h $TDENGINE_CLOUD_URL -t $TDENGINE_CLOUD_TOKEN +``` -To access the TDengine Cloud, you can execute `taos -R -h %TDENGINE_CLOUD_URL% -t %TDENGINE_CLOUD_TOKEN%` command-line utility from a Windows terminal. +To access the TDengine Cloud, you can execute below command from a Windows terminal. + +``` +taos -R -h %TDENGINE_CLOUD_URL% -t %TDENGINE_CLOUD_TOKEN% +``` -To access the TDengine Cloud, you can execute `taos -R -h $TDENGINE_CLOUD_URL -t $TDENGINE_CLOUD_TOKEN` command-line utility from a Mac terminal. +To access the TDengine Cloud, you can execute below command from a Mac terminal. + +``` +taos -R -h $TDENGINE_CLOUD_URL -t $TDENGINE_CLOUD_TOKEN +``` @@ -69,6 +81,10 @@ To access the TDengine Cloud, you can execute `taos -R -h $TDENGINE_CLOUD_URL -t 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. See [FAQ](/train-faq/faq) to solve the problem of terminal connection failure to the server. The TDengine CLI prompts as follows: ```cmd + +Welcome to the TDengine shell from Linux, Client Version:2.6.0.2 +Copyright (c) 2022 by TAOS Data, Inc. All rights reserved. + taos> ``` -- GitLab