ヘルプしたい（`tldr`）

manページやコマンドのヘルプをさっと確認するためのコマンドです。 TL;DR（Too Long; Don’t Read）という英語圏のミームをもじったコマンド名です。

ほぼすべてのコマンドの使い方はmanコマンドで確認できますが、詳細に書かれているため、目的にあった使い方をさっと調べるのはなかなかコツが必要です。 tldrは、そこから用例を抜粋して教えてくれます。すぐに使い方を知りたい場合にとても重宝しています。

注釈

TL;DRは開発者側は “Too Long; Don’t Read”（ドキュメントの肝はここだよ！）、ユーザー側は"Too Long; Didn’t Read"（簡単に説明してよ！）という意味で使うことができるみたいです。

インストール

$ brew install tealdeer

brewを使ってインストールします。

$ tldr コマンド名

tldr自身の使い方もtldrコマンドで確認できます。

$ tldr tldr

$ tldr --update
$ tldr -u

初回とキャッシュが古くなっている場合は、更新を促す警告（warning）が表示されます。

$ tldr --seed-config
Successfully created seed config file here: ~/Library/Application Support/tealdeer/config.toml

設定ファイルでキャッシュの更新を自動化できます。