Repolode
提交项目
tldr-pages

tldr-pages/tldr

社区维护的命令行工具速查手册，用简明实例代替冗长的 man 手册。

可替代:man pages

在 GitHub 查看官网
Star
64,007
Fork
5,500
未关闭 Issue
286
最近提交
5小时前

这是什么？

tldr-pages 是一个由社区维护的命令行工具速查手册。每个页面只挑选少量常用、实用的示例，而不是罗列所有参数，方便开发者快速回忆 tar、lsof 等命令的用法。

内容覆盖 UNIX、Linux、macOS、BSD 系列、SunOS、Android、Windows、Cisco IOS 和 DOS 下的常用工具。页面使用 Markdown 编写，通过 Pull Request 参与贡献，并维护多种语言的翻译版本。

官方提供 Python、Rust、Node.js 等多种客户端，也有支持离线 PWA 的网页版，无需安装即可浏览；发布版本中还附带 PDF 版本。

核心功能

  • 01为常用命令提供简明示例，而非穷举所有参数
  • 02覆盖 Linux、macOS、BSD、Windows、Android 等多个平台
  • 03页面为纯 Markdown，可通过 Pull Request 轻松编辑
  • 04提供官方 Python、Rust、Node.js 客户端及网页版
  • 05提供多种语言的翻译版本

适用场景

  • 快速回忆不常用命令的正确参数
  • 通过实用示例学习不熟悉的命令行工具
  • 借助 PDF 或离线网页版在无网络环境下查阅命令帮助
  • 为缺少简明速查文档的工具补充示例

快速上手

  1. 1

    使用 pipx 安装官方 Python 客户端

    pipx install tldr
  2. 2

    查看命令的速查示例，例如 tar

    tldr tar

使用前须知

  • 元数据中的许可证为 NOASSERTION，复用前请查看 LICENSE 文件。
  • 官方 Node.js 客户端的更新已经落后。

标签

#cheatsheet#command-line#cli#documentation#linux#macos#shell#man-pages#android#bsd

常见问题

tldr 是什么？
社区维护的命令行工具速查手册，用简明实例代替冗长的 man 手册。 tldr-pages 是一个由社区维护的命令行工具速查手册。每个页面只挑选少量常用、实用的示例，而不是罗列所有参数，方便开发者快速回忆 tar、lsof 等命令的用法。
tldr 可以免费使用吗？用的什么许可证？
tldr 以 Other 许可证开源。用于商业产品前，请先确认许可证条款。
tldr 还在维护吗？
活跃维护中。tldr 最近一次提交是在 2026年10月21日。
tldr 适合用来做什么？
快速回忆不常用命令的正确参数 通过实用示例学习不熟悉的命令行工具 借助 PDF 或离线网页版在无网络环境下查阅命令帮助 为缺少简明速查文档的工具补充示例
tldr 怎么安装和运行？
使用 pipx 安装官方 Python 客户端: pipx install tldr 查看命令的速查示例，例如 tar: tldr tar
在哪里获取 tldr？
源代码和安装说明在 GitHub 上：https://github.com/tldr-pages/tldr

概要由 AI 根据项目 README 生成；GitHub 数据每日更新。

相关项目