tldr-node-client — многофункциональный Node.js (JavaScript) консольный клиент для сервиса упрощённых справочных страниц tldr pages (command-line client for tldr).
tldr pages — развиваемые сообществом упрощённые справочные страницы (simplified man pages). Авторы проекта решили привнести в консоль лаконичную документацию, содержащую только основную информацию. В коллекции упрощённых справочных страниц представлены команды с кратким описанием их назначения и даны примеры наиболее частого использования запрошенной утилиты/команды.
Проект tldr pages является альтернативой man, info и --help (-h), выводящей лишь краткую справку с наиболее полезной информацией, своего рода набор подсказок или шпаргалок, не являющихся полноценной заменой официальной документации к приложениям. Для получения доступа к страницам tldr необходим клиент (client for tldr), имеется множество клиентов от сообщества с различным набором функциональных возможностей и написанных на всех популярных языках, одним из таких клиентов является tldr-node-client (Node.js client).
Клиент tldr-node-client рекомендуется к использованию авторами проекта tldr pages, так как он является наиболее полнофункциональным и гибким. Для настройки клиента используется конфигурационный файл (~/.tldrrc), создавать его надо самостоятельно. Для начала, в качестве базовой структуры, можно использовать содержимое файла config.json из репозитория, внеся изменения в соответствии со своими потребностями, по настройке имеется подробная документация.
tldr-node-client поддерживает изменение цветовой темы, "по умолчанию" клиентом используется "простая" тема, имеются и предварительно настроенные темы. Собственная тема создаётся в разделе "themes" конфигурационного файла, необходимо помнить что выбор цветов и эффектов ограничен. Локальная база данных справочных страниц (~/.tldr/cache) обновляется вручную, для ускорения работы данные индексируются в файл формата JSON (~/.tldr/cache/index.json).
Лицензия: MLT (The MIT License)
