Overview of TiUP commands

TiUP assumes the function of package manager in the TiDB ecosystem, and manages many components in the TiDB ecosystem, such as TiDB, PD, TiKV, etc.

Syntax

tiup [flags] [args...] # execute command # or tiup [flags] [args...] # run component

Use the --help command to get information about a specific command, with a summary of each command showing its parameters and their usage.Required parameters are shown in angle brackets, optional parameters are shown in square brackets.

represents the command name. For a list of supported commands, please refer to the following Command List, represents a componentname, please refer to the list of supported components belowComponent List.

options

-B, --binary

Print the binary file path of the specified component:

• Executing tiup -B/--binary will print the path to the latest stable version of the installed component, if If the component is not installed, an error is reported
• Executing tiup -B/--binary : will print the componentcode> The path where the version is located, if the version is not installed, an error will be reported
• Data type: BOOLEAN
• This option is disabled by default, and the default value is false.Add this option to the command and pass in the true value or no value to enable this function.

Note

This option can only be used for commands of the form tiup [flags] [args...] .

--binpath (string)

Specify the path of the component to be executed: When executing a component, if you do not want to use the binary file in the TiUP image, you can use this parameter to replace it with the binary file of the custom path.

Note

This option can only be used for commands of the form tiup [flags] [args...] .

--skip-version-check

Note

This option is deprecated as of v1.3.0.

• Skip the validity check of the version number. The version number specified by default can only be Semantic Version.
• Data type: BOOLEAN
• This option is disabled by default, and the default value is false.Add this option to the command and pass in the true value or no value to enable this function.

-T, --tag (string)

Specify a tag for the started component: some components need to use disk storage during the execution process. TiUP will allocate a temporary directory as the storage directory for the current execution of the component. If you want to allocate a fixedDirectory, you can use -T/--tag to specify the directory name, so that multiple executions using the same tag can read and write to the same batch of files.

-v, --version

Print the version of TiUP

--help

Print help information

command list

TiUP contains many commands, and these commands contain many subcommands. Please refer to the corresponding links for the description of specific commands and their subcommands:

• install: Install Components
• list: View a list of components
• uninstall: Uninstall a component
• update: upgrade installed components
• status: View component running status
• clean: clean component data directory
• mirror: Mirror Management
• telemetry: telemetry switch
• completion: TiUP command completion
• env: View TiUP related environment variables
• help: View help documentation for a specific command or component

Component List

• cluster: Production TiDB Cluster Management
• dm: Production DM Cluster Management