From 9b0a48073850777814371ae704fb77fa9389aa57 Mon Sep 17 00:00:00 2001 From: TomShawn <41534398+TomShawn@users.noreply.github.com> Date: Wed, 14 Apr 2021 13:13:07 +0800 Subject: [PATCH 1/5] tiup: add tiup-reference.md --- tiup/tiup-reference.md | 87 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 87 insertions(+) create mode 100644 tiup/tiup-reference.md diff --git a/tiup/tiup-reference.md b/tiup/tiup-reference.md new file mode 100644 index 0000000000000..1c2e4ae794050 --- /dev/null +++ b/tiup/tiup-reference.md @@ -0,0 +1,87 @@ +--- +title: TiUP Reference +--- + +# TiUP Reference + +TiUP serves as the package manager of the TiDB ecosystem. It manages components in the TiDB ecosystem, such as TiDB, PD, and TiKV. + +## Syntax + +```shell +tiup [flags] [args...] # Executes a command +# or +tiup [flags] [args...] # Runs a component +``` + +You can use the `help` command to get the information of a specific command. The summary of each command shows its parameters and their usage. Required parameters are shown in angle brackets, and optional parameters are shown in square brackets. + +`` represents the command name. For the list of supported commands, see the [Command list](#command-list) below. `` represents the component name. For the list of supported components, see the [Component list](#component-list) below. + +## Options + +### -B, --binary + +- Data type: `BOOLEAN` +- This option is disabled by default and its default value is `false`. To enable this option, you can add this option to the command and pass in the `true` value or no value. +- If you enable this option, the specified binary file path is printed. + + - Executing `tiup -B/--binary ` will have the path of the latest stable installed `` component printed. If `` is not installed, an error is returned. + - Executing `tiup -B/--binary :` will have the path of the installed `` component's `` printed. If this `` is not printed, an error is returned. + +> **Note:** +> +> This option can only be used in commands of the `tiup [flags] [args...]` format. + +### --binpath + +- Data type: `STRING` +- Specifies the path of the component to be executed. When a component is executed, if you do not want to use the binary file in the TiUP mirror, you can add this option to specify using the binary file in a custom path. + +> **Note:** +> +> This option can only be used in commands of the `tiup [flags] [args...]` format. + +### --skip-version-check + +> **Note:** +> +> This option is deprecated since v1.3.0. + +- Data type: `BOOLEAN` +- This option is disabled by default and its default value is `false`. To enable this option, you can add this option to the command and pass in the `true` value or no value. +- Skips the validity check for version numbers. By default, the specified version number can only be the semantic version. + +### -T, --tag + +- Data type: `STRING` +- Specifies a tag for the component to be started. Some components need to use disk storage during the execution, and TiUP will allocate a temporary storage directory for this execution. If you want TiUP to allocate a fixed directory, you can use `-T/--tag` to specify the name of the directory, so that the same batch of files can be read and written in multiple executions with the same tag. + +### -v, --version + +Prints the TiUP version. + +### --help + +Prints the help information. + +## Command list + +TiUP has multiple commands, and these commands have multiple sub-commands. For the specific commands and their detailed descriptions, click the corresponding links in list below: + +- [install](/tiup/tiup-command-install.md): Installs a component. +- [list](/tiup/tiup-command-list.md): Shows the component list. +- [uninstall](/tiup/tiup-command-uninstall.md): Uninstalls a component. +- [update](/tiup/tiup-command-update.md): Updates the installed component. +- [status](/tiup/tiup-command-status.md): Shows the running status of a component. +- [clean](/tiup/tiup-command-clean.md): Cleans the data directory of a component. +- [mirror](/tiup/tiup-command-mirror.md): Manages the mirror. +- [telemetry](/tiup/tiup-command-telemetry.md): Enables or disables the telemetry. +- [completion](/tiup/tiup-command-completion.md): Completes the TiUP command. +- [env](/tiup/tiup-command-env.md): Shows the TiUP-related environment variables. +- [help](/tiup/tiup-command-help.md): Shows the help information of a command or component. + +## Component list + +- [cluster](/tiup/tiup-component-cluster.md): Manages the TiDB cluster in a production environment. +- [dm](/tiup/tiup-component-dm.md): Manages the TiDB Data Migration (DM) cluster in a production environment. From 3fa136ce8ea493e22f05bbe0f3766a20f052446d Mon Sep 17 00:00:00 2001 From: TomShawn <41534398+TomShawn@users.noreply.github.com> Date: Thu, 15 Apr 2021 13:25:32 +0800 Subject: [PATCH 2/5] clarify the default false value for the boolean type --- tiup/tiup-command-list.md | 6 +++--- tiup/tiup-command-mirror-clone.md | 4 ++-- tiup/tiup-command-mirror-genkey.md | 4 ++-- tiup/tiup-command-mirror-publish.md | 2 +- tiup/tiup-command-uninstall.md | 4 ++-- tiup/tiup-command-update.md | 8 ++++---- tiup/tiup-component-cluster-audit.md | 2 +- tiup/tiup-component-cluster-clean.md | 8 ++++---- tiup/tiup-component-cluster-deploy.md | 12 ++++++------ tiup/tiup-component-cluster-destroy.md | 4 ++-- tiup/tiup-component-cluster-disable.md | 2 +- tiup/tiup-component-cluster-display.md | 4 ++-- tiup/tiup-component-cluster-edit-config.md | 6 +++--- tiup/tiup-component-cluster-list.md | 2 +- tiup/tiup-reference.md | 6 +++--- 15 files changed, 37 insertions(+), 37 deletions(-) diff --git a/tiup/tiup-command-list.md b/tiup/tiup-command-list.md index 4c352cb35d781..8cfece3d5d8a4 100644 --- a/tiup/tiup-command-list.md +++ b/tiup/tiup-command-list.md @@ -20,19 +20,19 @@ tiup list [component] [flags] - Displays all components. By default, TiUP does not show hidden components. - Data type: `BOOLEAN` -- Default: false +- This option is disabled by default and its default value is `false`. To enable this option, you can add this option to the command, and pass the `true` value or do not pass any value. ### --installed - Only displays components and versions that have been installed. - Data type: `BOOLEAN` -- Default: false +- This option is disabled by default and its default value is `false`. To enable this option, you can add this option to the command, and pass the `true` value or do not pass any value. ### --verbose - Displays installed component versions in the components list. - Data type: `BOOLEAN` -- Default: false +- This option is disabled by default and its default value is `false`. To enable this option, you can add this option to the command, and pass the `true` value or do not pass any value. ## Outputs diff --git a/tiup/tiup-command-mirror-clone.md b/tiup/tiup-command-mirror-clone.md index 2af806c724c61..7dc70a7a1d2e2 100644 --- a/tiup/tiup-command-mirror-clone.md +++ b/tiup/tiup-command-mirror-clone.md @@ -21,7 +21,7 @@ tiup mirror clone [global version] [flags] - Whether to clone the whole mirror. If this option is set, other options becomes ignored and TiUP completely clones all components of all versions from the targeted mirror. - Data type: `BOOLEAN` -- Default: false +- This option is disabled by default and its default value is `false`. To enable this option, you can add this option to the command, and pass the `true` value or do not pass any value. ### -a, --arch @@ -39,7 +39,7 @@ tiup mirror clone [global version] [flags] - Whether to only match the prefix of versions. By default, TiUP downloads a component version when it is strictly matched. If this option is set, TiUP also downloads component versions of which prefixes are matched. - Data type: `BOOLEAN` -- Default: false +- This option is disabled by default and its default value is `false`. To enable this option, you can add this option to the command, and pass the `true` value or do not pass any value. ### --{component} diff --git a/tiup/tiup-command-mirror-genkey.md b/tiup/tiup-command-mirror-genkey.md index 3f41ef43a0e7b..fe4076b8b1346 100644 --- a/tiup/tiup-command-mirror-genkey.md +++ b/tiup/tiup-command-mirror-genkey.md @@ -35,13 +35,13 @@ tiup mirror genkey [flags] - Shows the corresponding public key of the private key specified in the option `-n/--name`. - TiUP does not create a new private key when `-p/--public` is specified. If the private key specified in `-n/--name` does not exist, TiUP returns an error. - Data type: `BOOLEAN` -- Default: false +- This option is disabled by default and its default value is `false`. To enable this option, you can add this option to the command, and pass the `true` value or do not pass any value. ### --save - Saves the information of the public key as a file in the current directory. The file name is `{hash-prefix}-public.json`. `hash-prefix` is the first 16 bits of the key ID. - Data type: `BOOLEAN` -- Default: false +- This option is disabled by default and its default value is `false`. To enable this option, you can add this option to the command, and pass the `true` value or do not pass any value. ## Outputs diff --git a/tiup/tiup-command-mirror-publish.md b/tiup/tiup-command-mirror-publish.md index 1011c379ecce4..5cdbc7d20c429 100644 --- a/tiup/tiup-command-mirror-publish.md +++ b/tiup/tiup-command-mirror-publish.md @@ -73,7 +73,7 @@ The meaning of each parameter is as follows: - Controls whether the component can run standalone. This option is currently **NOT available**. - Data type: `BOOLEAN` -- Default: false +- This option is disabled by default and its default value is `false`. To enable this option, you can add this option to the command, and pass the `true` value or do not pass any value. ## Outputs diff --git a/tiup/tiup-command-uninstall.md b/tiup/tiup-command-uninstall.md index 324c32c19c20e..abd0143212fbd 100644 --- a/tiup/tiup-command-uninstall.md +++ b/tiup/tiup-command-uninstall.md @@ -22,13 +22,13 @@ tiup uninstall : [component2...N] [flags] - Uninstalls all installed versions of the specified component(s). You must use this option when `` is omitted. - Data type: `BOOLEAN` -- Default: `false` +- This option is disabled by default and its default value is `false`. To enable this option, you can add this option to the command, and pass the `true` value or do not pass any value. ### --self - Uninstalls TiUP itself. When this option is used, all data downloaded from the mirror is deleted, but the data generated by TiUP and its components is retained. The data is stored in the directory specified by the `TIUP_HOME` environment variable. If `TIUP_HOME` is not set, the default value is `~/.tiup/`. - Data type: `BOOLEAN` -- Default: `false` +- This option is disabled by default and its default value is `false`. To enable this option, you can add this option to the command, and pass the `true` value or do not pass any value. ## Outputs diff --git a/tiup/tiup-command-update.md b/tiup/tiup-command-update.md index f90e632e3290a..2b9c00c0d0b96 100644 --- a/tiup/tiup-command-update.md +++ b/tiup/tiup-command-update.md @@ -24,25 +24,25 @@ The update operation does not delete the old version. You can still specify usin - If no component is specified, this option must be specified. - Data type: `BOOLEAN` -- Default: `false` +- This option is disabled by default and its default value is `false`. To enable this option, you can add this option to the command, and pass the `true` value or do not pass any value. ### --force - If the specified version of the component is already installed, the update operation is skipped by default. Specifying this option will have the installed version forcibly updated. - Data type: `BOOLEAN` -- Default: `false` +- This option is disabled by default and its default value is `false`. To enable this option, you can add this option to the command, and pass the `true` value or do not pass any value. ### --nightly - Updates the specified components to the nightly version. The `tiup update` command with this option is equivalent to the `tiup update :nightly` command. - Data type: `BOOLEAN` -- Default: `false` +- This option is disabled by default and its default value is `false`. To enable this option, you can add this option to the command, and pass the `true` value or do not pass any value. ### --self - Updates TiUP itself. - Data type: `BOOLEAN` -- Default: `false` +- This option is disabled by default and its default value is `false`. To enable this option, you can add this option to the command, and pass the `true` value or do not pass any value. ## Outputs diff --git a/tiup/tiup-component-cluster-audit.md b/tiup/tiup-component-cluster-audit.md index bda5b0a3b8fb7..aeb0c7262b9d3 100644 --- a/tiup/tiup-component-cluster-audit.md +++ b/tiup/tiup-component-cluster-audit.md @@ -21,7 +21,7 @@ tiup cluster audit [audit-id] [flags] - Prints the help information. - Data type: `Boolean` -- Default: false +- This option is disabled by default and its default value is `false`. To enable this option, you can add this option to the command, and pass the `true` value or do not pass any value. ## Outputs diff --git a/tiup/tiup-component-cluster-clean.md b/tiup/tiup-component-cluster-clean.md index dca4ddbf42be1..8f5266cb1d063 100644 --- a/tiup/tiup-component-cluster-clean.md +++ b/tiup/tiup-component-cluster-clean.md @@ -24,7 +24,7 @@ tiup cluster clean [flags] - Cleans data and the log at the same time. It is equivalent to specifying `--data` and `--log` at the same time. - Data type: `BOOLEAN` -- Default: false +- This option is disabled by default and its default value is `false`. To enable this option, you can add this option to the command, and pass the `true` value or do not pass any value. - If it is not specified, you must specify at lease one of the following options: - --data: Cleans data - --log: Cleans the log @@ -33,13 +33,13 @@ tiup cluster clean [flags] - Cleans data. If neither of it nor `--all` is specified, data will not be cleaned. - Data type: `BOOLEAN` -- Default: false +- This option is disabled by default and its default value is `false`. To enable this option, you can add this option to the command, and pass the `true` value or do not pass any value. ### --log - Cleans the log. If neither of it nor `--all` is specified, the log will not be cleaned. - Data type: `BOOLEAN` -- Default: false +- This option is disabled by default and its default value is `false`. To enable this option, you can add this option to the command, and pass the `true` value or do not pass any value. ### --ignore-node @@ -57,7 +57,7 @@ tiup cluster clean [flags] - Prints help information. - Data type: `BOOLEAN` -- Default: false +- This option is disabled by default and its default value is `false`. To enable this option, you can add this option to the command, and pass the `true` value or do not pass any value. ## Output diff --git a/tiup/tiup-component-cluster-deploy.md b/tiup/tiup-component-cluster-deploy.md index 9b2ee76bc8c71..2f6026642ada9 100644 --- a/tiup/tiup-component-cluster-deploy.md +++ b/tiup/tiup-component-cluster-deploy.md @@ -34,12 +34,12 @@ tiup cluster deploy [flags] - Specifies the password used to connect to the target machine. Do not use it with `-i/--identity_file` at the same time. - Data type: `BOOLEAN` -- Default: false +- This option is disabled by default and its default value is `false`. To enable this option, you can add this option to the command, and pass the `true` value or do not pass any value. ### --ignore-config-check - This option is used to skip the configuration check. After the binary files of components are deployed, the configurations of TiDB, TiKV, and PD components are checked using ` --config-check `. `` is the path of the deployed binary file. `` is the configuration file generated based on the user configuration. -- Data type: `BOOLEAN` +- This option is disabled by default and its default value is `false`. To enable this option, you can add this option to the command, and pass the `true` value or do not pass any value. - Default: false ### --no-labels @@ -48,19 +48,19 @@ tiup cluster deploy [flags] - When two or more TiKV nodes are deployed on the same physical machine, a risk exists: PD cannot learn the cluster topology, so PD might schedule multiple replicas of a Region to different TiKV nodes on one physical machine, which makes this physical machine a single point. To avoid this risk, you can use labels to tell PD not to schedule the same Region to the same machine. See [Schedule Replicas by Topology Labels](/schedule-replicas-by-topology-labels.md) for label configuration. - For the test environment, this risk might matter and you can use `--no-labels` to skip the check. - Data type: `BOOLEAN` -- Default: false +- This option is disabled by default and its default value is `false`. To enable this option, you can add this option to the command, and pass the `true` value or do not pass any value. -### --skip-create-user（boolean，false） +### --skip-create-user - During the cluster deployment, tiup-cluster checks whether the specified user name in the topology file exists or not. If not, it creates one. To skip this check, you can use the `--skip-create-user` option. - Data type: `BOOLEAN` -- Default: false +- This option is disabled by default and its default value is `false`. To enable this option, you can add this option to the command, and pass the `true` value or do not pass any value. ### -h, --help - Prints help information. - Data type: `BOOLEAN` -- Default: false +- This option is disabled by default and its default value is `false`. To enable this option, you can add this option to the command, and pass the `true` value or do not pass any value. ## Output diff --git a/tiup/tiup-component-cluster-destroy.md b/tiup/tiup-component-cluster-destroy.md index fa6402bb00086..68d42263aabe1 100644 --- a/tiup/tiup-component-cluster-destroy.md +++ b/tiup/tiup-component-cluster-destroy.md @@ -24,7 +24,7 @@ tiup cluster destroy [flags] - In some cases, some nodes in the cluster have been down, making it impossible to connect to the node through SSH for operation. At this time, you can use the `--force` option to ignore these errors. - Data type: `Boolean` -- Default: false +- This option is disabled by default and its default value is `false`. To enable this option, you can add this option to the command, and pass the `true` value or do not pass any value. ### --retain-node-data @@ -42,7 +42,7 @@ tiup cluster destroy [flags] - Prints the help information. - Data type: `Boolean` -- Default: false +- This option is disabled by default and its default value is `false`. To enable this option, you can add this option to the command, and pass the `true` value or do not pass any value. ## Output diff --git a/tiup/tiup-component-cluster-disable.md b/tiup/tiup-component-cluster-disable.md index 3e8a9426c6862..48ddd1c816a77 100644 --- a/tiup/tiup-component-cluster-disable.md +++ b/tiup/tiup-component-cluster-disable.md @@ -40,7 +40,7 @@ tiup cluster disable [flags] - Outputs the help information. - Data type: `BOOLEAN` -- Default: false +- This option is disabled by default and its default value is `false`. To enable this option, you can add this option to the command, and pass the `true` value or do not pass any value. ## Output diff --git a/tiup/tiup-component-cluster-display.md b/tiup/tiup-component-cluster-display.md index 824627ae9459b..98afffe1a7023 100644 --- a/tiup/tiup-component-cluster-display.md +++ b/tiup/tiup-component-cluster-display.md @@ -20,7 +20,7 @@ tiup cluster display [flags] - By default, all node information of the entire cluster is displayed. With the `--dashboard` option, only dashboard information is displayed. - Data type: `BOOLEAN` -- Default: false +- This option is disabled by default and its default value is `false`. To enable this option, you can add this option to the command, and pass the `true` value or do not pass any value. ### -N, --node @@ -46,7 +46,7 @@ tiup cluster display [flags] - Prints the help information. - Data type: `BOOLEAN` -- Default: false +- This option is disabled by default and its default value is `false`. To enable this option, you can add this option to the command, and pass the `true` value or do not pass any value. ## Outputs diff --git a/tiup/tiup-component-cluster-edit-config.md b/tiup/tiup-component-cluster-edit-config.md index 541130cc61ed6..e7543b0a5e87f 100644 --- a/tiup/tiup-component-cluster-edit-config.md +++ b/tiup/tiup-component-cluster-edit-config.md @@ -25,9 +25,9 @@ tiup cluster edit-config [flags] - Prints help information. - Data type: `BOOLEAN` -- Default: false +- This option is disabled by default and its default value is `false`. To enable this option, you can add this option to the command, and pass the `true` value or do not pass any value. ## Output -- Normally, no output. -- If you have mistakenly modified the fields that cannot be modified, when you save the file, an error will be reported, reminding you to edit the file again. For the fields that cannot be modified, see topology file. +- If the command is successfully executed, there is no output. +- If you have mistakenly modified the fields that cannot be modified, when you save the file, an error will be reported, reminding you to edit the file again. For the fields that cannot be modified, see the topology file. diff --git a/tiup/tiup-component-cluster-list.md b/tiup/tiup-component-cluster-list.md index 755855845367c..c9510f89cd5e0 100644 --- a/tiup/tiup-component-cluster-list.md +++ b/tiup/tiup-component-cluster-list.md @@ -22,7 +22,7 @@ tiup cluster list [flags] - Prints help information. - Data type: `BOOLEAN` -- Default: false +- This option is disabled by default and its default value is `false`. To enable this option, you can add this option to the command, and pass the `true` value or do not pass any value. ## Outputs diff --git a/tiup/tiup-reference.md b/tiup/tiup-reference.md index 1c2e4ae794050..d4e27c8e1d86d 100644 --- a/tiup/tiup-reference.md +++ b/tiup/tiup-reference.md @@ -14,7 +14,7 @@ tiup [flags] [args...] # Executes a command tiup [flags] [args...] # Runs a component ``` -You can use the `help` command to get the information of a specific command. The summary of each command shows its parameters and their usage. Required parameters are shown in angle brackets, and optional parameters are shown in square brackets. +You can use the `help` command to get the information of a specific command. The summary of each command shows its parameters and their usage. Mandatory parameters are shown in angle brackets, and optional parameters are shown in square brackets. `` represents the command name. For the list of supported commands, see the [Command list](#command-list) below. `` represents the component name. For the list of supported components, see the [Component list](#component-list) below. @@ -23,7 +23,7 @@ You can use the `help` command to get the information of a specific command. The ### -B, --binary - Data type: `BOOLEAN` -- This option is disabled by default and its default value is `false`. To enable this option, you can add this option to the command and pass in the `true` value or no value. +- This option is disabled by default and its default value is `false`. To enable this option, you can add this option to the command, and pass the `true` value or do not pass any value. - If you enable this option, the specified binary file path is printed. - Executing `tiup -B/--binary ` will have the path of the latest stable installed `` component printed. If `` is not installed, an error is returned. @@ -49,7 +49,7 @@ You can use the `help` command to get the information of a specific command. The > This option is deprecated since v1.3.0. - Data type: `BOOLEAN` -- This option is disabled by default and its default value is `false`. To enable this option, you can add this option to the command and pass in the `true` value or no value. +- This option is disabled by default and its default value is `false`. To enable this option, you can add this option to the command, and pass the `true` value or do not pass any value. - Skips the validity check for version numbers. By default, the specified version number can only be the semantic version. ### -T, --tag From 746d8830fed2dabaaa6ffeaa94034cd0f79e4517 Mon Sep 17 00:00:00 2001 From: TomShawn <41534398+TomShawn@users.noreply.github.com> Date: Fri, 16 Apr 2021 10:30:04 +0800 Subject: [PATCH 3/5] Update tiup/tiup-reference.md Co-authored-by: JoyinQ <56883733+Joyinqin@users.noreply.github.com> --- tiup/tiup-reference.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tiup/tiup-reference.md b/tiup/tiup-reference.md index d4e27c8e1d86d..d280b48fd4882 100644 --- a/tiup/tiup-reference.md +++ b/tiup/tiup-reference.md @@ -67,7 +67,7 @@ Prints the help information. ## Command list -TiUP has multiple commands, and these commands have multiple sub-commands. For the specific commands and their detailed descriptions, click the corresponding links in list below: +TiUP has multiple commands, and these commands have multiple sub-commands. For the specific commands and their detailed descriptions, click the corresponding links in the list below: - [install](/tiup/tiup-command-install.md): Installs a component. - [list](/tiup/tiup-command-list.md): Shows the component list. From a0d7084a491c0b7f5eb0c62d77f7001f0d872b85 Mon Sep 17 00:00:00 2001 From: TomShawn <41534398+TomShawn@users.noreply.github.com> Date: Fri, 16 Apr 2021 10:30:20 +0800 Subject: [PATCH 4/5] Update tiup/tiup-reference.md Co-authored-by: JoyinQ <56883733+Joyinqin@users.noreply.github.com> --- tiup/tiup-reference.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tiup/tiup-reference.md b/tiup/tiup-reference.md index d280b48fd4882..86281e27dce88 100644 --- a/tiup/tiup-reference.md +++ b/tiup/tiup-reference.md @@ -55,7 +55,7 @@ You can use the `help` command to get the information of a specific command. The ### -T, --tag - Data type: `STRING` -- Specifies a tag for the component to be started. Some components need to use disk storage during the execution, and TiUP will allocate a temporary storage directory for this execution. If you want TiUP to allocate a fixed directory, you can use `-T/--tag` to specify the name of the directory, so that the same batch of files can be read and written in multiple executions with the same tag. +- Specifies a tag for the component to be started. Some components need to use disk storage during the execution, and TiUP allocates a temporary storage directory for this execution. If you want TiUP to allocate a fixed directory, you can use `-T/--tag` to specify the name of the directory, so that the same batch of files can be read and written in multiple executions with the same tag. ### -v, --version From e2a2c1651c6f4ddfa9165e4c9d39913b02b45175 Mon Sep 17 00:00:00 2001 From: TomShawn <41534398+TomShawn@users.noreply.github.com> Date: Fri, 16 Apr 2021 11:11:43 +0800 Subject: [PATCH 5/5] adjust order to make it consistent with other docs --- tiup/tiup-reference.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/tiup/tiup-reference.md b/tiup/tiup-reference.md index 86281e27dce88..dcca0f5dbc307 100644 --- a/tiup/tiup-reference.md +++ b/tiup/tiup-reference.md @@ -22,40 +22,41 @@ You can use the `help` command to get the information of a specific command. The ### -B, --binary -- Data type: `BOOLEAN` -- This option is disabled by default and its default value is `false`. To enable this option, you can add this option to the command, and pass the `true` value or do not pass any value. - If you enable this option, the specified binary file path is printed. - Executing `tiup -B/--binary ` will have the path of the latest stable installed `` component printed. If `` is not installed, an error is returned. - Executing `tiup -B/--binary :` will have the path of the installed `` component's `` printed. If this `` is not printed, an error is returned. +- Data type: `BOOLEAN` +- This option is disabled by default and its default value is `false`. To enable this option, you can add this option to the command, and pass the `true` value or do not pass any value. + > **Note:** > > This option can only be used in commands of the `tiup [flags] [args...]` format. ### --binpath -- Data type: `STRING` -- Specifies the path of the component to be executed. When a component is executed, if you do not want to use the binary file in the TiUP mirror, you can add this option to specify using the binary file in a custom path. - > **Note:** > > This option can only be used in commands of the `tiup [flags] [args...]` format. +- Specifies the path of the component to be executed. When a component is executed, if you do not want to use the binary file in the TiUP mirror, you can add this option to specify using the binary file in a custom path. +- Data type: `STRING` + ### --skip-version-check > **Note:** > > This option is deprecated since v1.3.0. +- Skips the validity check for version numbers. By default, the specified version number can only be the semantic version. - Data type: `BOOLEAN` - This option is disabled by default and its default value is `false`. To enable this option, you can add this option to the command, and pass the `true` value or do not pass any value. -- Skips the validity check for version numbers. By default, the specified version number can only be the semantic version. ### -T, --tag -- Data type: `STRING` - Specifies a tag for the component to be started. Some components need to use disk storage during the execution, and TiUP allocates a temporary storage directory for this execution. If you want TiUP to allocate a fixed directory, you can use `-T/--tag` to specify the name of the directory, so that the same batch of files can be read and written in multiple executions with the same tag. +- Data type: `STRING` ### -v, --version