pingcap/tiup

A component manager for TiDB

466

stars

1,820

commits

Go

primary language

Sep 9, 2026

updated

tiup.io
cluster
playground
tidb
tidb-components
tiup
Browse cluster: TiDB distributed database ecosystem

README

LICENSE Language Go Report Card Coverage Status FOSSA Status

What is TiUP

tiup is a tool to download and install TiDB components.

Documentation

Blog

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

FOSSA Status

Contributors

(top 30 of 141)

AstroProfundis

306 commits

lucklove

246 commits

lonng

237 commits

nexustar

154 commits

pingcap/tiup

A component manager for TiDB

466

stars

1,820

commits

Go

primary language

Sep 9, 2026

updated

tiup.io
cluster
playground
tidb
tidb-components
tiup
Browse cluster: TiDB distributed database ecosystem

README

LICENSE Language Go Report Card Coverage Status FOSSA Status

What is TiUP

tiup is a tool to download and install TiDB components.

Documentation

Blog

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

FOSSA Status

Contributors

(top 30 of 141)

AstroProfundis

306 commits

lucklove

246 commits

lonng

237 commits

nexustar

154 commits

Languages

Go

94.8%

Shell

3.6%

Go Template

1.1%