# tldr-pages

> Сообщество и набор кратких справочных страниц по консольным командам с практическими примерами — упрощённая альтернатива man-страницам.

Источник: https://llmdocs.ru/wiki/tldr-pages/ · обновлено 2026-11-09 · лицензия CC BY-SA 4.0

- **Тип**: справочник по командам командной строки
- **Основан**: 2013
- **Автор идеи**: Ромен Прието
- **Формат страниц**: Markdown
- **Лицензия**: CC BY 4.0 (страницы), MIT (код)
- **Платформы**: common, linux, osx, windows, android, freebsd и др.
- **Клиенты**: tlrc (официальный), tealdeer, tldr (Node.js), веб-версия
- **Сайт**: tldr.sh
**tldr-pages** — открытый проект, собирающий короткие справочные страницы по командам командной строки. Каждая страница описывает команду одной фразой и даёт несколько самых нужных примеров с пояснениями. Название — интернет-аббревиатура *TL;DR* (*too long; didn't read*, «слишком длинно, не читал»): проект задуман как ответ на объёмные и сухие [man-страницы](https://llmdocs.ru/wiki/man-pages.md), в которых трудно быстро найти типичный способ использования.

Страницы пишутся в [Markdown](https://llmdocs.ru/wiki/markdown.md) и распространяются под свободной лицензией, поэтому их читают не только люди, но и программы — в том числе языковые модели и ассистенты в терминале.

## История

Проект начал Ромен Прието в 2013 году. Со временем он перерос в сообщество с тысячами участников и организацию на GitHub, которая поддерживает репозиторий страниц, спецификацию клиентов и официальный клиент.[2] Сегодня в коллекции тысячи страниц для разных платформ и переводы на десятки языков, включая русский.

## Пример страницы

Страница — это Markdown-файл строгой структуры: заголовок с именем команды, описание в цитате, ссылка на подробную документацию и пары «пояснение — команда». Так выглядит страница для [curl](https://llmdocs.ru/wiki/curl.md) (сокращённо):

```markdown
# curl

> Transfers data from or to a server.
> Supports most protocols, including HTTP, HTTPS, FTP, SCP, etc.
> More information: <https://curl.se/docs/manpage.html>.

- Make an HTTP GET request and dump the contents in `stdout`:

`curl {{https://example.com}}`

- Send form-encoded data (POST request of type `application/x-www-form-urlencoded`):

`curl {{[-d|--data]}} '{{name=bob}}' {{http://example.com/form}}`
```

Значения в двойных фигурных скобках — подстановки, которые пользователь заменяет своими. Обычно на странице не больше восьми примеров: только самые частые сценарии, а не все флаги. Правила оформления — повелительное наклонение, единые обозначения параметров, длинные и короткие формы опций — описаны в руководстве по стилю.[4]

## Организация

Страницы разложены по каталогам платформ:

| Каталог | Содержание |
|---|---|
| `common` | команды, одинаковые на всех системах (`git`, `tar`, `curl`) |
| `linux` | специфичные для [Linux](https://llmdocs.ru/wiki/linux.md) (`systemctl`, `apt`, `ip`) |
| `osx` | macOS (`brew`, `defaults`, `pbcopy`) |
| `windows` | Windows (`winget`, `robocopy`) |
| `android`, `freebsd`, `openbsd`, `sunos` | прочие платформы |

Переводы лежат в отдельных каталогах `pages.<язык>`, например `pages.ru`. Клиент сначала ищет страницу для текущей платформы и языка, затем откатывается на `common` и английскую версию.[3]

## Клиенты

Читать страницы можно через сайт tldr.sh, но обычно ставят консольный клиент. Он скачивает архив страниц, хранит его локально и показывает страницу с подсветкой:

```bash
brew install tlrc            # официальный клиент на Rust; в Linux — пакет tlrc или cargo install tlrc
tldr tar                     # примеры для tar
tldr --platform linux ss     # страница для конкретной платформы
tldr --language ru grep      # перевод, если есть
tldr --update                # обновить локальный кэш
```

Популярны также tealdeer (быстрый клиент на [Rust](https://llmdocs.ru/wiki/rust.md)) и исторический клиент на Node.js.[6] Поведение клиентов — порядок поиска, кэширование, обязательные ключи — закреплено в спецификации, поэтому все они взаимозаменяемы.[3]

## tldr и man

| | man-страницы | tldr-pages |
|---|---|---|
| Цель | полное описание всех опций | несколько типовых примеров |
| Объём | от экрана до сотен страниц | обычно до 8 примеров |
| Источник | авторы программы | сообщество |
| Формат | roff | Markdown |

tldr не заменяет man: когда нужен редкий флаг или точная семантика, приходится открывать полную документацию (ссылка на неё есть в каждой странице). Но в повседневной работе — вспомнить синтаксис `tar`, [find](https://llmdocs.ru/wiki/find-xargs.md), [grep](https://llmdocs.ru/wiki/grep.md) или `ffmpeg` — короткой страницы обычно достаточно.

## Значение для LLM-документации

Страницы tldr — пример документации, удобной и людям, и машинам: компактный, единообразный Markdown с примерами, которые можно сразу выполнить. Похожие идеи развивает формат [llms.txt](https://llmdocs.ru/wiki/llms-txt.md) — краткая карта сайта в Markdown для языковых моделей. Свободная лицензия CC BY 4.0 разрешает использовать страницы в своих проектах при указании авторства.[5] Внести свою страницу или перевод можно обычным pull request в репозиторий проекта.[1]

## См. также

- [man-страницы](https://llmdocs.ru/wiki/man-pages.md)
- [Shell и Bash](https://llmdocs.ru/wiki/shell-bash.md)
- [Markdown](https://llmdocs.ru/wiki/markdown.md)
- [llms.txt](https://llmdocs.ru/wiki/llms-txt.md)

## Источники

1. [tldr-pages — официальный сайт](https://tldr.sh/)
2. [tldr-pages/tldr — репозиторий на GitHub](https://github.com/tldr-pages/tldr)
3. [tldr-pages — Client Specification](https://github.com/tldr-pages/tldr/blob/main/CLIENT-SPECIFICATION.md)
4. [tldr-pages — Style guide](https://github.com/tldr-pages/tldr/blob/main/contributing-guides/style-guide.md)
5. [tldr-pages — License](https://github.com/tldr-pages/tldr/blob/main/LICENSE.md)
6. [tealdeer — быстрый клиент tldr на Rust](https://github.com/tealdeer-rs/tealdeer)