tldr とは
tldr は tldr-pages の公式 Rust クライアントです。tldr-pages はコミュニティが維持する簡略版 man ページの集まりで、各ページはコマンドの 1 行説明に続けて、実際に人が打つ数本の例を並べたものです。上流プロジェクトの名前は tlrc、パッケージ名もコマンド名も tldr です。依存のない単一の静的バイナリで、全ページをローカルキャッシュに持つので検索は一瞬、オフラインでも動き、古くなったキャッシュは自分で更新します。ページはプラットフォーム別（Linux、macOS、Windows、Android、各 BSD）に、何十もの言語で用意され、出力の色やレイアウトは TOML ファイル 1 つで決まり、パッケージには man ページと bash、zsh、fish の補完が含まれます。
tldr パッケージは別のプログラム、Haskell 製クライアントの tldr-hs で、Debian の tealdeer も /usr/bin/tldr を入れます。どちらも tlrc ではないので、公式クライアントを apt で入れる手段がこのリポジトリです。
⚡ tldr の主な機能
📄 まず例から
tldr tar は、tar が受け付ける二百のフラグではなく、実際に使う八通りの使い方を表示します。複数語のコマンドも打つとおりに書けます。tldr git rebase、tldr docker compose。
⚡ リクエストではなくローカルキャッシュ
初回起動でコレクション全体を取得し、以後の検索はファイルを読むだけ。Enter から指を離す前にページが出ます。電車の中でもプロキシの裏でも同じです。設定した寿命を過ぎるとキャッシュは自分で更新され、--update でも更新できます。
🖥️ すべてのプラットフォームを 1 つのコマンドで
ページはプラットフォーム別に整理されています。既定では Linux 版が出て、目の前にないマシン向けの手順を書くときは -p macos や -p windows を付けます。
🌍 あなたの言語で
tldr-pages は何十もの言語に翻訳されています。tlrc は LANG と LANGUAGE に従い、ページ単位で英語にフォールバックします。-L で 1 回だけ別の言語を選ぶこともできます。
🔍 知らないページを見つける
--list は現在のプラットフォームの全ページ名を表示し、--search は名前と説明を検索し、--info はキャッシュの古さと含まれる言語を教えてくれます。
🎨 設定は自分の手で
config.toml がひとつ。描画されるページのあらゆる色とスタイル、自動更新までのキャッシュ寿命、取得する言語、優先するプラットフォーム、そしてキャッシュより先に探される独自ページのディレクトリ。
apt upgrade を実行するだけで、常に最新版を使い続けられます。
📦 deb.griffo.io からインストールする
ステップ 1: リポジトリを追加する
sudo install -d -m 0755 /etc/apt/keyrings
curl -fsSL https://deb.griffo.io/EA0F721D231FDD3A0A17B9AC7808B4DD62C41256.asc | sudo gpg --dearmor --yes -o /etc/apt/keyrings/deb.griffo.io.gpg
echo "deb [signed-by=/etc/apt/keyrings/deb.griffo.io.gpg] https://deb.griffo.io/apt $(lsb_release -sc 2>/dev/null) main" | sudo tee /etc/apt/sources.list.d/deb.griffo.io.list > /dev/null
sudo apt updateinstall -d -m 0755 /etc/apt/keyrings
curl -fsSL https://deb.griffo.io/EA0F721D231FDD3A0A17B9AC7808B4DD62C41256.asc | gpg --dearmor --yes -o /etc/apt/keyrings/deb.griffo.io.gpg
echo "deb [signed-by=/etc/apt/keyrings/deb.griffo.io.gpg] https://deb.griffo.io/apt $(lsb_release -sc 2>/dev/null) main" | tee /etc/apt/sources.list.d/deb.griffo.io.list > /dev/null
apt updatesudo apt install extrepo
sudo extrepo enable griffo
sudo apt update🆓 ずっと無料のミラーがあります。 deb-free.griffo.io は、アカウントもサブスクリプションもなしでパッケージをずっと無料で配布しています。上流より最大2か月遅れ、セキュリティ修正は即座に公開されます。現在収録しているのは cliamp、Ghostty、lazydocker、Oh My Posh、Uncloud と Zed です。tldr は含まれていないため、今日入手する方法は上のリポジトリだけですが、ご要望があれば追加できます。
🧩 extrepo オプションについて。 extrepo は外部リポジトリを扱う Debian 標準のツールです。署名済みメタデータと照合して鍵を検証したうえで、sources ファイルの作成と署名鍵のインストールを代わりに行います。このリポジトリは griffo、ずっと無料のミラーは griffo-free という名前で登録されているので、Debian（bookworm、trixie、forky、sid）では上のコマンドだけで設定は完了です。
extrepo が用意するのは sources ファイルと鍵だけなので、サブスクリプションの認証情報は引き続き /etc/apt/auth.conf.d/deb.griffo.io.conf に書きます。extrepo は Debian のスイート向けメタデータしか公開していないため Ubuntu は対象外です。Ubuntu では sudo または root のコマンドを使ってください。
ステップ 2: tldr をインストールする
# 最新の tldr をインストール
# tealdeer が入っていれば apt が先に削除します。どちらのパッケージも
# /usr/bin/tldr を PATH に置くので、こちらが置き換わります
sudo apt install tldr
# インストールを確認
tldr --version# 最新の tldr をインストール
# tealdeer が入っていれば apt が先に削除します。どちらのパッケージも
# /usr/bin/tldr を PATH に置くので、こちらが置き換わります
apt install tldr
# インストールを確認
tldr --versionステップ 3: 最初の起動
# 最初の検索でページのキャッシュを取得するので、一度だけ
# インターネットが必要です。それ以降はすべてローカルです
tldr tar
# 好きなときに手動でキャッシュを更新
tldr --update
# キャッシュの場所、古さ、含まれる言語
tldr --info
# すべてのオプション
tldr --help🎯 基本的な使用例
調べる:
# コマンドのページ
tldr tar
# サブコマンドは、打つとおりに
tldr git rebase
# 別のプラットフォームのページ
tldr -p macos brew
tldr -p windows choco
# 1 回だけ別の言語で
tldr -L ja tar
# このプラットフォームの全ページ名と、コマンド名が分からないときの
# 名前と説明からの検索
tldr --list
tldr --search "compress"出力を整える:
# 生の markdown。別のプログラムに渡すときに
tldr -R tar
# 小さなターミナルでは空行を省く
tldr --compact tar
# 色なし。ログやスクリプト向け
tldr --color never tar
# キャッシュが古くてもネットワークには触れない
tldr --offline tar
# 上流に送る前に、書きかけのページを描画して確認
tldr -r my-command.md自分仕様にする:
# 設定の読み込み元と、出発点になる既定の設定
tldr --config-path
mkdir -p "$(dirname "$(tldr --config-path)")"
tldr --gen-config > "$(tldr --config-path)"
# あとは config.toml で: 自動更新までのキャッシュ寿命、
# 保持する言語、優先するプラットフォーム、ページ各部の色
# ダウンロードに失敗したらキャッシュを消す
tldr --clean-cache🔧 ツール連携
tldr は調べるための道具なので、すでに使っているツールの隣に収まります:
- あなたのシェル: パッケージが bash、zsh、fish の補完を入れるので、
tldr gi<tab>でキャッシュからページ名が補完されます。クライアント自体の説明はman tldrに - fzf:
tldr --list | fzf | xargs tldrの 1 行であいまい検索のページ選択になり、--rawの出力はプレビューペインに流せます - ページを直す:
tldr --edit tarはそのページを GitHub のウェブエディタで開くリンクを表示するので、tldr ページの修正は pull request ひとつで済みます - man: tldr はマニュアルの代わりではなく、最初に読むものです。欲しいフラグが分かれば、完全なページは
manひとつ先にあります - スクリプトとドキュメント:
--color neverと--rawで、README やチケットやログに安心して貼れる出力になります
🚀 deb.griffo.io を選ぶ理由
- 公式 Debian:
apt install tldrで入るのは Haskell 製クライアントの tldr-hs で、tealdeerは同じコマンド名を持つ別の Rust 製クライアントです。どちらも公式の tlrc ではありません - ソースからビルド: 最新にはなりますが、マシンごとに Rust のツールチェーンが要り、apt が知らないバイナリが残ります
- 上流のリリース tarball: 同じ静的バイナリですが、PATH へ手で展開することになり、補完も man ページも更新もありません
- deb.griffo.io: 最新版を自動更新でお届け
- ✅ 公式クライアント: 数ある再実装のひとつではなく、tldr-pages プロジェクト自身が維持するクライアント tlrc
- ✅ コマンドは tldr: パッケージ名が tldr なのはコマンドがそうだからで、
tealdeerと競合して置き換えるため、/usr/bin/tldrの取り合いは起きません - ✅ 自動更新: 上流のリリースから数時間以内にパッケージを更新し、その上でページのキャッシュも自分で更新されます
- ✅ 完全なパッケージ: バイナリ、man ページ、bash、zsh、fish の補完
- ✅ 依存ゼロ: 静的リンクの musl バイナリで、他には何も引き込みません
- ✅ 2 つのアーキテクチャ: amd64 と arm64。同じ静的バイナリがどのスイートでも動きます
- ✅ マルチディストリビューション: Debian 13 (trixie) 以降で動作: Trixie、Forky、Sid
- ✅ 手間のかからない運用: 更新は通常の apt コマンドだけ
📦 パッケージのビルドリポジトリ
Debian パッケージは、この GitHub リポジトリで自動的にビルド・管理されています:
- 📖 tldr-debian - 最新リリースのビルド
🔗 関連パッケージ
deb.griffo.io では、こちらも配布しています:
- fzf ファジーファインダー -
tldr --listを対話的なページ選択に変える - ripgrep - 最初に tldr ページを読むことになる検索ツール
- eza - 現代的な ls。覚えるフラグがずっと少ないもうひとつのコマンド
- zoxide - ページを読んでいるそのシェルのための、賢い cd