Important

You are viewing the archived documentation of TiDB, which no longer receives updates. It is recommended that you use the latest LTS version of the TiDB database.

TiUP Documentation Map

User guide

TiUP Overview: Gives an overall introduction to TiUP, for example, how to install and use TiUP, and the related terminologies.
TiUP Terminology and Concepts: Explains the terms that you might bump into when using TiUP, and help you understand the key concepts of TiUP
TiUP Component Management: Introduces all TiUP commands in detail, and how to use TiUP to download, update and delete components
TiUP FAQ: Introduces common issues when you use TiUP, including FAQs of the third-party components of TiUP
TiUP Troubleshooting Guide: Introduces the troubleshooting methods and solutions if you encounter issues when using TiUP
TiUP Reference Guide: Introduces detailed references, including commands, components, and mirrors.

TiUP resources

TiUP Release Notes
TiUP Issues: Lists TiUP GitHub issues

Download PDF