Skip to content

Commit

Permalink
refine descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
@qiancai
qiancai committed Apr 11, 2024
1 parent 51709cc commit 3b2b3f8
Show file tree
Hide file tree
Showing 37 changed files with 233 additions and 232 deletions.
4 changes: 2 additions & 2 deletions tidb-cloud/cli-reference.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ To use the `ticloud` CLI in your terminal, run `ticloud [command] [subcommand]`.
| auth | login, logout | Login and logout |
| serverless | create, delete, describe, list, update, spending-limit, regions, shell | Manage TiDB Serverless clusters |
| serverless branch | create, delete, describe, list, shell | Manage TiDB Serverless branches |
| serverless import | cancel, describe, list, start | Manage [import](/tidb-cloud/tidb-cloud-migration-overview.md#import-data-from-files-to-tidb-cloud) tasks |
| serverless export | create, describe, list, cancel, download | Manage TiDB Serverless export jobs |
| serverless import | cancel, describe, list, start | Manage TiDB Serverless [import](/tidb-cloud/tidb-cloud-migration-overview.md#import-data-from-files-to-tidb-cloud) tasks |
| serverless export | create, describe, list, cancel, download | Manage TiDB Serverless export tasks |
| ai | - | Chat with TiDB Bot |
| completion | bash, fish, powershell, zsh | Generate completion script for specified shell |
| config | create, delete, describe, edit, list, set, use | Configure user profiles |
Expand Down
10 changes: 5 additions & 5 deletions tidb-cloud/ticloud-ai.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ summary: The reference of `ticloud ai`.

# ticloud ai

Chat with TiDB Bot
Chat with TiDB Bot:

```shell
ticloud ai [flags]
Expand All @@ -31,16 +31,16 @@ In non-interactive mode, you need to manually enter the required flags. In inter

| Flag | Description | Required | Note |
|--------------------|-----------------------------------|----------|------------------------------------------------------|
| -q, --query string | The query to chat with TiDB Bot | Yes | Only works in non-interactive mode. |
| -h, --help | Help information for this command | No | Works in both non-interactive and interactive modes. |
| -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 | 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 | Enable debug mode | No | Works in both non-interactive and interactive modes. |
| -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

Expand Down
8 changes: 4 additions & 4 deletions tidb-cloud/ticloud-auth-login.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,16 +31,16 @@ In non-interactive mode, you need to manually enter the required flags. In inter

| Flag | Description | Required | Note |
|--------------------|---------------------------------------------------------------------------|----------|------------------------------------------------------|
| --insecure-storage | Save authentication credentials in plain text instead of credential store | No | Works in both non-interactive and interactive modes. |
| -h, --help | Help information for this command | No | Works in both non-interactive and interactive modes. |
| --insecure-storage | Saves authentication credentials in plain text instead of credential store. | No | Works in both non-interactive and interactive modes. |
| -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 | 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 | Enable debug mode. | No | Works in both non-interactive and interactive modes. |
| -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

Expand Down
4 changes: 2 additions & 2 deletions tidb-cloud/ticloud-auth-logout.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ ticloud auth logout
| 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 | 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 | Enable debug mode. | No | Works in both non-interactive and interactive modes. |
| -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

Expand Down
14 changes: 7 additions & 7 deletions tidb-cloud/ticloud-branch-create.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,21 @@ summary: The reference of `ticloud serverless branch create`.

# ticloud serverless branch create

Create a branch for a serverless cluster:
Create a [branch](/tidb-cloud/branch-overview.md) for a TiDB Serverless cluster:

```shell
ticloud serverless branch create [flags]
```

## Examples

Create a serverless branch in interactive mode:
Create a branch for a TiDB Serverless cluster in interactive mode:

```shell
ticloud serverless branch create
```

Create a serverless branch in non-interactive mode:
Create a branch for a TiDB Serverless cluster in non-interactive mode:

```shell
ticloud serverless branch create --cluster-id <cluster-id> --display-name <branch-name>
Expand All @@ -31,17 +31,17 @@ In non-interactive mode, you need to manually enter the required flags. In inter

| Flag | Description | Required | Note |
|---------------------------|------------------------------------------------------------|----------|-----------------------------------------------------|
| -c, --cluster-id string | The ID of the cluster, in which the branch will be created | Yes | Only works in non-interactive mode. |
| -n, --display-name string | The display name of the branch to be created | Yes | Only works in non-interactive mode. |
| -h, --help | Get help information for this command | No | Works in both non-interactive and interactive modes |
| -c, --cluster-id string | Specifies the ID of the cluster, in which the branch will be created. | Yes | Only works in non-interactive mode. |
| -n, --display-name string | Specifies the name of the branch to be created. | 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 | Enable debug mode | No | Works in both non-interactive and interactive modes. |
| -D, --debug | Enables debug mode. | No | Works in both non-interactive and interactive modes. |

## Feedback

Expand Down
18 changes: 9 additions & 9 deletions tidb-cloud/ticloud-branch-delete.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless branch delete`.

# ticloud serverless branch delete

Delete a branch from your serverless cluster:
Delete a branch from your TiDB Serverless cluster:

```shell
ticloud serverless branch delete [flags]
Expand All @@ -19,13 +19,13 @@ ticloud serverless branch rm [flags]

## Examples

Delete a serverless branch in interactive mode:
Delete a TiDB Serverless branch in interactive mode:

```shell
ticloud serverless branch delete
```

Delete a serverless branch in non-interactive mode:
Delete a TiDB Serverless branch in non-interactive mode:

```shell
ticloud branch delete --branch-id <branch-id> --cluster-id <cluster-id>
Expand All @@ -37,18 +37,18 @@ In non-interactive mode, you need to manually enter the required flags. In inter

| Flag | Description | Required | Note |
|-------------------------|--------------------------------------------|----------|------------------------------------------------------|
| -b, --branch-id string | The ID of the branch to be deleted | Yes | Only works in non-interactive mode. |
| --force | Deletes a branch without confirmation | No | Works in both non-interactive and interactive modes. |
| -h, --help | Help information for this command | No | Works in both non-interactive and interactive modes. |
| -c, --cluster-id string | The cluster ID of the branch to be deleted | Yes | Only works in non-interactive mode. |
| -b, --branch-id string | Specifies the ID of the branch to be deleted. | Yes | Only works in non-interactive mode. |
| --force | Deletes a branch without confirmation. | No | Works in both non-interactive and interactive modes. |
| -h, --help | Shows help information for this command. | No | Works in both non-interactive and interactive modes. |
| -c, --cluster-id string | Specifies the ID of the cluster. | Yes | Only works in non-interactive mode. |

## 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 | 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 | Enable debug mode | No | Works in both non-interactive and interactive modes. |
| -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

Expand Down
Loading

0 comments on commit 3b2b3f8

Please sign in to comment.