feat(cmd): add flag to disable progress ps info (#1241)

Author: iyear

app/dl/dl.go

@@ -99,7 +99,9 @@ func Run(ctx context.Context, c *telegram.Client, kvd storage.Storage, opts Opti
 
 	dlProgress := prog.New(utils.Byte.FormatBinaryBytes)
 	dlProgress.SetNumTrackersExpected(it.Total())
-	prog.EnablePS(ctx, dlProgress)
+	if !viper.GetBool(consts.FlagDisableProgressPS) {
+		prog.EnablePS(ctx, dlProgress)
+	}
 
 	options := downloader.Options{
 		Pool:     pool,

app/forward/forward.go

@@ -80,7 +80,9 @@ func Run(ctx context.Context, c *telegram.Client, kvd storage.Storage, opts Opti
 
 	fwProgress := prog.New(pw.FormatNumber)
 	fwProgress.SetNumTrackersExpected(totalMessages(dialogs))
-	prog.EnablePS(ctx, fwProgress)
+	if !viper.GetBool(consts.FlagDisableProgressPS) {
+		prog.EnablePS(ctx, fwProgress)
+	}
 
 	fw := forwarder.New(forwarder.Options{
 		Pool: pool,

app/up/up.go

@@ -90,7 +90,9 @@ func Run(ctx context.Context, c *telegram.Client, kvd storage.Storage, opts Opti
 
 	upProgress := prog.New(utils.Byte.FormatBinaryBytes)
 	upProgress.SetNumTrackersExpected(len(files))
-	prog.EnablePS(ctx, upProgress)
+	if !viper.GetBool(consts.FlagDisableProgressPS) {
+		prog.EnablePS(ctx, upProgress)
+	}
 
 	options := uploader.Options{
 		Client:   pool.Default(ctx),

cmd/root.go

@@ -166,6 +166,7 @@ func New() *cobra.Command {
 
 	cmd.PersistentFlags().String(consts.FlagNTP, "", "ntp server host, if not set, use system time")
 	cmd.PersistentFlags().Duration(consts.FlagReconnectTimeout, 5*time.Minute, "Telegram client reconnection backoff timeout, infinite if set to 0") // #158
+	cmd.PersistentFlags().Bool(consts.FlagDisableProgressPS, false, "disable progress ps, which may cause display issues in some terminals")         // #850
 
 	// completion
 	_ = cmd.RegisterFlagCompletionFunc(consts.FlagNamespace, func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {

docs/content/en/guide/global-config.md

@@ -106,3 +106,11 @@ Set higher delay time if you want to avoid Telegram's flood control.
 {{< command >}}
 tdl --delay 5s
 {{< /command >}}
+
+## `--disable-progress-ps`
+
+Disable progress CPU/memory usage stats, which may cause display issues in some terminals. Default: `false`.
+
+{{< command >}}
+tdl --disable-progress-ps
+{{< /command >}}

docs/content/en/more/env.md

@@ -11,19 +11,20 @@ The values of all environment variables have a lower priority than flags.
 
 Avoid typing the same flag values repeatedly every time by setting environment variables.
 
-|          NAME           |         FLAG          |
-|:-----------------------:|:---------------------:|
-|        `TDL_NS`         |       `-n/--ns`       |
-|       `TDL_PROXY`       |       `--proxy`       |
-|      `TDL_STORAGE`      |      `--storage`      |
-|       `TDL_DEBUG`       |       `--debug`       |
-|       `TDL_SIZE`        |      `-s/--size`      |
-|      `TDL_THREADS`      |    `-t/--threads`     |
-|       `TDL_LIMIT`       |     `-l/--limit`      |
-|       `TDL_POOL`        |       `--pool`        |
-|        `TDL_NTP`        |        `--ntp`        |
-| `TDL_RECONNECT_TIMEOUT` | `--reconnect-timeout` |
-|     `TDL_TEMPLATE`      |    dl `--template`    |
+|           NAME            |          FLAG           |
+|:-------------------------:|:-----------------------:|
+|         `TDL_NS`          |        `-n/--ns`        |
+|        `TDL_PROXY`        |        `--proxy`        |
+|       `TDL_STORAGE`       |       `--storage`       |
+|        `TDL_DEBUG`        |        `--debug`        |
+|        `TDL_SIZE`         |       `-s/--size`       |
+|       `TDL_THREADS`       |     `-t/--threads`      |
+|        `TDL_LIMIT`        |      `-l/--limit`       |
+|        `TDL_POOL`         |        `--pool`         |
+|         `TDL_NTP`         |         `--ntp`         |
+|  `TDL_RECONNECT_TIMEOUT`  |  `--reconnect-timeout`  |
+| `TDL_DISABLE_PROGRESS_PS` | `--disable-progress-ps` |
+|      `TDL_TEMPLATE`       |     dl `--template`     |
 
 {{< hint warning >}}
 - `TDL_STORAGE` format in env is different from that in flags: `{"type": "bolt", "path": "/path/to/data-dir"}` (JSON object).

docs/content/zh/guide/global-config.md

@@ -2,6 +2,7 @@
 title: "全局设置"
 weight: 10
 ---
+
 # 全局配置
 
 全局配置是可以在每个命令中设置的选项。
@@ -106,3 +107,10 @@ tdl --pool 2
 tdl --delay 5s
 {{< /command >}}
 
+## `--disable-progress-ps`
+
+禁用进度条CPU/内存使用统计信息，这可能会在某些终端中导致显示问题。默认值：`false`。
+
+{{< command >}}
+tdl --disable-progress-ps
+{{< /command >}}

docs/content/zh/more/env.md

@@ -11,19 +11,20 @@ weight: 20
 
 通过设置环境变量，避免在每次重复输入相同的命令行选项。
 
-|          环境变量           |         对应选项          |
-|:-----------------------:|:---------------------:|
-|        `TDL_NS`         |       `-n/--ns`       |
-|       `TDL_PROXY`       |       `--proxy`       |
-|      `TDL_STORAGE`      |      `--storage`      |
-|       `TDL_DEBUG`       |       `--debug`       |
-|       `TDL_SIZE`        |      `-s/--size`      |
-|      `TDL_THREADS`      |    `-t/--threads`     |
-|       `TDL_LIMIT`       |     `-l/--limit`      |
-|       `TDL_POOL`        |       `--pool`        |
-|        `TDL_NTP`        |        `--ntp`        |
-| `TDL_RECONNECT_TIMEOUT` | `--reconnect-timeout` |
-|     `TDL_TEMPLATE`      |    dl `--template`    |
+|           环境变量            |          对应选项           |
+|:-------------------------:|:-----------------------:|
+|         `TDL_NS`          |        `-n/--ns`        |
+|        `TDL_PROXY`        |        `--proxy`        |
+|       `TDL_STORAGE`       |       `--storage`       |
+|        `TDL_DEBUG`        |        `--debug`        |
+|        `TDL_SIZE`         |       `-s/--size`       |
+|       `TDL_THREADS`       |     `-t/--threads`      |
+|        `TDL_LIMIT`        |      `-l/--limit`       |
+|        `TDL_POOL`         |        `--pool`         |
+|         `TDL_NTP`         |         `--ntp`         |
+|  `TDL_RECONNECT_TIMEOUT`  |  `--reconnect-timeout`  |
+| `TDL_DISABLE_PROGRESS_PS` | `--disable-progress-ps` |
+|      `TDL_TEMPLATE`       |     dl `--template`     |
 
 {{< hint warning >}}
 - `TDL_STORAGE` 环境变量的格式与命令行选项不同：`{"type": "bolt", "path": "/path/to/data-dir"}` (JSON 对象)。

go.work.sum

@@ -46,8 +46,6 @@ github.com/census-instrumentation/opencensus-proto v0.4.1 h1:iKLQ0xPNFxR/2hzXZMr
 github.com/census-instrumentation/opencensus-proto v0.4.1/go.mod h1:4T9NM4+4Vw91VeyqjLS6ao50K5bOcLKN6Q42XnYaRYw=
 github.com/cespare/xxhash/v2 v2.2.0 h1:DC2CZ1Ep5Y4k3ZQ899DldepgrayRUGE6BBZ/cd9Cj44=
 github.com/cespare/xxhash/v2 v2.2.0/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs=
-github.com/cespare/xxhash/v2 v2.3.0 h1:UL815xU9SqsFlibzuggzjXhog7bL6oX9BbNZnL2UFvs=
-github.com/cespare/xxhash/v2 v2.3.0/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs=
 github.com/chzyer/readline v1.5.1 h1:upd/6fQk4src78LMRzh5vItIt361/o4uq553V8B5sGI=
 github.com/chzyer/readline v1.5.1/go.mod h1:Eh+b79XXUwfKfcPLepksvw2tcLE/Ct21YObkaSkeBlk=
 github.com/cncf/xds/go v0.0.0-20240905190251-b4127c9b8d78 h1:QVw89YDxXxEe+l8gU8ETbOasdwEV+avkR75ZzsVV9WI=
@@ -62,7 +60,6 @@ github.com/cockroachdb/redact v1.1.5 h1:u1PMllDkdFfPWaNGMyLD1+so+aq3uUItthCFqzwP
 github.com/cockroachdb/redact v1.1.5/go.mod h1:BVNblN9mBWFyMyqK1k3AAiSxhvhfK2oOZZ2lK+dpvRg=
 github.com/cockroachdb/tokenbucket v0.0.0-20230807174530-cc333fc44b06 h1:zuQyyAKVxetITBuuhv3BI9cMrmStnpT18zmgmTxunpo=
 github.com/cockroachdb/tokenbucket v0.0.0-20230807174530-cc333fc44b06/go.mod h1:7nc4anLGjupUW/PeY5qiNYsdNXj7zopG+eqsS7To5IQ=
-github.com/coder/websocket v1.8.14 h1:9L0p0iKiNOibykf283eHkKUHHrpG7f65OE3BhhO7v9g=
 github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E=
 github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f h1:lO4WD4F/rVNCu3HqELle0jiPLLBs70cWOduZpkS1E78=
 github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f/go.mod h1:cuUVRXasLTGF7a8hSLbxyZXjz+1KgoB3wDUb6vlszIc=
@@ -159,10 +156,7 @@ github.com/klauspost/cpuid/v2 v2.2.6/go.mod h1:Lcz8mBdAVJIBVzewtcLocK12l3Y+JytZY
 github.com/kr/fs v0.1.0 h1:Jskdu9ieNAYnjxsi0LbQp1ulIKZV1LAFgK1tWhpZgl8=
 github.com/kr/fs v0.1.0/go.mod h1:FFnZGqtBN9Gxj7eW1uZ42v5BccTP0vu6NEaFoC2HwRg=
 github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo=
-github.com/kr/pretty v0.2.1/go.mod h1:ipq/a2n7PKx3OHsz4KJII5eveXtPO4qwEXGdVfWzfnI=
 github.com/kr/pty v1.1.1 h1:VkoXIwSboBpnk99O/KFauAEILuNHv5DVFKZMBN/gUgw=
-github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
-github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
 github.com/minio/md5-simd v1.1.2 h1:Gdi1DZK69+ZVMoNHRXJyNcxrMA4dSxoYHZSQbirFg34=
 github.com/minio/md5-simd v1.1.2/go.mod h1:MzdKDxYpY2BT9XQFocsiZf/NKVtR7nkE4RoEpN+20RM=
 github.com/minio/minio-go/v7 v7.0.69 h1:l8AnsQFyY1xiwa/DaQskY4NXSLA2yrGsW5iD9nRPVS0=
@@ -177,7 +171,6 @@ github.com/modern-go/reflect2 v1.0.2 h1:xBagoLtFs94CBntxluKeaWgTMpvLxC4ur3nMaC9G
 github.com/modern-go/reflect2 v1.0.2/go.mod h1:yWuevngMOJpCy52FWWMvUC8ws7m/LJsjYzDa0/r8luk=
 github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 h1:C3w9PqII01/Oq1c1nUAm88MOHcQC9l5mIlSMApZMrHA=
 github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822/go.mod h1:+n7T8mK8HuQTcFwEeznm/DIxMOiR9yIdICNftLE1DvQ=
-github.com/ogen-go/ogen v1.19.0 h1:YvdNpeQJ8A8dLLpS6Vs4WxXL53BT6tBPxH0VSjfALhA=
 github.com/pbnjay/memory v0.0.0-20210728143218-7b4eea64cf58 h1:onHthvaw9LFnH4t2DcNVpwGmV9E1BkGknEliJkfwQj0=
 github.com/pbnjay/memory v0.0.0-20210728143218-7b4eea64cf58/go.mod h1:DXv8WO4yhMYhSNPKjeNKa5WY9YCIEBRbNzFFPJbWO6Y=
 github.com/pkg/diff v0.0.0-20210226163009-20ebb0f2a09e h1:aoZm08cpOy4WuID//EZDgcC4zIxODThtZNPirFr42+A=
@@ -221,8 +214,6 @@ github.com/sebdah/goldie/v2 v2.5.3/go.mod h1:oZ9fp0+se1eapSRjfYbsV/0Hqhbuu3bJVvK
 github.com/sergi/go-diff v1.0.0/go.mod h1:0CfEIISq7TuYL3j771MWULgwwjU+GofnZX9QAmXWZgo=
 github.com/sergi/go-diff v1.1.0 h1:we8PVUC3FE2uYfodKH/nBHMSetSfHDR6scGdBi+erh0=
 github.com/sergi/go-diff v1.1.0/go.mod h1:STckp+ISIX8hZLjrqAeVduY0gWCT9IjLuqbuNXdaHfM=
-github.com/shopspring/decimal v1.4.0 h1:bxl37RwXBklmTi0C79JfXCEBD1cqqHt0bbgBAGFp81k=
-github.com/shopspring/decimal v1.4.0/go.mod h1:gawqmDU56v4yIKSwfBSFip1HdCCXN8/+DMd9qYNcwME=
 github.com/stretchr/objx v0.5.2 h1:xuMeJ0Sdp5ZMRXx/aWO6RZxdr3beISkG5/G/aIRr3pY=
 github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA=
 github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
@@ -242,8 +233,6 @@ go.etcd.io/gofail v0.1.0 h1:XItAMIhOojXFQMgrxjnd2EIIHun/d5qL0Pf7FzVTkFg=
 go.etcd.io/gofail v0.1.0/go.mod h1:VZBCXYGZhHAinaBiiqYvuDynvahNsAyLFwB3kEHKz1M=
 go.opencensus.io v0.24.0 h1:y73uSU6J157QMP2kn2r30vwW1A2W2WFwSCGnAVxeaD0=
 go.opencensus.io v0.24.0/go.mod h1:vNK8G9p7aAivkbmorf4v+7Hgx+Zs0yY+0fOtgBfjQKo=
-go.opentelemetry.io/auto/sdk v1.2.1 h1:jXsnJ4Lmnqd11kwkBV2LgLoFMZKizbCi5fNZ/ipaZ64=
-go.opentelemetry.io/auto/sdk v1.2.1/go.mod h1:KRTj+aOaElaLi+wW1kO/DZRXwkF4C5xPbEe3ZiIhN7Y=
 go.opentelemetry.io/collector/pdata v1.36.0 h1:jg7s08dKxWaA/o5NHiFW7Hjyxp1n4xEOMQpoCztiyJk=
 go.opentelemetry.io/collector/pdata v1.36.0/go.mod h1:pttpb089864qG1k0DMeXLgwwTFLk+o3fAW9I6MF9tzw=
 go.opentelemetry.io/contrib/bridges/otelzap v0.12.0 h1:FGre0nZh5BSw7G73VpT3xs38HchsfPsa2aZtMp0NPOs=
@@ -364,6 +353,8 @@ golang.org/x/telemetry v0.0.0-20260109210033-bd525da824e2 h1:O1cMQHRfwNpDfDJerqR
 golang.org/x/telemetry v0.0.0-20260109210033-bd525da824e2/go.mod h1:b7fPSJ0pKZ3ccUh8gnTONJxhn3c/PS6tyzQvyqw4iA8=
 golang.org/x/telemetry v0.0.0-20260209163413-e7419c687ee4 h1:bTLqdHv7xrGlFbvf5/TXNxy/iUwwdkjhqQTJDjW7aj0=
 golang.org/x/telemetry v0.0.0-20260209163413-e7419c687ee4/go.mod h1:g5NllXBEermZrmR51cJDQxmJUHUOfRAaNyWBM+R+548=
+golang.org/x/telemetry v0.0.0-20260409153401-be6f6cb8b1fa h1:efT73AJZfAAUV7SOip6pWGkwJDzIGiKBZGVzHYa+ve4=
+golang.org/x/telemetry v0.0.0-20260409153401-be6f6cb8b1fa/go.mod h1:kHjTxDEnAu6/Nl9lDkzjWpR+bmKfxeiRuSDlsMb70gE=
 golang.org/x/term v0.5.0/go.mod h1:jMB1sMXY+tzblOD4FWmEbocvup2/aLOaQEp7JmGp78k=
 golang.org/x/term v0.8.0/go.mod h1:xPskH00ivmX89bAKVGSKKtLOWNx2+17Eiy94tnKShWo=
 golang.org/x/term v0.12.0/go.mod h1:owVbMEjm3cBLCHdkQu9b1opXd4ETQWc3BhuQGKgXgvU=
@@ -403,8 +394,6 @@ google.golang.org/grpc v1.67.3 h1:OgPcDAFKHnH8X3O4WcO4XUc8GRDeKsKReqbQtiCj7N8=
 google.golang.org/grpc v1.67.3/go.mod h1:YGaHCc6Oap+FzBJTZLBzkGSYt/cvGPFTPxkn7QfSU8s=
 google.golang.org/grpc v1.74.0 h1:sxRSkyLxlceWQiqDofxDot3d4u7DyoHPc7SBXMj8gGY=
 google.golang.org/grpc v1.74.0/go.mod h1:NZUaK8dAMUfzhK6uxZ+9511LtOrk73UGWOFoNvz7z+s=
-gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk=
-gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q=
 gopkg.in/ini.v1 v1.67.0 h1:Dgnx+6+nfE+IfzjUEISNeydPJh9AXNNsWbGP9KzCsOA=
 gopkg.in/ini.v1 v1.67.0/go.mod h1:pNLf8WUiyNEtQjuu5G5vTm06TEv9tsIgeAvK8hOrP4k=
 gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=

pkg/consts/flag.go

@@ -1,16 +1,17 @@
 package consts
 
 const (
-	FlagStorage          = "storage"
-	FlagProxy            = "proxy"
-	FlagNamespace        = "ns"
-	FlagDebug            = "debug"
-	FlagPartSize         = "size" // Deprecated: all part size should be set to maximum by default
-	FlagThreads          = "threads"
-	FlagLimit            = "limit"
-	FlagPoolSize         = "pool"
-	FlagDelay            = "delay"
-	FlagNTP              = "ntp"
-	FlagReconnectTimeout = "reconnect-timeout"
-	FlagDlTemplate       = "template"
+	FlagStorage           = "storage"
+	FlagProxy             = "proxy"
+	FlagNamespace         = "ns"
+	FlagDebug             = "debug"
+	FlagPartSize          = "size" // Deprecated: all part size should be set to maximum by default
+	FlagThreads           = "threads"
+	FlagLimit             = "limit"
+	FlagPoolSize          = "pool"
+	FlagDelay             = "delay"
+	FlagNTP               = "ntp"
+	FlagReconnectTimeout  = "reconnect-timeout"
+	FlagDisableProgressPS = "disable-progress-ps"
+	FlagDlTemplate        = "template"
 )