• 你是否经常因为记不住众多的linux命令而头疼不已?

  • 你是否因为记不住众多的命令参数而头疼不已?

  • 或许有人说我可以用谷哥度娘啊?但是不是感觉他们的检索效率又非常低下呢?

  • 或许有人说我可以用man命令啊?但是不是通过man命令显示的结果又不易阅读呢?。

  • 今天我就是来解救你们的!!!tldr命令正是解决这一痛点。

tldr是什么?

它的中文名叫“GitHub页翻译”,是 “一个简洁的社区驱动的帮助手册”,这是对它最好的解释。
根据二八原则给出命令的常用场景示例,简单易读,来自五湖四海的朋友都可以向Github上这个命令库提交内容,它完全是由社区驱动的。

虽然说linux自带man命令光环,它有更详细的说明,但单从实用角度讲,tldr才是王者。
tldr支持多达20几种主流语言,今天我们以shell为例,具体讲解如何在你的终端上下载、配置和使用。

在github上该项目名为tldr-sh,它致力于在不牺牲性能的前提下,提供最简最小和最友好的使用体验。只要在Linux, OSX, FreeBSD平台上使用 bash, sh, dash, ksh, zsh, csh等shell的环境下均可安装使用。
使用界面

安装

mkdir -p ~/bin
curl -o ~/bin/tldr https://raw.githubusercontent.com/raylee/tldr/master/tldr
chmod +x ~/bin/tldr

通过以上简单的3步你就可以愉快的使用它了!

如果在使用过程中提示bash: tldr: command not found, 那么你可能需要将命令查找路径~/bin添加到环境变量$PATH中去。在 OSX 平台中只需要编辑 ~/.bash_profile (~/.bashrc on Linux)文件, 并将export PATH="$PATH:~/bin"添加到文件末尾。

  • 如果你需要使用命令补全功能(eg. tldr w<tab><tab> to get a list of all commands which start with w) ,可以将以下命令添加到启动脚本中去:
complete -W "$(tldr 2>/dev/null --list)" tldr

使用方法

Usage

tldr [options] command

[options]
    -l, --list:      show all available pages
    -p, --platform:  show page from specific platform rather than autodetecting
    -u, --update:    update, force retrieving latest copies of index and <command>
    -h, -?, --help:  this help overview

command
    Show examples for this command
The client caches a copy of all pages and the index locally under ~/.config/tldr. By default, the cached copies will expire in 14 days.

个性定制

你也可以通过设置环境变量来设置命令输出的风格。 例如, 通过添加以下命令行到你的配置文件~/.bash_profile file (OSX) or ~/.bashrc file (Linux).

export TLDR_HEADER='magenta bold underline'
export TLDR_QUOTE='italic'
export TLDR_DESCRIPTION='green'
export TLDR_CODE='red'
export TLDR_PARAM='blue'

其他可选的颜色有: black, red, green, yellow, blue, magenta, cyan, white, onblue, ongrey, reset, bold, underline, italic, eitalic, default (当然,有些选项未必能在你的shell中显示)。