跳转至

TLDR

1. 简介

tldr 是一个 Linux 命令行工具,其基于 tlsr-pages 这样一个开源项目,后者是一个社区维护的各种命令的简洁有用的帮助页面。tldr 的目的是为了提供一个简单的、易于阅读的命令行帮助页面,以便用户能够快速了解命令的基本用法。

更多详细介绍和使用方法请参考 tldr 官方网站tldr GitHub 仓库

2. 安装

按照官方文档的介绍,tldr 可以通过 npmpipbrew、各种 linux 包管理器如 apt 等方式进行安装。介于 python 的广泛性,大部分用户可能会选择通过 pip 进行安装。

Bash
pip install tldr

如果你经常需要在不同 python 环境中切换,那么使用系统的包管理器进行安装可能是一个更好的选择。

3. 使用

类似官方所举例子,当你想要使用 tar 命令进行压缩时,可能由于并不常用,你可能会忘记具体的参数。而且花费脑容量去记忆这些参数也确实是没有必要的。如果你这个时候使用 man 命令,那么你可能会看到一大堆的参数,而且可能并不是你想要的:

bash$ 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 命令:

tldr-tar

4. 在线应用

如果你不想安装 tldr,也可以通过在线的方式来查看命令的帮助页面。只需要前往 tldr InBrowser App,在搜索框中输入你想要查询的命令,即可查看到简洁的帮助页面。

Kapture 2024-10-13 at 14.10.00.gif

5. 相关工具

当然 tldr 最终也只是一个社区维护的精简帮助页面。在 LLM 遍地开花的今天,也许使用 LLM 才是王道,推荐 Shell-GPT 这样一个命令行 LLM 工具,快速通过 AI 获得更多的帮助。

评论