mcpField
T
tldr

tldr

官方
github.com开发者工具64.1ktldr今天更新
代码仓库访问官网

关于 tldr

提供重点关注常见用例而非完整手册的简化命令文档。由社区策划，包含数千个命令的示例。

主要功能

  1. 01显示最小输出且无行话的命令实用示例
  2. 02访问多个平台上常见工具的文档
  3. 03按精确名称或部分关键词搜索命令文档

适用场景

  1. 01快速回忆常用命令的常见标志和语法
  2. 02通过真实示例学习如何使用不太熟悉的工具
  3. 03无需阅读完整手册页即可直接获得实用示例

安装

选择你的系统或包管理器，复制命令到终端运行。

$
brew install tlrc

安装完成后运行tldr --version确认安装成功。

命令示例

常用命令按使用顺序排列。

01
tldr tar
02
tldr git-rebase

详细介绍

tldr-pages

构建状态 Matrix 聊天 已合并的 PR GitHub 贡献者 许可证 Mastodon

什么是 tldr-pages？

tldr-pages 项目汇集了由社区维护的命令行工具帮助页面，旨在作为传统 man 手册页的更简单、更易读的补充。

也许你刚接触命令行世界。或许你只是有点生疏，或者总是记不住 lsof、tar 等命令的参数？

过去，man tar 中解释的第一个选项是：

$ man tar
...
-b blocksize
   Specify the block size, in 512-byte records, for tape drive I/O.
   As a rule, this argument is only needed when reading from or writing to tape drives,
   and usually not even then as the default block size of 20 records (10240 bytes) is very common.
...

我们可以提供更简单、聚焦实用示例的帮助页面。 例如：

tldr 客户端显示 tar 命令的截图。

这个仓库正是这样一个不断扩充的示例集合，涵盖最常见的 UNIX、Linux、macOS、FreeBSD、NetBSD、OpenBSD、SunOS、Android、Windows、Cisco IOS 和 DOS 命令行工具。

如何使用？

提示

若想无需在电脑上安装客户端即可浏览，请访问 Web 客户端 https://tldr.inbrowser.app（支持通过 PWA 离线使用）。

有多个官方客户端可供选择。

Python 客户端

官方 Python 客户端可通过 pipx 从 PyPI 安装（或使用其他包管理器）：

pipx install tldr
Rust 客户端

Linux 和 Mac 用户也可以通过 Homebrew、Cargo 安装官方 Rust 客户端（其他操作系统用户可使用其他包管理器）：

brew install tlrc

cargo install tlrc --locked

Windows 用户也可以通过 Winget 安装官方 Rust 客户端（其他操作系统用户可使用其他包管理器）：

winget install tldr-pages.tlrc
Node.js 客户端

或者，你也可以使用官方的 Node.js 客户端，不过它的更新已经落后：

npm install -g tldr

这样，你就可以直接查阅简明易懂的命令帮助，例如 tar，只需输入 tldr tar，而不必使用标准的 man tar。

如果你不想安装任何软件，也可以查看 PDF 版本。

说明

大多数语言都提供了翻译版 PDF。你可以在最新版本的发布资源中找到它们。

社区还提供了各种其他客户端，既有命令行客户端，也有适用于其他平台的客户端。 如需查看完整的客户端列表，请访问我们的 Wiki。

如何为 tldr-pages 做贡献？

欢迎所有贡献！

你可以通过以下方式参与贡献：

  • 添加尚未收录的常用命令。
  • 为现有页面添加示例或改进其内容。
  • 添加带有 help wanted 标签的 issue 中征集的页面。
  • 将页面翻译成不同语言。

所有 tldr 页面都使用 Markdown 编写，因此很容易编辑。你可以使用命令行上的 Git 或 GitHub 网页界面，在此提交拉取请求。

我们致力于营造一个友好且协作的社区。 如果你是第一次贡献，请查看贡献指南，然后开始参与吧！

如果你想为翻译做贡献，可以访问 https://lukwebsforge.github.io/tldri18n/，查看所有翻译的总体进度，以及哪些翻译缺失或过时。

也欢迎你加入我们的 matrix 聊天室和 matrix 空间，其中包含所有与 tldr 相关的聊天室！

类似项目

  • cheat.sh 汇集多个来源的速查表（包括 tldr-pages）， 并整合到一个统一界面中。

  • devhints Rico 的速查表不只关注命令行， 还包括大量其他编程相关的速查表。

  • eg 在命令行中提供带有说明的详细示例。 示例来自该代码仓库，但 eg 也支持显示 自定义示例和命令，并与默认内容并列展示。

  • kb 是一款极简的命令行知识库管理工具。 kb 可用于以简洁清爽的方式整理笔记和速查表。 它还支持非文本文件。

  • navi 是一款交互式速查表工具，可让你浏览 特定示例，或即时补全命令。

  • Cheat 允许你在命令行中创建和查看交互式速查表。 它旨在帮助 Unix 系统管理员回忆起那些 使用频率不高、但又不足以记住的命令选项。

  • Command Line Interface Pages 允许你为 CLI、目录和配置编写标准化的帮助页面。

  • bropages (deprecated) 是 man 页面的一种易读补充。 它展示 Unix 命令中简洁、常见用法的示例。 这些示例由用户提交，并可投票支持或反对； 用户查找命令时会优先看到得票最高的条目。

“tldr” 是什么意思？

TL;DR 是“Too Long; Didn't Read”（太长了，没读）的缩写。 它起源于网络俚语，用来表示由于内容过长而跳过了整篇文本 （或其中部分内容）。 更多信息请阅读 How-To Geek 的文章。

评论

支持 Markdown