tldr-pages 简明命令行手册
tldr-pages 是社区维护的命令行工具速查手册集合,用简洁示例替代冗长 man 手册,覆盖 Linux、macOS、Windows、Android 等平台,支持多语言与多种客户端。
过去 7 天收获 2 颗 Star
爱鲜报评分
0.0
0 人评分
64k
星数
是
中文
Markdown
主语言
是
活跃
3526
贡献者
人工分析
EDITORIAL推荐理由
man 手册信息量大但难读,tldr 用「一命令几示例」的方式直击常用场景,查 tar、lsof 等命令参数时效率极高。项目星标超 6.4 万、社区活跃、支持中文翻译,是开发者日常必备的查询工具。
适用场景
- 忘记 tar、lsof、find 等命令的常用参数时快速查阅
- 新接触某个 CLI 工具时先看典型用法示例
- 在服务器或本地终端离线查询命令示例
- 为团队或新人整理常用命令速查资料
- 参与开源翻译与文档贡献
优点
- 示例优先,比 man 手册更易读易记
- 覆盖 Linux、macOS、Windows、Android 等多平台
- 多语言翻译完善,含中文页面
- 客户端丰富,Python、Rust、Node.js 及网页版均可使用
- 社区活跃,页面持续更新
缺点
- 只给常用示例,不覆盖全部参数与边缘用法
- 需安装客户端或联网访问网页版才能使用
- 不同客户端更新进度不一致
- 页面质量依赖社区维护,个别命令可能缺失
上手难度
入门
项目简介
tldr-pages 是一个社区协作维护的命令行工具速查手册集合,目标是做传统 man 手册的「简化版补充」。它不追求穷举所有参数,而是用几个典型示例告诉你某个命令最常用的写法。
例如查 tar 时,man 手册可能先讲块大小,而 tldr 直接给出解压、打包等常见用法。
内容覆盖
- 平台:Linux、macOS、FreeBSD/NetBSD/OpenBSD、SunOS、Android、Windows、Cisco IOS、DOS 等
- 形式:每个命令一个 Markdown 页面,包含一句描述和若干带注释的示例
- 语言:支持多语言翻译,中文页面持续更新
使用方式
官方提供多种客户端,安装后即可用 tldr <命令> 查询:
# Python 客户端
pipx install tldr
# Rust 客户端(macOS/Linux)
brew install tlrc
# Node.js 客户端
npm install -g tldr
不想安装软件时,可使用网页版客户端,或下载项目发布的 PDF 版本离线查阅。
参与贡献
所有页面均为 Markdown,改动门槛低。可以补充未收录的命令、完善示例、认领 help wanted 任务,或参与翻译。首次贡献建议先阅读 CONTRIBUTING 指南,也可加入 Matrix 聊天室交流。
适用建议
适合作为日常命令查询的第一站:先看 tldr 示例快速上手,需要完整参数说明时再回到 man 手册。
评论
- 暂无评论,来写第一条吧。