Download TiDB Tools

This document describes how to download the TiDB Toolkit.

TiDB Toolkit contains frequently used TiDB tools, such as data export tool Dumpling, data import tool TiDB Lightning, and backup and restore tool BR.

Tip

If your deployment environment has internet access, you can deploy a TiDB tool using a single TiUP command, so there is no need to download the TiDB Toolkit separately.
If you need to deploy and maintain TiDB on Kubernetes, instead of downloading the TiDB Toolkit, follow the steps in TiDB Operator offline installation.

Environment requirements

Operating system: Linux
Architecture: amd64 or arm64

Download link

You can download TiDB Toolkit from the following link:

https://download.pingcap.org/tidb-community-toolkit-{version}-linux-{arch}.tar.gz

{version} in the link indicates the version number of TiDB and {arch} indicates the architecture of the system, which can be amd64 or arm64. For example, the download link for v8.4.0 in the amd64 architecture is https://download.pingcap.org/tidb-community-toolkit-v8.4.0-linux-amd64.tar.gz.

Note

If you need to download the PD Control tool pd-ctl, download the TiDB installation package separately from https://download.pingcap.org/tidb-community-server-{version}-linux-{arch}.tar.gz.

TiDB Toolkit description

Depending on which tools you want to use, you can install the corresponding offline packages as follows:

Tool	Offline package name
TiUP	`tiup-linux-{arch}.tar.gz` `tiup-{tiup-version}-linux-{arch}.tar.gz` `dm-{tiup-version}-linux-{arch}.tar.gz` `server-{version}-linux-{arch}.tar.gz`
Dumpling	`dumpling-{version}-linux-{arch}.tar.gz`
TiDB Lightning	`tidb-lightning-ctl` `tidb-lightning-{version}-linux-{arch}.tar.gz`
TiDB Data Migration (DM)	`dm-worker-{version}-linux-{arch}.tar.gz` `dm-master-{version}-linux-{arch}.tar.gz` `dmctl-{version}-linux-{arch}.tar.gz`
TiCDC	`cdc-{version}-linux-{arch}.tar.gz`
Backup & Restore (BR)	`br-{version}-linux-{arch}.tar.gz`
sync-diff-inspector	`sync_diff_inspector`
PD Recover	`pd-recover-{version}-linux-{arch}.tar`