tldr

tldr-pages とは？

tldr-pages プロジェクトは、コミュニティによって保守されているコマンドラインツールのヘルプページ集です。従来のman ページをよりシンプルで親しみやすい形で補完することを目指しています。

コマンドラインの世界に初めて触れる方もいるでしょう。あるいは、少し使い方を忘れてしまったり、lsof や tar のようなコマンドの引数をいつも思い出せなかったりすることもあるでしょう。

以前、man tar で最初に説明されていたオプションが次のようなものだったことを考えると、無理もありません。

$ man tar
...
-b blocksize
   Specify the block size, in 512-byte records, for tape drive I/O.
   As a rule, this argument is only needed when reading from or writing to tape drives,
   and usually not even then as the default block size of 20 records (10240 bytes) is very common.
...

実用的な例に焦点を当てた、よりシンプルなヘルプページがあってもよいでしょう。 たとえば、次のようなものです。

このリポジトリはまさにそのようなもので、UNIX、Linux、macOS、FreeBSD、NetBSD、OpenBSD、SunOS、Android、Windows、Cisco IOS、DOS の、最も一般的なコマンドラインツールの例を集め、継続的に拡充しています。

使い方

ヒント

クライアントをコンピューターにインストールせずに閲覧するには、 https://tldr.inbrowser.app のウェブクライアントをご覧ください（PWA を使ったオフライン対応）。

公式クライアントがいくつか用意されています。

Python クライアント

公式の Python クライアントは、pipx（またはその他のパッケージマネージャー）を使って PyPI からインストールできます。

pipx install tldr

Rust クライアント

Linux および Mac のユーザーは、Homebrew、Cargo（または他のオペレーティングシステムで利用できるその他のパッケージマネージャー）を使って、公式の Rust クライアントをインストールすることもできます。

brew install tlrc

cargo install tlrc --locked

Windows のユーザーは、Winget（または他のオペレーティングシステムで利用できるその他のパッケージマネージャー）を使って、公式の Rust クライアントをインストールすることもできます。

winget install tldr-pages.tlrc

Node.js クライアント

あるいは、公式の Node.js クライアントを使用することもできますが、更新が遅れています:

npm install -g tldr

その後、tar などのコマンドについて、簡略化された読みやすいヘルプに直接アクセスできるようになります。標準の man tar の代わりに tldr tar と入力するだけで利用できます。

ソフトウェアをインストールしたくない場合は、代わりに PDF 版をチェックしてみてください。

メモ

ほとんどの言語で翻訳版の PDF が利用可能です。最新リリースのリリースアセットで見つけることができます。

コミュニティによって提供されているさまざまな他のクライアントもあり、コマンドライン用のものも他のプラットフォーム用のものもあります。 クライアントの包括的なリストについては、私たちの Wiki をご覧ください。

tldr-pages に貢献するにはどうすればよいですか？

すべての貢献を歓迎します！

貢献方法には次のようなものがあります:

• まだカバーされていない、お気に入りのコマンドを追加する。
• 既存のページに例を追加したり、内容を改善したりする。
• help wanted ラベルの付いた issue からリクエストされたページを追加する。
• ページをさまざまな言語に翻訳する。

すべての tldr ページは Markdown で書かれているため、非常に簡単に編集でき、変更はコマンドラインで Git を使用するか、GitHub の Web インターフェースを使用して、ここでプルリクエストとして提出できます。

私たちは歓迎的で協力的なコミュニティを維持するよう努めています。 初めて貢献される方は、コントリビューションガイドラインをご覧になってから、進めてください！

翻訳に貢献したい場合は、https://lukwebsforge.github.io/tldri18n/ にアクセスすると、 すべての翻訳の全体的な進捗状況や、どの翻訳が不足しているか、または古くなっているかを確認できます。

また、matrix チャットルームや、すべての tldr 関連のチャットルームを含む matrix スペースにもぜひご参加ください！

類似プロジェクト

• cheat.sh 複数のソース（tldr-pages を含む）からチートシートを 1 つの統合インターフェースに集約します。

• devhints Rico のチートシートはコマンドラインだけに焦点を当てたものではなく、 プログラミングに関連する多数の他のチートシートも含まれています。

• eg コマンドラインで説明付きの詳細な例を提供します。 例はリポジトリから取得されますが、eg はデフォルトと並べて カスタムの例やコマンドを表示することもサポートしています。

• kb はミニマリストなコマンドラインのナレッジベースマネージャーです。 kb はノートやチートシートをミニマリストでクリーンな方法で整理するために使用できます。 非テキストファイルもサポートしています。

• navi はインタラクティブなチートシートツールで、特定の例や 完全なコマンドをその場で閲覧できます。

• Cheat を使用すると、コマンドラインでインタラクティブなチートシートを作成および表示できます。 これは Unix システム管理者が、頻繁に使用するものの、覚えるほど頻繁ではない コマンドのオプションを思い出すのに役立つように設計されました。

• Command Line Interface Pages を使用すると、CLI、ディレクトリ、設定用の標準化されたヘルプページを作成できます。

• bropages（非推奨） は man ページを非常に読みやすく補完するものです。 Unix コマンドの簡潔で一般的なケースの例を表示します。 例はユーザーベースによって投稿され、賛成票または反対票を投じることができます。 最も優れたエントリは、ユーザーがコマンドを調べたときに最初に目にするものです。

「tldr」とはどういう意味ですか？

TL;DR は「長すぎて読まなかった（Too Long; Didn't Read）」の略です。 これはインターネットスラングとして生まれ、長い文章（またはその一部）を長すぎるために読み飛ばしたことを示すために使われます。 詳しくは、How-To Geek の記事をご覧ください。