tldr

tldr — 帮你快速读懂复杂命令的用法，不用再翻冗长的 man 手册。

如果你是一个经常和终端打交道的开发者，一定有过这样的经历：明明记得某个命令，但就是想不起它的参数；或者第一次接触一个工具，打开 man 手册，结果满屏的英文选项看得头皮发麻。这时候，你最需要的不是一本“字典”，而是一张“小抄”——tldr 就是这张小抄。

这个工具到底是干什么的？

tldr 的全称是“Too Long; Didn’t Read”，这名字本身就是一种自嘲：你不需要读那些又臭又长的官方文档，我只给你最常用的命令示例。它解决的痛点是：

• man 手册太臃肿：一个 tar 命令的手册能写几十页，但 90% 的人只用 -xzf 和 -czf 两个参数。
• 记忆成本高：不是每个人都是命令行大佬，偶尔用一次的命令，谁记得住 ffmpeg 的转码参数？
• 跨平台需求：你在 macOS 上用的 brew，到了 Ubuntu 上变成 apt，tldr 会自动帮你适配当前系统的命令。

简单说，tldr 就是命令行的“速查卡片”——告诉你“这个命令怎么用”，而不是“这个命令是什么”。

下载方式

tldr 是一个开源项目，它本身是一个客户端，用来从社区维护的仓库里拉取命令示例。官方推荐用 Node.js 版本，但如果你不想装 Node，也有各种语言的实现。我这里推荐最主流的两个：

• Node.js 版本（功能最全，更新快）：
  tldr 官方 Node.js 客户端
• Python 版本（轻量，适合 Python 用户）：
  tldr Python 客户端

当然，如果你用的是 macOS 且有 Homebrew，可以直接装 Python 版，一行命令搞定（见下文）。

安装方法

1. Node.js 版（推荐）

如果你已经装了 Node.js（版本 >= 14），直接全局安装：

npm install -g tldr

装完运行 tldr --version 验证，如果显示版本号，就成功了。

2. Python 版

需要 Python 3.6+，用 pip 安装：

pip install tldr

如果你在 macOS 上，Homebrew 也能装：

brew install tldr

注意：Homebrew 默认安装的是 Python 版，不是 Node 版。两者功能几乎一样，但 Node 版的输出排版更现代一些。

3. 其他平台

• Windows：可以用 scoop install tldr（需先装 scoop），或者直接用 npm 安装。
• Linux：除了 npm，也可以用 apt install tldr（Debian/Ubuntu），但仓库里的版本可能比较老，建议还是用 npm。

基础使用教程

装好之后，打开终端，输入 tldr 加上你想查的命令，比如：

tldr tar

你会看到类似这样的输出：

tar

  Archiving utility.
  Often combined with compression methods, such as gzip or bzip2.

  - Create an archive from files:
    tar cf target.tar file1 file2 file3

  - Create a gzipped archive:
    tar czf target.tar.gz file1 file2 file3

  - Extract an archive in the current directory:
    tar xf source.tar

  - Extract a gzipped archive:
    tar xzf source.tar.gz

看到没？没有废话，直接给你最常用的几个场景。每个例子前面有个小圆点，命令部分高亮显示，一眼就能找到你要的参数。

常用操作：

1. 查一个命令：tldr <命令名>
   比如 tldr curl、tldr git、tldr docker。

2. 更新本地缓存：tldr 会缓存命令示例，定期更新：

   tldr --update
   

   建议每周跑一次，因为社区经常有人添加新命令的示例。

3. 列出所有可用命令：

   tldr --list
   

   会显示当前缓存中所有命令的列表，方便你发现一些没听过的小工具。

4. 搜索命令：如果你只记得命令包含某个关键词，可以用 -s 参数：

   tldr -s "compress"
   

   它会搜索所有命令描述里包含“compress”的命令，比如 gzip、bzip2、xz 等。

进阶技巧

1. 用 alias 覆盖 man

如果你平时习惯用 man 但受不了它的啰嗦，可以在 shell 配置里加一个 alias：

alias man='tldr'

这样你输入 man tar 时，实际上会调用 tldr。注意：有些命令可能没有 tldr 示例，这时候它会提示“这个命令没有收录”，你可以再手动调用真正的 man。

2. 自定义输出语言

tldr 支持多语言，但默认是英文。如果你想看中文示例，可以设置环境变量：

export TLDR_LANG=zh

然后运行 tldr tar，就会显示中文翻译的示例。不过中文示例的覆盖度没有英文高，有些冷门命令可能还是英文。

3. 离线使用

tldr 默认会把命令缓存到本地，所以第一次查一个命令时会联网下载，之后就可以断网使用了。如果你要完全离线，可以一次性缓存所有命令：

tldr --list-all

它会拉取整个命令库，大概几十 MB，之后你连网都不用连。

4. 集成到编辑器

如果你是 Vim 用户，可以在 .vimrc 里加一行：

command! Tldr :!tldr <cword>

然后在编辑代码时，光标停在某个命令上，输入 :Tldr 就能直接弹出 tldr 结果。VS Code 用户也可以搜“tldr”插件，直接在编辑器里查。

5. 贡献示例

tldr 是一个开源社区项目，任何人都可以去 GitHub 仓库 提交命令示例。如果你发现某个命令没有收录，或者现有示例有错误，可以直接提 PR。格式很简单，就是一个 Markdown 文件，写几个常用场景。这也是你参与开源的一个好起点。

一点个人感受

我用了 tldr 大概三年，它已经成为我终端里使用频率最高的工具之一。尤其是当你同时维护多个项目，需要在不同语言、不同工具链之间切换时，tldr 就像是一个随身携带的“命令速查本”。它不会教你深入原理，但能让你在 10 秒内搞定一个临时任务。

当然，它也有局限。比如有些命令参数特别多（比如 ffmpeg），tldr 只能覆盖最常用的 5-8 个场景。这时候你还是得去翻 man 或者看官方文档。但话说回来，80% 的情况下，你需要的只是那 20% 的常用参数——tldr 恰好抓住了这 20%。

如果你还没试过，现在就去装一个吧。相信我，你会感谢自己这个决定的。