tldrはいいぞ
この記事はSecHack365 修了生 Advent Calender 2019の1日目です。12/1に投稿できなくてすみません！
はじめに
皆さんはコマンドのオプションや使い方が思い出せないときはどうしてますか？
- インターネットで調べる
- manを使う
- そのコマンドのhelpオプションを使う
これらをざっと思いつくかと思います。
ネットで調べるのはちょっとめんどくさいですよね。できればターミナル上で解決したいものです。
ターミナル上で解決するとなるとmanとコマンドのhelpオプションが挙げられますが、オプションの説明だけで実際の使われ方が書いてなかったりするので、痒いところに手が届きません。
そんなあなたにtldr
tldrというコマンドがあります。
tldrはコマンドをどのように使ったらいいかをわかりやすく示してくれます。
manやhelpオプションに比べて表示がスッキリしています。やりたいことの逆引き辞典としても使えますね。
インストール
Ruby, Python, goなど様々な言語のライブラリとして提供されています。詳しくは公式ドキュメントを参考にしてください。
MacだとHomebrewで入れられるのでbrew install tldrが楽です。
tldrのtips
tldrをtldrすることもできます。
-pでOSを指定することで、そのOSでのコマンドの説明を見ることができます。例えばbrewの説明は、MacとLinuxでは細かな違いがあったりします。
画像の最後に書かれている通り、tldrはgitのサブコマンドもサポートしています。 私は細かな使い方を忘れることが多いので非常に重宝しています。
俺の使ってるコマンドがないぞ
大抵のコマンドはtldrに入ってますが、残念ながらないものもあります。*1 また、コマンドによっては全てのオプションやサブコマンドが網羅されていなかったりします。*2
そんなときはtldrのコントリビュータになりましょう！
余力があればrails、docker周りをまとめてプルリク投げたいなあと思っております。
