Vがいる日々

Linux初心者におすすめ！コマンドのチートシートを表示してくれる tldr コマンド

local_offer linux
local_offer command
local_offer cheatsheet
create
2021年06月24日
update
2021年06月24日

もちろん、別に初心者じゃなくてもおすすめ。たすかってる。

🥪TL;DR

tldr は指定したコマンドついて、使用例を表示してくれる。
「〇〇がしたいんだけど、どうやるんだっけ？」という時に便利。

Example 1. tldr コマンドを使ってみる
sudo curl -sL \
    https://github.com/dbrgn/tealdeer/releases/download/v1.4.1/tldr-linux-x86_64-musl \
    -o /usr/local/bin/tldr
sudo chmod a+x /usr/local/bin/tldr
tldr --update
tldr tar

  Archiving utility.
  Often combined with a compression method, such as gzip or bzip2.
  More information: <https://www.gnu.org/software/tar>.

  [c]reate an archive and write it to a [f]ile:

      tar cf target.tar file1 file2 file3

  ...

🤔 tldr ってなに？

OSSコミュニティによって管理されるコマンドライン・ツールのヘルプページ集。
シンプルでとっつきやすい使用例が記述されている。

コマンドの詳細な仕様を表示する man コマンドでは

  • 長すぎて読めない（ Too Long; Didn’t Read ）

  • 結局どうコマンドを打てばわからんのでググる

ってなりがち。
したがって tldr はシンプルな使用例を表示し、man を補完することを目的にしている。

コマンドわからん
Figure 1. コマンドわからん

tldr コマンド（クライアント）

tldr の本体は Markdown で書かれたヘルプページ集。
これらのページを参照するツール（クライアント）が様々な言語で実装されている（Node.js 製とか Go 製とか）。

本記事では Rust 製のクライアント tealdeer を利用する（v1.4.1）。

Example 2. tealdeer インストール

各パッケージマネージャからインストール。

または

バイナリファイルをダウンロード
sudo curl -sL \
    https://github.com/dbrgn/tealdeer/releases/download/v1.4.1/tldr-linux-x86_64-musl \
    -o /usr/local/bin/tldr
sudo chmod a+x /usr/local/bin/tldr

または

cargo でインストール
cargo install tealdeer

💡使い方

tldr <command> と打てばいいだけ。

Example 3. tldr の使い方
tldr tar            (1)
tldr git switch     (2)
tldr --list | peco | xargs tldr  (3)
1 tar コマンドについて調べる。
2 サブコマンドを調べることも可能。
3 peco コマンドを使ってのあいまい検索。
COMMAND not found な場合
当該コマンドについてのページがまだ作成されていないので、Pull Request を送って貢献するチャンス。

📖参考