https://github.com/pingcap/tiup

A component manager for TiDB
https://github.com/pingcap/tiup

cluster playground tidb tidb-components tiup

Last synced: 2 days ago
JSON representation

A component manager for TiDB

• Host: GitHub
• URL: https://github.com/pingcap/tiup
• Owner: pingcap
• License: apache-2.0
• Created: 2020-02-20T14:21:21.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2025-04-02T04:02:12.000Z (11 days ago)
• Last Synced: 2025-04-03T17:48:52.566Z (9 days ago)
• Topics: cluster, playground, tidb, tidb-components, tiup
• Language: Go
• Homepage: https://tiup.io
• Size: 13.8 MB
• Stars: 435
• Watchers: 20
• Forks: 319
• Open Issues: 333
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

• awesome-starts - pingcap/tiup - A component manager for TiDB (Go)

README

        
[![LICENSE](https://img.shields.io/github/license/pingcap/tidb.svg)](https://github.com/pingcap/tiup/blob/master/LICENSE)

[![Language](https://img.shields.io/badge/Language-Go-blue.svg)](https://golang.org/)

[![Go Report Card](https://goreportcard.com/badge/github.com/pingcap/tiup)](https://goreportcard.com/badge/github.com/pingcap/tiup)

[![Coverage Status](https://codecov.io/gh/pingcap/tiup/branch/master/graph/badge.svg)](https://codecov.io/gh/pingcap/tiup/)

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fpingcap%2Ftiup.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fpingcap%2Ftiup?ref=badge_shield)

# What is TiUP

`tiup` is a tool to download and install [TiDB](https://docs.pingcap.com/tidb/stable/overview) components.

## Documentation

- [English](https://docs.pingcap.com/tidb/stable/tiup-documentation-guide)

- [简体中文](https://docs.pingcap.com/zh/tidb/stable/tiup-documentation-guide)

## Blog

- [English](https://pingcap.com/blog/)

- [简体中文](https://pingcap.com/blog-cn/)

## Installation

```sh

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

```

## Quick start

### Run playground

```sh

tiup playground

```

### Install components

```sh

tiup install tidb tikv pd

```

### Uninstall components

```sh

tiup uninstall tidb tikv pd

```

### Update components

```sh

tiup update --all

```

## Usage

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

See our [doc](doc/user/README.md) 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](https://github.com/pingcap/tiup/issues).

For docs on how to build, test, and run TiUP, see our [dev docs](doc/dev/README.md).

See also the [Contribution Guide](https://github.com/pingcap/community/blob/master/contributors/README.md) in PingCAP's

[community](https://github.com/pingcap/community) repo.

## License

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fpingcap%2Ftiup.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fpingcap%2Ftiup?ref=badge_large)