ヘルプしたい(tldr)
// tldr [コマンド名]
$ tldr git
$ tldr uv
// tldr自身も確認できる
$ tldr tldr
tldrは、コマンドの典型的な使い方を簡単に確認できるコマンドです。
"Too Long; Don’t Read"という英語圏のミームをもじったコマンド名です。
ほぼすべてのコマンドの使い方はmanコマンドで確認できますが、
詳細に書かれているため、目的にあった使い方をさっと調べるのはなかなかコツが必要です。
tldrは、そこから用例を抜粋して教えてくれます。
すぐに使い方を知りたい場合にとても重宝しています。
注釈
TL;DRは
開発者側は “Too Long; Don’t Read”(ドキュメントの肝はここだよ!)、
ユーザー側は"Too Long; Didn’t Read"(簡単に説明してよ!)
という意味で使うことができるみたいです。
インストールしたい(tldr)
$ brew install tealdeer
$ tldr --version
tealdeer 1.8.1
tldrはHomebrewでインストールできます。
フォーミュラ名はtealdeerです。
キャッシュを更新したい(--update)
$ tldr --update
$ tldr -u
--updateオプションで、キャッシュを更新できます。
初回実行時とキャッシュが古くなっている場合は、更新を促す警告(warning)が表示されるので、更新しておくとよいです。
設定ファイルを作成したい
$ tldr --seed-config
Successfully created seed config file here: ~/Library/Application Support/tealdeer/config.toml
--seed-configオプションで、設定ファイルを作成できます。
デフォルトでは、~/Library/Application Support/tealdeer/config.tomlに作成されます。
[updates]セクションでキャッシュ更新の自動化を設定できます。