TiDB Cloud CLI New #17056
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -8,12 +8,16 @@ summary: Learn how to manage TiDB Cloud resources through the TiDB Cloud CLI. | |
| TiDB Cloud provides a command-line interface (CLI) [`ticloud`](https://github.com/tidbcloud/tidbcloud-cli) for you to interact with TiDB Cloud from your terminal with a few lines of commands. For example, you can easily perform the following operations using `ticloud`: | ||
|
|
||
| - Create, delete, and list your clusters. | ||
| - Import data to your clusters. | ||
| - Export data from your clusters. | ||
|
|
||
| > **Note:** | ||
| > | ||
| > TiDB Cloud CLI is in beta. | ||
|
|
||
| ## Before you begin | ||
|
|
||
| - Have a TiDB Cloud account. If you do not have one, [sign up for a free trial](https://tidbcloud.com/free-trial). | ||
|
|
||
| ## Installation | ||
|
|
||
|
|
@@ -81,6 +85,44 @@ Install the MySQL command-line client if you do not have it. You can refer to th | |
| </div> | ||
| </SimpleTab> | ||
|
|
||
| ## Quick start | ||
|
|
||
| [TiDB Serverless](/tidb-cloud/select-cluster-tier.md#tidb-serverless) is the best way to get started with TiDB Cloud. In this section, you will learn how to create a TiDB Serverless cluster with TiDB Cloud CLI. | ||
|
|
||
| ### Create a user profile or log into TiDB Cloud | ||
|
|
||
| Before creating a cluster with TiDB Cloud CLI, you need to either create a user profile or log into TiDB Cloud. | ||
|
|
||
| - Create a user profile with your [TiDB Cloud API key](https://docs.pingcap.com/tidbcloud/api/v1beta#section/Authentication/API-Key-Management): | ||
|
|
||
| ```shell | ||
| ticloud config create | ||
| ``` | ||
|
|
||
| > **Warning:** | ||
| > | ||
| > The profile name **MUST NOT** contain `.`. | ||
|
|
||
| - Log into TiDB Cloud with authentication: | ||
|
|
||
| ```shell | ||
| ticloud auth login | ||
| ``` | ||
|
|
||
| After successful login, an OAuth token will be assigned to the current profile. If no profiles exist, the token will be assigned to a profile named `default`. | ||
|
|
||
| > **Note:** | ||
| > | ||
| > In the preceding two methods, the TiDB Cloud API key takes precedence over the OAuth token. If both are available, the API key will be used. | ||
|
|
||
| ### Create a TiDB Serverless cluster | ||
|
|
||
| To create a TiDB Serverless cluster, enter the following command, and then follow the CLI prompts to provide the required information: | ||
|
|
||
| ```shell | ||
| ticloud serverless create | ||
| ``` | ||
|
|
||
| ## Use the TiDB Cloud CLI | ||
|
|
||
| View all commands available: | ||
|
|
@@ -114,7 +156,7 @@ tiup cloud --help | |
| Run commands with `tiup cloud <command>`. For example: | ||
|
|
||
| ```shell | ||
| tiup cloud serverless create | ||
| ``` | ||
|
|
||
| Update to the latest version by TiUP: | ||
|
|
@@ -123,40 +165,6 @@ Update to the latest version by TiUP: | |
| tiup update cloud | ||
| ``` | ||
|
|
||
| ## What's next | ||
|
|
||
| Check out [CLI reference](/tidb-cloud/cli-reference.md) to explore more features of TiDB Cloud CLI. | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -861,7 +861,7 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c | |
|
|
||
| **CLI changes** | ||
|
|
||
| - Add a new command `ticloud cluster connect-info` for [TiDB Cloud CLI](/tidb-cloud/cli-reference.md). | ||
|
|
||
| `ticloud cluster connect-info` is a command that allows you to get the connection string of a cluster. To use this command, [update `ticloud`](/tidb-cloud/ticloud-update.md) to v0.3.2 or a later version. | ||
|
|
||
|
|
@@ -890,7 +890,7 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c | |
|
|
||
| **CLI changes** | ||
|
|
||
| - Add a new command [`ticloud connect`](/tidb-cloud/ticloud-serverless-shell.md) for [TiDB Cloud CLI](/tidb-cloud/cli-reference.md). | ||
|
|
||
| `ticloud connect` is a command that allows you to connect to your TiDB Cloud cluster from your local machine without installing any SQL clients. After connecting to your TiDB Cloud cluster, you can execute SQL statements in the TiDB Cloud CLI. | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| --- | ||
| title: ticloud ai | ||
| summary: The reference of `ticloud ai`. | ||
| --- | ||
|
|
||
| # ticloud ai | ||
|
|
||
| Chat with TiDB Bot: | ||
|
|
||
| ```shell | ||
| ticloud ai [flags] | ||
| ``` | ||
|
|
||
| ## Examples | ||
|
|
||
| Chat with TiDB Bot in interactive mode: | ||
|
|
||
| ```shell | ||
| ticloud serverless delete | ||
| ``` | ||
|
|
||
| Chat with TiDB Bot in non-interactive mode: | ||
|
|
||
| ```shell | ||
| ticloud ai -q "How to create a cluster?" | ||
| ``` | ||
|
|
||
| ## Flags | ||
|
|
||
| In non-interactive mode, you need to manually enter the required flags. In interactive mode, you can just follow CLI prompts to fill them in. | ||
|
|
||
| | Flag | Description | Required | Note | | ||
| |--------------------|-----------------------------------|----------|------------------------------------------------------| | ||
| | -q, --query string | Specifies your query to TiDB Bot. | Yes | Only works in non-interactive mode. | | ||
| | -h, --help | Shows help information for this command. | No | Works in both non-interactive and interactive modes. | | ||
|
|
||
| ## Inherited flags | ||
|
|
||
| | Flag | Description | Required | Note | | ||
| |----------------------|--------------------------------------------------------------------------------------------|----------|------------------------------------------------------------------------------------------------------------------| | ||
| | --no-color | Disables color in output. | No | Only works in non-interactive mode. In interactive mode, disabling color might not work with some UI components. | | ||
| | -P, --profile string | Specifies the active [user profile](/tidb-cloud/cli-reference.md#user-profile) used in this command. | No | Works in both non-interactive and interactive modes. | | ||
| | -D, --debug | Enables debug mode. | No | Works in both non-interactive and interactive modes. | | ||
|
|
||
| ## Feedback | ||
|
|
||
| If you have any questions or suggestions on the TiDB Cloud CLI, feel free to create an [issue](https://github.com/tidbcloud/tidbcloud-cli/issues/new/choose). Also, we welcome any contributions. |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
preview: https://pingcap-docsite-preview-git-pr-qiancais-projects.vercel.app/tidbcloud/cli-reference