Sign InTry Free

tiup cluster edit-config

If you need to modify the cluster configuration after the cluster is deployed, you can use the tiup cluster edit-config command that starts an editor for you to modify the topology file of a cluster. This editor is specified in the $EDITOR environment variable by default. If the $EDITOR environment variable does not exist, the vi editor is used.


tiup cluster edit-config <cluster-name> [flags]

<cluster-name> is the cluster to operate on.


-h, --help

  • Prints help information.
  • Data type: BOOLEAN
  • This option is disabled by default and its default value is false. To enable this option, you can add this option to the command, and pass the true value or do not pass any value.


  • If the command is successfully executed, there is no output.
  • If you have mistakenly modified the fields that cannot be modified, when you save the file, an error will be reported, reminding you to edit the file again. For the fields that cannot be modified, see the topology file.

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

Download PDFRequest docs changesAsk questions on TiDB ForumEdit this page
Was this page helpful?
TiDB Cloud
Get Demo
© 2023 PingCAP. All Rights Reserved.