Skip to content

Latest commit

 

History

History
58 lines (39 loc) · 2.75 KB

ticloud-cluster-list.md

File metadata and controls

58 lines (39 loc) · 2.75 KB
title summary
ticloud cluster list
The reference of `ticloud cluster list`.

ticloud cluster list

List all clusters in a project:

ticloud cluster list <project-id> [flags]

Or use the following alias command:

ticloud cluster ls <project-id> [flags]

Examples

List all clusters in a project (interactive mode):

ticloud cluster list

List all clusters in a specified project (non-interactive mode):

ticloud cluster list <project-id>

List all clusters in a specified project in the JSON format:

ticloud cluster list <project-id> -o json

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
-h, --help Help information for this command No Works in both non-interactive and interactive modes.
-o, --output string Output format (human by default). Valid values are human or json. To get a complete result, use the json format. 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 used in this command. 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. Also, we welcome any contributions.