N'importe quel utilisateur de la ligne de commande de Linux connaît la commande "man". Si toutefois ce n'est pas le cas, cette dernière permet de consulter la documentation d'une commande en particulier. Chaque commande Linux est décrite dans cet énorme manuel. Cependant, ces pages sont souvent très longues et chercher une simple information devient vite pénible. C'est pourquoi tldr existe. Découvrons cet utilitaire fort pratique qui facilite grandement les recherches d'informations basiques sur une commande.
Les pages man contiennent toutes les informations d'une commande. On y retrouve sa description, la syntaxe de la commande, la liste de ses paramètres, son auteur, quelques exemples utilisations, etc...
Pour vous dire, la page man de la commande curl contient plus de 2700 lignes ! Si votre but est de chercher une simple information sur un paramètre par exemple, chercher l'explication dans la page man devient... long.
tldr est une abréviation très souvent utilisée sur Internet de Too long; didn't read qui exprime un texte trop long et propose donc un résumé. L'utilitaire présenté dans cet article retient bien cette philosophie : aller à l'essentiel.
tldr est un outil développé en Javascript mais plusieurs clients ont été développés dans d'autres langages afin de permettre à l'utilisateur d'avoir le choix de l'installation.
Ainsi, tldr est disponible en bash, sous forme d'extension Chrome, PHP, Python et même sur un site Web ou encore en application Android. Bref, vous avez le choix !
Pour ma part, j'ai installé la version Python (pip install tldr) mais vous pouvez totalement utiliser une autre déclinaison.
L'utilisation de tldr est vraiment très simple. Il vous suffit de renseigner le nom de la commande après l'appel à tldr :
tldr curl
Les principaux usages de curl sont résumés en 20 lignes !
tldr se s'arrête pas qu'aux commandes Linux, il propose des documentations pour d'autres systèmes d'exploitation tels que Windows (tree, xcopy, ipconfig, dir, ...), OSX ou encore SunOS !
Pour le côté technique, le script va en réalité piocher les informations dans des fichiers Markdown. Il est donc très simple de contribuer à tldr, en ajoutant d'autres informations aux documentations existantes ou pour en créer d'autres. Les informations sont donc renseignées par la communauté.
