tldr-pages/tldr

これは何？

主な機能

• 01一般的なコマンドの簡潔な使用例を掲載し、オプションを網羅的に列挙しない
• 02Linux、macOS、BSD、Windows、Androidなど、さまざまなプラットフォームに対応
• 03ページはプレーンなMarkdownで書かれており、プルリクエストで簡単に編集できる
• 04Python、Rust、Node.jsの公式クライアントとWebクライアントを提供
• 05多言語の翻訳を用意

ユースケース

• たまに使うコマンドの適切なフラグをすばやく確認する
• 実用的な例を通じて、使い慣れていないコマンドラインツールを学ぶ
• PDF版やPWA対応Webクライアントで、オフラインでもヘルプを閲覧する
• 手軽に参照できるドキュメントが不足しているツールの使用例を投稿する

クイックスタート

1. 1

   公式の Python クライアントを pipx でインストールする

   pipx install tldr
2. 2

   tar などのコマンドのチートシートを調べる

   tldr tar

使う前に知っておきたいこと

• !メタデータのライセンスは NOASSERTION です。再利用する前に LICENSE ファイルを確認してください。
• !公式の Node.js クライアントは、アップデートが滞っています。

トピック

よくある質問

tldr とは？

コマンドラインツールの実用的な使用例をまとめた、manページを補完するコミュニティ運営のチートシート集です。 tldr-pagesは、コマンドラインツールのヘルプページを集めた、コミュニティ運営のコレクションです。各ページでは、あらゆるオプションを列挙するのではなく、よく使われる実用的な例をいくつか紹介しているため、tarやlsofなどのコマンドの使い方をすばやく確認できます。

tldr は無料で使えますか？ライセンスは？

tldr は Other ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。

tldr は今もメンテナンスされていますか？

活発にメンテナンス中。tldr の最終コミットは 2026年10月21日 です。

tldr は何に使えますか？

たまに使うコマンドの適切なフラグをすばやく確認する 実用的な例を通じて、使い慣れていないコマンドラインツールを学ぶ PDF版やPWA対応Webクライアントで、オフラインでもヘルプを閲覧する 手軽に参照できるドキュメントが不足しているツールの使用例を投稿する

tldr のインストール方法は？

公式の Python クライアントを pipx でインストールする: pipx install tldr tar などのコマンドのチートシートを調べる: tldr tar

tldr はどこで入手できますか？

ソースコードとインストール手順は GitHub にあります：https://github.com/tldr-pages/tldr