tldr (Too Long; Didn't Read)

介绍

tldr 是一款简介易懂而且快速的命令行工具，用于文档和说明。它提供了简短、易懂的摘要，使得用户可以快速了解所需信息，而无需阅读冗长的文档。

安装

tldr 可以通过 npm ，请确保您已经安装了 Node.js。

npm install -g tldr

使用

查找命令

要获取特定命令的信息，只需要在 tldr 后面加上待查询的命令，即可从 tldr 数据库中获取与该命令相关的简短文档。

tldr <command>

例如，我们想查询 "git clone" 的命令摘要，可以输入以下命令：

tldr git clone

tldr 将返回如下所示的 markdown 表格：

# git clone

Clones a repository into a newly created directory, creates remote-tracking branches for each branch in the cloned repository (visible using git branch -r), and creates and checks out an initial branch that is forked from the cloned repository’s currently active branch.

- Minimize network traffic by using a shallow clone (--depth 1).
- Check out a branch other than master by specifying it in the command.
- Clone only one branch by specifying it in the command.
- Use git submodule update --init to initialize submodules.

列出命令

tldr 还支持列出与特定操作系统相关的所有命令的摘要。

tldr

tldr 将返回所有可用命令的 markdown 表格列表。

风格指南

tldr 数据库支持多种语言和格式。官方维护了编写新条目的风格指南。

• tldr 风格指南

贡献

tldr 是一个开源项目，任何人都可以向 tldr 数据库中提供新的命令或更正现有摘要。请参阅以下链接以了解如何参与：

• tldr 贡献指南

总结

tldr 提供了快速、简洁的方式来查找常用命令的摘要。它可以帮助开发者节省大量时间，充分利用手边的工具，让开发流程更加有效率。

返回的 markdown 格式如下：

# tldr (Too Long; Didn't Read)

## 介绍

tldr 是一款简介易懂而且快速的命令行工具，用于文档和说明。它提供了简短、易懂的摘要，使得用户可以快速了解所需信息，而无需阅读冗长的文档。

## 安装

tldr 可以通过 npm ，请确保您已经安装了 Node.js。

```bash
npm install -g tldr

使用

查找命令

要获取特定命令的信息，只需要在 tldr 后面加上待查询的命令，即可从 tldr 数据库中获取与该命令相关的简短文档。

tldr <command>

例如，我们想查询 "git clone" 的命令摘要，可以输入以下命令：

tldr git clone

tldr 将返回如下所示的 markdown 表格：

# git clone

Clones a repository into a newly created directory, creates remote-tracking branches for each branch in the cloned repository (visible using git branch -r), and creates and checks out an initial branch that is forked from the cloned repository’s currently active branch.

- Minimize network traffic by using a shallow clone (--depth 1).
- Check out a branch other than master by specifying it in the command.
- Clone only one branch by specifying it in the command.
- Use git submodule update --init to initialize submodules.

列出命令

tldr 还支持列出与特定操作系统相关的所有命令的摘要。

tldr

tldr 将返回所有可用命令的 markdown 表格列表。

风格指南

tldr 数据库支持多种语言和格式。官方维护了编写新条目的风格指南。

• tldr 风格指南

贡献

tldr 是一个开源项目，任何人都可以向 tldr 数据库中提供新的命令或更正现有摘要。请参阅以下链接以了解如何参与：

• tldr 贡献指南

总结

tldr 提供了快速、简洁的方式来查找常用命令的摘要。它可以帮助开发者节省大量时间，充分利用手边的工具，让开发流程更加有效率。