diff --git a/docs-en/07-tools/01-cli.md b/docs-en/07-tools/01-cli.md index 95c50eeebc99dbef14766cb1f35bc873d875c12f..3fe6cb7d9f9d5d9e06174f57e48473281459ccd6 100644 --- a/docs-en/07-tools/01-cli.md +++ b/docs-en/07-tools/01-cli.md @@ -10,13 +10,29 @@ The TDengine command-line application (hereafter referred to as `TDengine CLI`) 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). -## Execution +## Config (Linux or Mac) -To access the TDengine Cloud, you can execute `taos -R -h -t ` command-line utility from a Linux terminal, Windows terminal, or Mac terminal. Please find the `cloud_host` and `cloud_token` string after log in to the TDengine Cloud. +Run this command in your Linux terminal or Mac terminal to save your URL and token as variables: -```bash -taos -R -h -t -``` +export TDENGINE_CLOUD_URL= +export TDENGINE_CLOUD_TOKEN= + +## Connect (Linux or Mac) + +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, or Mac terminal. + +## Config (Windows, WIP, coming soon) + +Run this command in your Windows terminal to save your URL and token as variables: + +set TDENGINE_CLOUD_URL= +set TDENGINE_CLOUD_TOKEN= + +## Connect (Windows, WIP, coming soon) + +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. + +## 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. See [FAQ](/train-faq/faq) to solve the problem of terminal connection failure to the server. The TDengine CLI prompts as follows: