3pointer / tiup

A component manager for TiDB

What is TiUP

tiup is a tool to download and install TiDB components.

Documentation

• English
• 简体中文

Blog

• English
• 简体中文

Installation

curl --proto '=https' --tlsv1.2 -sSf https://tiup-mirrors.pingcap.com/install.sh | sh

Quick start

Run playground

tiup playground

Install components

tiup install tidb tikv pd

Uninstall components

tiup uninstall tidb tikv pd

Update components

tiup update --all

Usage

After installing tiup, you can use it to install binaries of TiDB components and create clusters.

See our doc for more information on how to use TiUp.

Contributing to TiUP

Contributions of code, tests, docs, and bug reports are welcome! To get started, take a look at our open issues.

For docs on how to build, test, and run TiUP, see our dev docs.

See also the Contribution Guide in PingCAP's community repo.

License