tldr

tldr-pages est un projet collaboratif qui rassemble des pages d’aide maintenues par la communauté pour des outils en ligne de commande. Son objectif est d’être un complément plus simple et plus accessible aux pages de manuel traditionnelles, en mettant l’accent sur des exemples pratiques plutôt que sur des manuels exhaustifs. Le dépôt contient un ensemble en croissance constante d’exemples pour des outils courants utilisés dans les interfaces en ligne de commande d’UNIX, Linux, macOS, FreeBSD, NetBSD, OpenBSD, SunOS, Android, Windows, Cisco IOS et DOS. Le README explique que le projet est né de la difficulté à lire les pages de manuel habituelles, où la première explication peut par exemple porter sur la taille des blocs d’un lecteur de bande plutôt que sur l’usage courant dont les utilisateurs ont besoin. À la place, les pages tldr présentent des exemples concis et courants, comme l’extraction d’une archive tar. Les options d’utilisation incluent des clients officiels : - Client Python : installable avec pipx ou d’autres gestionnaires de paquets - Client Rust (tlrc) : installable avec Homebrew, Cargo ou Winget sous Windows - Client Node.js : npm install -g tldr, bien qu’il soit en retard dans les mises à jour Les utilisateurs peuvent également consulter les pages via le client web à tldr.inbrowser.app, qui prend en charge une utilisation hors ligne grâce à une PWA, ou télécharger une version PDF des pages depuis la dernière version. Des PDF pour les traductions sont disponibles pour la plupart des langues. La contribution est ouverte à tous. Les façons de contribuer incluent l’ajout de commandes favorites non encore couvertes, l’amélioration de pages existantes, le traitement de problèmes étiquetés « help wanted », et la traduction des pages dans différentes langues. Les pages sont écrites en Markdown, ce qui permet de les modifier facilement et de les soumettre via des pull requests. Le projet met en avant une communauté accueillante et collaborative, avec des directives de contribution et une documentation de gouvernance. Un site de suivi de la traduction et des salons Matrix sont également disponibles. Le README mentionne également des projets similaires tels que cheat.sh, devhints, eg, kb, navi, cheat, Command Line Interface Pages et bropages, désormais déprécié. Le nom TL;DR signifie « Too Long; Didn't Read », ce qui reflète l’objectif du projet : fournir une aide rapide et lisible pour les commandes plutôt qu’une longue documentation.