Qu'est-ce que tldr ?
tldr est le client Rust officiel de tldr-pages, la collection de pages man simplifiées entretenue par la communauté : chaque page est une description d'une ligne de la commande, suivie d'une poignée des exemples que les gens tapent vraiment. Le projet upstream s'appelle tlrc ; le paquet et la commande s'appellent tous deux tldr. C'est un unique binaire statique sans dépendances, qui garde toute la collection dans un cache local pour que chaque recherche soit instantanée et fonctionne hors ligne, et qui rafraîchit ce cache de lui-même quand il vieillit. Les pages existent par plateforme (Linux, macOS, Windows, Android, les BSD) et en des dizaines de langues, les couleurs et la mise en page de la sortie tiennent dans un fichier TOML, et le paquet livre la page de manuel et les complétions bash, zsh et fish.
tldr de Debian est un autre programme, le client Haskell tldr-hs, et le tealdeer de Debian installe lui aussi un /usr/bin/tldr ; aucun des deux n'est tlrc, ce dépôt est donc le moyen d'avoir le client officiel via apt.
⚡ Fonctionnalités clés de tldr
📄 Les exemples d'abord
tldr tar affiche les huit façons dont vous utilisez vraiment tar, plutôt que les deux cents options qu'il accepte. Les commandes à plusieurs mots marchent telles que vous les tapez : tldr git rebase, tldr docker compose.
⚡ Un cache local, pas une requête
Le premier lancement télécharge toute la collection ; chaque recherche suivante est une lecture de fichier, la page apparaît donc avant que le doigt quitte Entrée, dans un train ou derrière un proxy. Le cache se met à jour tout seul une fois plus vieux que l'âge que vous fixez, ou sur --update.
🖥️ Toutes les plateformes, une commande
Les pages sont rangées par plateforme. Vous obtenez celle de Linux par défaut, et -p macos ou -p windows quand vous rédigez des instructions pour une machine qui n'est pas celle devant vous.
🌍 Votre langue
tldr-pages est traduit en des dizaines de langues. tlrc suit LANG et LANGUAGE et se rabat sur l'anglais page par page, ou -L en choisit une pour une seule recherche.
🔍 Trouver la page que vous ne connaissez pas
--list affiche tous les noms de page de la plateforme courante, --search fouille les noms et les descriptions, et --info vous dit l'âge du cache et les langues qu'il contient.
🎨 À configurer comme vous voulez
Un config.toml : chaque couleur et chaque style de la page affichée, l'âge du cache avant une mise à jour automatique, les langues à télécharger, la plateforme à préférer et un répertoire de pages à vous, consulté avant le cache.
apt upgrade vous garde sur la dernière version.
📦 Installation depuis deb.griffo.io
Étape 1 : ajouter le dépôt
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🆓 Il existe un miroir gratuit pour toujours. deb-free.griffo.io distribue des paquets gratuitement pour toujours — sans compte, sans abonnement, au plus 2 mois derrière l'upstream, correctifs de sécurité immédiats. Il contient aujourd'hui cliamp, Ghostty, lazydocker, Oh My Posh, Uncloud et Zed ; tldr n'en fait pas partie, le dépôt ci-dessus reste donc le seul moyen de l'installer — demandez-le et il pourra y être ajouté.
🧩 À propos de l'option extrepo. extrepo est l'outil de Debian pour les dépôts externes : il écrit le fichier de sources et installe la clé de signature à votre place, après l'avoir vérifiée face à des métadonnées signées. Ce dépôt y est enregistré sous le nom griffo, et le miroir gratuit à vie sous griffo-free ; sur Debian (bookworm, trixie, forky et sid), les commandes ci-dessus constituent donc toute l'installation.
extrepo ne met en place que le fichier de sources et la clé : les identifiants d'un abonnement vont toujours dans /etc/apt/auth.conf.d/deb.griffo.io.conf. Ubuntu n'est pas couvert, car extrepo ne publie de métadonnées que pour les suites Debian : utilisez-y les commandes avec sudo ou en root.
Étape 2 : installer tldr
# Installer le dernier tldr
# Si tealdeer est installé, apt le retire d'abord : les deux paquets
# placent /usr/bin/tldr dans votre PATH, celui-ci le remplace donc
sudo apt install tldr
# Vérifier l'installation
tldr --version# Installer le dernier tldr
# Si tealdeer est installé, apt le retire d'abord : les deux paquets
# placent /usr/bin/tldr dans votre PATH, celui-ci le remplace donc
apt install tldr
# Vérifier l'installation
tldr --versionÉtape 3 : premier lancement
# La première recherche télécharge le cache des pages, il lui faut
# donc internet une fois ; tout le reste est local
tldr tar
# Rafraîchir le cache à la main quand vous voulez
tldr --update
# Où vit le cache, son âge et les langues qu'il contient
tldr --info
# Toutes les options
tldr --help🎯 Exemples d'utilisation de base
Chercher :
# La page d'une commande
tldr tar
# Les sous-commandes, écrites comme vous les taperiez
tldr git rebase
# Une page pour une autre plateforme
tldr -p macos brew
tldr -p windows choco
# Une page dans une autre langue, pour une seule recherche
tldr -L fr tar
# Tous les noms de page de cette plateforme, et une recherche dans
# les noms et les descriptions quand vous ne connaissez pas la commande
tldr --list
tldr --search "compress"Façonner la sortie :
# Markdown brut, à envoyer dans autre chose
tldr -R tar
# Sans les lignes vides, sur un petit terminal
tldr --compact tar
# Sans couleurs, pour les journaux et les scripts
tldr --color never tar
# Ne jamais toucher au réseau, même si le cache est périmé
tldr --offline tar
# Afficher une page que vous écrivez avant de l'envoyer upstream
tldr -r my-command.mdLe faire vôtre :
# D'où la configuration est lue, et un défaut pour démarrer
tldr --config-path
mkdir -p "$(dirname "$(tldr --config-path)")"
tldr --gen-config > "$(tldr --config-path)"
# Puis dans config.toml : l'âge du cache avant une mise à jour
# automatique, les langues à garder, la plateforme à préférer
# et les couleurs de chaque partie d'une page
# Vider le cache si un téléchargement a mal tourné
tldr --clean-cache🔧 Intégrations
tldr est un outil de consultation, il se place donc à côté des outils que vous utilisez déjà :
- Votre shell : le paquet installe les complétions bash, zsh et fish,
tldr gi<tab>complète donc les noms de page depuis le cache, etman tldrest là pour le client lui-même - fzf :
tldr --list | fzf | xargs tldrest un sélecteur de pages flou en une ligne, et la sortie de--rawalimente le panneau d'aperçu - Corriger une page :
tldr --edit taraffiche un lien qui ouvre cette page dans l'éditeur web de GitHub, corriger une page tldr n'est donc qu'à une pull request - man : tldr ne remplace pas le manuel, c'est ce qu'on lit en premier ; la page complète est à un
mande là une fois que vous savez quelle option vous voulez - Scripts et docs :
--color neveret--rawrendent la sortie sûre à coller dans un README, un ticket ou un journal
🚀 Pourquoi choisir deb.griffo.io ?
- Debian officiel :
apt install tldrvous donne tldr-hs, le client Haskell, ettealdeerest un autre client Rust avec le même nom de commande ; aucun des deux n'est le tlrc officiel - Compiler depuis les sources : à jour, mais une chaîne Rust sur chaque machine et un binaire dont apt ignore tout
- L'archive de release upstream : le même binaire statique, mais décompressé à la main dans votre PATH, sans complétions, sans page de manuel et sans mises à jour
- deb.griffo.io: dernière version avec mises à jour automatiques
- ✅ Le client officiel : tlrc, le client que le projet tldr-pages maintient lui-même, pas l'une des nombreuses réimplémentations
- ✅ La commande s'appelle tldr : le paquet s'appelle tldr parce que c'est la commande, et il entre en conflit avec
tealdeeret le remplace, il n'y a donc jamais de bagarre pour/usr/bin/tldr - ✅ Mises à jour automatiques : les paquets sont mis à jour quelques heures après chaque version upstream, et le cache des pages se met à jour tout seul par-dessus
- ✅ Paquet complet : le binaire, la page de manuel et les complétions bash, zsh et fish
- ✅ Zéro dépendance : un binaire musl lié statiquement, rien d'autre n'est tiré
- ✅ Deux architectures : amd64 et arm64, le même binaire statique sur toutes les suites
- ✅ Multi-distribution : fonctionne sur Debian 13 (trixie) ou plus récent : Trixie, Forky et Sid
- ✅ Maintenance simple : des mises à jour avec les commandes apt habituelles
📦 Dépôt de construction du paquet
Les paquets Debian sont construits et maintenus automatiquement dans ce dépôt GitHub :
- 📖 tldr-debian - Constructions des dernières versions
🔗 Paquets associés
Également disponibles sur deb.griffo.io :
- fzf Fuzzy Finder - Transforme
tldr --listen sélecteur de pages interactif - ripgrep - L'outil de recherche dont vous lirez la page tldr en premier
- eza - Un ls moderne, encore une commande avec bien moins d'options à retenir
- zoxide - Un cd plus malin pour le shell dans lequel vous lisez les pages