Je suppose que cela vous arrive également, mais lorsque je n’utilise plus une commande pendant quelque temps, cette commande, dont je maîtrisais tous les paramètres et options, m’est redevenue complètement inconnue. Et bien sûr je n’ai rien noté, car sur le coup je ne l’ai pas jugé nécessaire vu que je maîtrisais tout ça. Si j’ai de la chance, je retrouve mon bonheur dans mon historique. Sinon, je dois relire la page de manuel, qui souvent s’avère inutile. Et je finis par retourner sur Internet pour chercher de l’aide. Dans cet article, je vous propose de découvrir Navi pour trouver de l’aide facilement sous forme de cas d’usage pratiques, et en plus d’écrire vos propres pages d’aide (cheatsheets, ou feuilles de triche).
Lorsque vous cherchez de l’aide pour une commande, vous utilisez généralement l’aide de l’outil (options -help, -h, etc.) ou sa page de manuel man. Malheureusement, ces méthodes comportent peu d’exemples d’usage, rarement utiles et souvent perdus au milieu de la documentation générale. Et si vous désirez documenter vos propres commandes et cas d’usage, les rajouter au man ou au --help de l’outil est tout simplement impossible. Au mieux, vous pouvez créer des alias ou fonctions pour votre shell, sinon les documenter dans un banal fichier texte.
Des projets de cheatsheets existent déjà pour vous aider. Utiles, ils n’affichent que des exemples concrets des cas d’usage les plus fréquents. Collaboratives, les cheatsheets sont alimentées par la communauté. Intuitifs, vous pouvez consulter rapidement une cheatsheet depuis la ligne de commandes, voire tout simplement depuis le Web pour certaines.
Il existe plusieurs projets de cheatsheets en ligne de...
- Accédez à tous les contenus de Connect en illimité
- Découvrez des listes de lecture et des contenus Premium
- Consultez les nouveaux articles en avant-première