这个项目能做什么
tldr-pages 是一个协作项目,收集由社区维护的命令行工具帮助页。它的目标是成为传统 man 手册页更简单、更友好的补充,重点放在实用示例上,而不是面面俱到的完整手册。该仓库持续扩充,覆盖 UNIX、Linux、macOS、FreeBSD、NetBSD、OpenBSD、SunOS、Android、Windows、Cisco IOS 和 DOS 等命令行环境中的常见工具示例。
README 说明,该项目的初衷是解决典型 man 页难以阅读的问题:用户想查常见用法,但第一条解释可能却在讲磁带驱动器的块大小。相比之下,tldr 页面直接给出简洁的日常示例,例如如何解压 tar 归档。
使用方式包括官方客户端:
- Python 客户端:可通过 pipx 或其他包管理器安装。
- Rust 客户端(tlrc):可通过 Homebrew、Cargo 或 Windows 上的 Winget 安装。
- Node.js 客户端:可通过 npm install -g tldr 安装,但更新相对滞后。
用户也可以通过 tldr.inbrowser.app 的网页客户端浏览,该站点支持以 PWA 方式离线使用;还可以从最新 release 下载页面 PDF。多数语言的翻译版本也提供 PDF。
项目向所有人开放贡献。贡献方式包括补充尚未收录的常用命令、改进现有页面、处理标记为 “help wanted” 的 issue,以及将页面翻译成不同语言。页面使用 Markdown 编写,便于编辑并通过 pull request 提交。项目强调友好、协作的社区氛围,并提供贡献指南与治理文档。此外还有翻译进度站点和 Matrix 聊天室。
README 还列出了类似项目,如 cheat.sh、devhints、eg、kb、navi、cheat、Command Line Interface Pages,以及已弃用的 bropages。
TL;DR 是 “Too Long; Didn't Read” 的缩写,体现了该项目提供快速、易读命令帮助,而不是冗长文档的宗旨。
评论
0 评分人数达到10人后显示
登录后参与讨论。