Important

You are viewing the documentation of an older version of the TiDB database (TiDB v5.0).

It is recommended that you use the latest LTS version of the TiDB database.

tiup cluster help

tiup-cluster provides a wealth of help information for users in the command line interface. You can obtain it via the help command or the --help option. tiup cluster help <command> is basically equivalent to tiup cluster <command> --help.

Syntax

tiup cluster help [command] [flags]

[command] is used to specify the help information of which command that users need to view. If it is not specified, the help information of tiup-cluster is viewed.

-h, --help

  • Prints the help information.
  • Data type: BOOLEAN
  • Default: false

Output

The help information of the [command] or tiup-cluster.

<< Back to the previous page - TiUP Cluster command list

Was this page helpful?