tldr

简介

tldr（Too Long; Didn’t Read）是一个社区驱动的命令行工具手册项目，旨在为常用命令提供简洁、实用的示例说明。相比传统的 man 手册页面，tldr 用直白的语言和具体的使用示例来解释命令，让你在几秒钟内就能找到想要的用法。

tldr 项目由全球数千名贡献者共同维护，涵盖了 Linux、macOS、Windows 等多个平台上的常用命令。每个页面都经过精心编写，包含最常见的使用场景和真实可用的命令示例。它不是 man 的完整替代，而是一个快速参考工具，帮助你迅速回忆起命令的核心用法。

安装

# macOS
brew install tldr

# npm（Node.js 客户端）
npm install -g tldr

# pip（Python 客户端）
pip install tldr

# Cargo（Rust 客户端 tealdeer，更快）
cargo install tealdeer

核心特性

简洁实用: 每个命令仅展示最常用的使用场景
社区维护: 数千名贡献者共同维护，内容持续更新
跨平台: 涵盖 Linux、macOS、Windows、Android 等平台
多语言: 支持中文等多种语言的翻译版本
多客户端: 提供 Node.js、Python、Rust 等多种客户端实现
离线使用: 缓存页面后可离线查询

使用示例

# 查看命令的 tldr 页面
tldr tar

# 查看特定平台的命令
tldr --platform osx diskutil

# 更新本地缓存
tldr --update

# 查看中文版本（如果客户端支持）
tldr -L zh tar

# 列出所有可用的 tldr 页面
tldr --list

# 随机查看一个命令的用法
tldr --random

# 搜索相关命令
tldr --search "compress"

典型场景

场景一：忘记 tar 解压参数时

tar 的参数谁都会忘，tldr 比 man 快 10 倍：

tldr tar
# 立刻看到：
# - tar -xf archive.tar.gz         # 解压
# - tar -czf archive.tar.gz dir/   # 打包压缩
# - tar -tf archive.tar.gz         # 列出内容

# 对比 man tar（几百行，需要自己找）
man tar | wc -l   # 通常 400+ 行

场景二：搭配 fzf 交互式查找命令用法

不知道用什么命令解决问题时，用 fzf 浏览 tldr 库：

# 交互式搜索所有 tldr 页面，右侧实时预览
tldr --list | fzf --preview 'tldr {}' --preview-window=right:70%

# 加到 .zshrc 中方便调用
alias tldrf='tldr --list | fzf --preview "tldr {}" --preview-window=right:70%'

场景三：新机器上快速学习系统命令

在 Linux 服务器上接触不熟悉的系统命令：

# 先更新缓存
tldr --update

# 查看平台专属命令（如 macOS 的 diskutil）
tldr --platform osx diskutil
tldr --platform linux systemctl
tldr --platform linux journalctl

# 随机浏览，拓宽命令视野
tldr --random

简介