tldrでmanドキュメントの要約　macOS/Linux/Unix

シェルコマンドの使い方を調べる際にみなさんどうやられてますか？私の場合はネットでググったり、ChatGPTに問い合わせたりしてます。最近だとそれも面倒なので、自分がよく使いそうなコマンド例をこのブログにまとめて、検索できるようにしてます（試しにこのブログでスラッシュを押して、検索ボックスに find と入力してみてください）。

本来はmanのドキュメントで確認するのが一番スマートな気がするのですが、manって読みづらくないですか？オプションの意味を調べるのはまだ良いのですが、逆引きで〇〇を実現させるためのオプションを調べようとするとかなり難しいです。なので私はmanドキュメントが苦手で、あまり使ってません。

Linuxコマンドのポケットリファレンス でも買おうかなと思ったのですが、最近 UNIXという考え方 を読んでいて非常に面白く、まさに「UNIXという考え方」に感銘を受けたのですが、その本では紙媒体を否定されオンライン（manドキュメント）で読むべきだと諭されます（笑）。

どうしたものかと悩んでいたところ、manドキュメントを読みやすく省略して表示してくれるコマンドを発見しました。それがこの記事でご紹介する tldr です。

ltdr（TL;DR）とは

そもそもtldrは、ネットスラングで使われる（私は使ったことありませんが）TL;DRで、"Too Long, Didn't Read"のことです。「長すぎて読めませんでした。」という本来の英語の意味から、「要約です。」の意味で使われるそうです。しかし、こちらの記事 に書かれているように、相手を小馬鹿にした意味もあるようですから使う時は気をつけましょう。

さて、 tldr コマンドはGitHubでStarが 47.9k（2024年3月時点）ついている人気のライブラリです。

• GitHub - tldr-pages/tldr: 📚 Collaborative cheatsheets for console commands

ltdr ls

このコマンドを実行すると、下図のようにlsコマンドの使い方が要約されて、色付けされた見やすい形で表示してくれます。

これなら、ググったりChatGPTにコマンドの使い方を問い合わせなくても済みそうですね！

tldrのインストール方法

macOSにtldrインストールするには、Homebrewを使用します。

brew install tldr

ubuntuなどのDebian系Linuxへインストールする場合はこちら。

sudo apt-get install -y tldr

tldrの使い方

基本的な使い方

基本的な使い方は、tldr コマンド名です。例えば、lsコマンドの使用例を見たい場合は以下のように入力します。

tldr ls

出力される情報には、簡単な説明、基本的な使用例、オプションの使用例が含まれます。 tldrにはいくつかのオプションがありますが、よく使われるものには以下のようなものがあります。

tldrのデータベースを更新

tldrの内部で管理されているデータベースを最新のものへ更新します。

tldr -u

表示可能なコマンドの一覧を表示

tldr -l

指定した言語でページを表示

指定した言語でページを表示します。例: -L jaは日本語で表示します（私の環境では使えませんでした）。

tldr -L ja ls

関連記事