什么是 tldr？
tldr-pages 是一个由社区驱动的项目，为命令行工具提供简化、实用的示例。它被设计为传统 man 手册页的一种更快捷、更易于访问的替代品。与密集、详尽的文档不同，tldr 只为您提供常见的用例和清晰、可复制粘贴的示例。名称 “tldr” 是 “Too Long; Didn’t Read”（太长；没读）的缩写，完美地体现了其为开发者节省时间的使命。
主要特点
- 实用示例： 专注于 80% 的用例，提供简单、真实的示例。
- 社区驱动： 备忘单由全球开发者社区贡献和维护。
- 多平台客户端： 为几乎所有操作系统和环境提供了众多客户端，包括 Node.js、Python、Go、Rust 等。
- 广泛的命令覆盖： 包含数千个常用和冷门命令行工具的页面。
- 易于贡献： 贡献过程简单明了，鼓励用户通过 GitHub 拉取请求添加或改进页面。
使用场景
- 快速记忆命令： 立即找到您不常用的命令的正确语法，例如
tar或ffmpeg。 - 学习新工具： 无需阅读冗长的文档即可快速上手新的 CLI 工具。
- 脚本编写辅助： 查找可在 shell 脚本中使用的常见命令模式。
- 日常终端使用： 对于任何花时间在命令行中的开发者来说，都是一个首选参考。
入门指南
开始使用 tldr 需要安装一个客户端。Node.js 客户端是最受欢迎的之一。
- 使用 npm 安装客户端：
npm install -g tldr - 用它来查询一个命令：
例如，要查看
tar命令的常见示例：tldr tar输出将类似于：
# tar > 归档工具。 > 通常与压缩方法（如 gzip 或 bzip2）结合使用。 > 更多信息：<https://www.gnu.org/software/tar/>。 - 从文件创建归档： tar cf 目标文件.tar 文件1 文件2 文件3 - 创建一个 gzip 压缩的归档： tar czf 目标文件.tar.gz 文件1 文件2 文件3 - 将（压缩的）归档解压到当前目录： tar xf 源文件.tar[.gz|.bz2|.xz] - 列出归档的内容： tar tf 源文件.tar
定价
tldr 是完全开源的。文档页面（基于 CC BY-SA 4.0 许可）和各种客户端（大多基于 MIT 许可）都可以免费使用、修改和分发。