1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
|
[](https://github.com/pingcap/tiup/blob/master/LICENSE)
[](https://golang.org/)
[](https://goreportcard.com/badge/github.com/pingcap/tiup)
[](https://codecov.io/gh/pingcap/tiup/)
[](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
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fpingcap%2Ftiup?ref=badge_large)
|
