命令行工具帮助文档TLDR

TLDR Pages 是一个开源的、社区驱动的命令行工具帮助文档项目，旨在为 Linux、macOS、Windows 和其他操作系统的命令行工具提供简洁、实用的示例，帮助用户快速掌握命令的使用方法，而无需阅读冗长的 man 手册页。

1. 项目简介

TLDR（“Too Long; Didn’t Read”）的理念是简化命令行工具的帮助信息，只提供最常用的使用示例，而非像 man 手册那样包含大量技术细节。

• GitHub 地址: https://github.com/tldr-pages/tldr
• 官网: https://tldr.sh/
• 许可证: MIT（自由使用和修改）
• 社区驱动: 由全球开发者共同维护，任何人都可以贡献内容。

2. 核心特点

(1) 简洁实用

• 每个命令的文档通常只包含 5-10 个最常见的使用示例，避免冗余信息。
• 示例代码直观，便于快速上手。

示例（tar 命令）：

# 查看 tar 命令的 TLDR 文档
tldr tar

# 输出示例
tar

Archiving utility.
Often combined with a compression method, 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:
  tar xf source.tar[.gz|.bz2|.xz]

- List contents of an archive:
  tar tf source.tar

（相比 man tar 的数千行文档，TLDR 更直观）。

(2) 多平台支持

• 支持的命令行工具：Linux、macOS、Windows（如 cmd、PowerShell）。
• 支持的客户端：
  • Node.js: npm install -g tldr
  • Python: pip install tldr
  • Rust: brew install tldr（macOS）
  • Web 版: https://tldr.ostera.io/
  • 移动端：Android/iOS 客户端（如 tldr-flutter）。

(3) 社区驱动，持续更新

• 任何人都可以提交新的命令文档或改进现有内容。
• 更新方式：
  • 手动更新本地缓存: tldr --update
  • 提交 PR 到 GitHub 仓库（Markdown 格式）。

(4) 多语言支持

• 支持 20+ 语言（包括中文），可通过 tldr --language zh 查看中文版。

3. 适用人群

• 命令行新手：快速学习常用命令。
• 偶尔使用命令的用户：避免反复查阅 man 手册。
• 高级用户：快速回忆复杂命令的用法。
• 跨平台开发者：支持 Windows/Linux/macOS 命令查询。

4. 如何安装 & 使用

(1) 安装方法

# Node.js（推荐）
npm install -g tldr

# Python
pip install tldr

# macOS（Homebrew）
brew install tldr

# Linux（Debian/Ubuntu）
sudo apt install tldr

(2) 基本使用

# 查询命令（如 `ls`）
tldr ls

# 更新本地缓存（获取最新命令文档）
tldr --update

# 查看可用命令列表
tldr --list

# 指定语言（如中文）
tldr --language zh tar

(3) 高级用法

• 自定义别名（如 alias help='tldr'）
• 离线使用（默认缓存到 ~/.local/share/tldr）
• 集成到 Shell（如 zsh/bash 自动补全）。

5. 与 man 和 --help 的对比

（TLDR 更适合快速查询，而 man 适合深入理解）。

6. 如何贡献？

TLDR 鼓励用户提交新命令或改进现有文档：

1. Fork 仓库: https://github.com/tldr-pages/tldr
2. 编辑 Markdown 文件（pages/ 目录）
3. 提交 PR（需通过 CI 检查）
4. 等待合并（社区审核）。

7. 总结

TLDR Pages 是命令行用户的“速查手册”，提供简洁、实用的命令示例，比 man 更易用，比 --help 更全面。它的社区驱动、跨平台、多语言支持使其成为开发者和运维人员的必备工具。

推荐场景：

• 快速查询命令用法（如 tar、ffmpeg）。
• 学习新命令（如 kubectl、docker）。
• 跨平台开发（Windows/Linux/macOS 通用）。

官网 & 安装: https://tldr.sh/