Repolode
Предложить
tldr-pages

tldr-pages/tldr

Поддерживаемая сообществом коллекция шпаргалок с практическими примерами для популярных CLI-инструментов — простая альтернатива man-страницам.

Open source альтернатива:man pages

Открыть на GitHubСайт
Звёзды
64,007
Форки
5,500
Открытые issues
286
Последний коммит
5 часов назад

Что это?

tldr-pages — это поддерживаемая сообществом коллекция справочных страниц для командной строки. На каждой странице собраны несколько распространённых практических примеров вместо полного перечня всех опций, чтобы разработчики могли быстро вспомнить, как пользоваться такой командой, как tar или lsof.

Страницы охватывают инструменты UNIX, Linux, macOS, семейства BSD, SunOS, Android, Windows, Cisco IOS и DOS. Они написаны в Markdown, а новые материалы добавляют через pull request; переводы на многие языки поддерживаются наряду с английскими страницами.

Эти страницы можно читать с помощью нескольких официальных клиентов, в том числе для Python, Rust и Node.js. Веб-клиент с поддержкой офлайн-режима через PWA позволяет просматривать их без установки. В релизах также публикуется версия в PDF.

Ключевые возможности

  • 01Краткие примеры распространённых команд вместо исчерпывающего списка опций
  • 02Поддержка Linux, macOS, BSD, Windows, Android и других платформ
  • 03Страницы в обычном Markdown легко редактировать через pull request
  • 04Официальные клиенты для Python, Rust и Node.js, а также веб-клиент
  • 05Переводы на многие языки

Сценарии использования

  • Быстро вспомнить нужные флаги команды, которой пользуетесь время от времени
  • Освоить незнакомые инструменты командной строки на практических примерах
  • Просматривать справку офлайн через PDF или веб-клиент с поддержкой PWA
  • Добавлять примеры для инструментов, которым не хватает хорошей краткой документации

Быстрый старт

  1. 1

    Установите официальный клиент Python с помощью pipx

    pipx install tldr
  2. 2

    Найдите шпаргалку по команде, например tar

    tldr tar

Что важно знать

  • В метаданных указана лицензия NOASSERTION, поэтому перед повторным использованием проверьте файл LICENSE.
  • Официальный клиент Node.js отстаёт по обновлениям.

Темы

#cheatsheet#command-line#cli#documentation#linux#macos#shell#man-pages#android#bsd

Частые вопросы

Что такое tldr?
Поддерживаемая сообществом коллекция шпаргалок с практическими примерами для популярных CLI-инструментов — простая альтернатива man-страницам. tldr-pages — это поддерживаемая сообществом коллекция справочных страниц для командной строки. На каждой странице собраны несколько распространённых практических примеров вместо полного перечня всех опций, чтобы разработчики могли быстро вспомнить, как пользоваться такой командой, как tar или lsof.
tldr можно использовать бесплатно? Какая у него лицензия?
tldr распространяется с открытым исходным кодом под лицензией Other. Перед использованием в коммерческих продуктах проверьте условия лицензии.
tldr всё ещё поддерживается?
Активно поддерживается. Последний коммит в tldr — 21 окт. 2026 г..
Для чего можно использовать tldr?
Быстро вспомнить нужные флаги команды, которой пользуетесь время от времени Освоить незнакомые инструменты командной строки на практических примерах Просматривать справку офлайн через PDF или веб-клиент с поддержкой PWA Добавлять примеры для инструментов, которым не хватает хорошей краткой документации
Как установить tldr?
Установите официальный клиент Python с помощью pipx: pipx install tldr Найдите шпаргалку по команде, например tar: tldr tar
Где скачать tldr?
Исходный код и инструкции по установке — на GitHub: https://github.com/tldr-pages/tldr

Описание создано ИИ на основе README проекта. Статистика GitHub обновляется ежедневно.

Похожие проекты