From 560df7cdf46880dbb4e43816bede1f30e433682c Mon Sep 17 00:00:00 2001 From: Ti Chi Robot Date: Tue, 30 Jan 2024 10:10:52 +0800 Subject: [PATCH] tiup: Update tiup-overview.md (#16166) (#16418) --- tiup/tiup-overview.md | 68 ++++++++++++++++++++++++++----------------- 1 file changed, 41 insertions(+), 27 deletions(-) diff --git a/tiup/tiup-overview.md b/tiup/tiup-overview.md index 0d2780282b80..490d5e36256e 100644 --- a/tiup/tiup-overview.md +++ b/tiup/tiup-overview.md @@ -30,6 +30,13 @@ curl --proto '=https' --tlsv1.2 -sSf https://tiup-mirrors.pingcap.com/install.sh tiup --version ``` +```bash +1.14.0 tiup +Go Version: go1.21.4 +Git Ref: v1.14.0 +GitHash: c3e9fc518aea0da66a37f82ee5a516171de9c372 +``` + > **注意：** > > 对于 v1.11.3 及以上版本的 TiUP，默认不会收集使用情况信息分享给 PingCAP。若要了解所收集的信息详情及如何关闭分享行为，请参见[遥测](/telemetry.md)。 @@ -58,6 +65,19 @@ the latest stable version will be downloaded from the repository. Usage: tiup [flags] [args...] tiup [flags] [args...] + tiup [command] + +Examples: + $ tiup playground # Quick start + $ tiup playground nightly # Start a playground with the latest nightly version + $ tiup install [:version] # Install a component of specific version + $ tiup update --all # Update all installed components to the latest version + $ tiup update --nightly # Update all installed components to the nightly version + $ tiup update --self # Update the "tiup" to the latest version + $ tiup list # Fetch the latest supported components list + $ tiup status # Display all running/terminated instances + $ tiup clean # Clean the data of running/terminated instance (Kill process if it's running) + $ tiup clean --all # Clean the data of all running/terminated instances Available Commands: install Install a specific version of a component @@ -67,33 +87,21 @@ Available Commands: status List the status of instantiated components clean Clean the data of instantiated components mirror Manage a repository mirror for TiUP components - help Help about any command or component - -Components Manifest: - use "tiup list" to fetch the latest components manifest + telemetry Controls things about telemetry + env Show the list of system environment variable that related to TiUP + history Display the historical execution record of TiUP, displays 100 lines by default + link Link component binary to $TIUP_HOME/bin/ + unlink Unlink component binary to $TIUP_HOME/bin/ + help Help about any command + completion Generate the autocompletion script for the specified shell Flags: --binary [:version] Print binary path of a specific version of a component [:version] and the latest version installed will be selected if no version specified --binpath string Specify the binary path of component instance -h, --help help for tiup - -T, --tag string Specify a tag for component instance - -v, --version version for tiup - -Component instances with the same "tag" will share a data directory ($TIUP_HOME/data/$tag): - $ tiup --tag mycluster playground - -Examples: - $ tiup playground # Quick start - $ tiup playground nightly # Start a playground with the latest nightly version - $ tiup install [:version] # Install a component of specific version - $ tiup update --all # Update all installed components to the latest version - $ tiup update --nightly # Update all installed components to the nightly version - $ tiup update --self # Update the "tiup" to the latest version - $ tiup list # Fetch the latest supported components list - $ tiup status # Display all running/terminated instances - $ tiup clean # Clean the data of running/terminated instance (Kill process if it's running) - $ tiup clean --all # Clean the data of all running/terminated instances + -T, --tag string [Deprecated] Specify a tag for component instance + -v, --version Print the version of tiup Use "tiup [command] --help" for more information about a command. ``` @@ -101,18 +109,24 @@ Use "tiup [command] --help" for more information about a command. 输出的帮助信息较长，你可以只关注两部分： - 可用的命令 - - install：用于安装组件 - - list：查看可用组件列表 - - uninstall：卸载组件 + - install：用于安装特定版本的组件 + - list：查看可用组件列表或组件可用版本列表 + - uninstall：卸载组件或组件版本 - update：更新组件版本 - status：查看组件运行记录 - clean：清除组件运行记录 - mirror：从官方镜像克隆一个私有镜像 + - telemetry：控制遥测功能 + - env：显示与 TiUP 相关的系统环境变量列表 + - history：显示 TiUP 的历史执行记录，默认显示 100 行 + - link：将组件二进制文件链接到 `$TIUP_HOME/bin/` + - unlink：取消组件二进制文件到 `$TIUP_HOME/bin/` 的链接 - help：输出帮助信息 + - completion：为指定的 shell（bash、zsh、fish、powershell）生成命令行自动补全脚本 - 可用的组件 - - playground：在本机启动集群 - - client：连接本机的集群 - - cluster：部署用于生产环境的集群 + - playground：在本机启动一个 TiDB 集群 + - client：连接 TiUP Playground 的客户端 + - cluster：部署用于生产环境的 TiDB 集群 - bench：对数据库进行压力测试 > **注意：**