Отображение шпаргалок по командам Linux с помощью инструмента Tealdeer
Растущее количество ресурсов сделало изучение команд Linux удобным и простым для новичков. Одним из примечательных ресурсов является tldr-pages. Проект tldr-pages представляет собой набор упрощенных и поддерживаемых сообществом справочных страниц для инструментов командной строки. В отличие от традиционных man-страниц
, проект tldr-pages предоставляет краткие и практические примеры для конкретного инструмента командной строки, исключая все другие подробные текстовые части. Помимо официального клиента tldr, существует множество сторонних клиентов для доступа к страницам tldr. Один из них — Тилдир. Tealdeer — это быстрый неофициальный клиент tldr, который позволяет вам получать доступ к шпаргалкам команд Linux и отображать их в вашем терминале.
Разработчик Tealdeer утверждает, что он очень быстр по сравнению с официальным клиентом tldr и другими клиентами tldr, поддерживаемыми сообществом. Tealdeer — это инструмент с открытым исходным кодом, написанный на языке программирования Rust, его исходный код находится в свободном доступе на GitHub.
Установите клиент Tealdeer tldr в Linux
Tealdeer можно установить несколькими способами, перечисленными ниже.
1. Установите Tealdeer с помощью менеджера пакетов.
Tealdeer был упакован для многих дистрибутивов Linux.
Для Arch Linux и его производных он доступен в AUR – tealdeer
, tealdeer-bin
или тилдир-git
. Вы можете установить любой из этих пакетов tealdeer с помощью вспомогательной программы AUR, например Yay, как показано ниже:
yay -S tealdeer
Или,
yay -S tealdeer-bin
Или,
yay -S tealdeer-git
Чтобы установить Tealdeer в Fedora, запустите:
sudo dnf install tealdeer
На NixOS:
nix-env --install tealdeer
В openSUSE:
sudo zypper install tealdeer
В Void Linux:
sudo xbps-install --synchronize tealdeer
2. Установите Тилдира с помощью груза.
Установите язык программирования Rust в вашей системе Linux, если вы его еще не установили.
- Установить язык программирования Rust в Linux
Затем выполните следующую команду, чтобы установить Tealdeer с помощью менеджера пакетов cargo
:
cargo install tealdeer
3. Установите Tealdeer из статических двоичных файлов.
Вы также можете загрузить предварительно скомпилированные двоичные файлы со страницы выпусков GitHub и переместить их в свой ` PATH
, как показано ниже.
wget https://github.com/dbrgn/tealdeer/releases/download/v1.4.1/tldr-linux-x86_64-musl
sudo cp tldr-linux-x86_64-musl /usr/local/bin/tldr
Сделайте его исполняемым:
sudo chmod +x /usr/local/bin/tldr
При желании вы можете загрузить сценарий завершения оболочки для вашего $SHELL
со страниц выпусков, чтобы включить функцию автоматического завершения.
- Bash: скопируйте файл
bash_tealdeer
в/usr/share/bash-completion/completions/tldr
- Рыба: скопируйте файл
fish_tealdeer
в~/.config/fish/completions/tldr.fish
- Zsh: скопируйте файл
zsh_tealdeer
в/usr/share/zsh/site-functions/_tldr
Отображение шпаргалок по командам Linux с помощью Tealdeer в терминале
Получить шпаргалки для команд Unix и Linux стало намного проще с Tealdeer!
Прежде чем начать использовать Tealdeer, необходимо обновить его кеш командой:
tldr --update
Теперь вы можете отобразить шпаргалку любой команды Unix и Linux с помощью клиента Tealdeer, как показано ниже:
tldr command_name
Например, я собираюсь отобразить шпаргалку команды ls
с помощью Tealdeer, используя следующую команду:
tldr ls
Клиент Tealdeer получит запрошенную шпаргалку из проекта tldr-pages и отобразит ее в вашем терминале.
Вот пример вывода вышеуказанной команды:
List directory contents.
List files one per line:
ls -1
List all files, including hidden files:
ls -a
List all files, with trailing `/` added to directory names:
ls -F
Long format list (permissions, ownership, size and modification date) of all files:
ls -la
Long format list with size displayed using human readable units (KB, MB, GB):
ls -lh
Long format list sorted by size (descending):
ls -lS
Long format list of all files, sorted by modification date (oldest first):
ls -ltr
Отображение шпаргалок по командам Linux с помощью Tealdeer в терминале
Видеть? Нет подробных текстовых частей, нет объяснений для каждого флага/опции. Просто небольшое описание команды ls
и практические примеры команд! Вы можете выбрать из списка тот, который хотите использовать!
Нет необходимости просматривать man-страницы
или выполнять поиск в Интернете. Тилдир может предоставить вам практические примеры для большинства команд Unix и Linux.
Вы даже можете получить примеры команды tldr
, как показано ниже:
tldr tldr
Displays simple help pages for command-line tools, from the tldr-pages project.
More information: <https://tldr.sh>.
Get typical usages of a command (hint: this is how you got here!):
tldr command
Show the tar tldr page for Linux:
tldr -p linux tar
Get help for a git subcommand:
tldr git-checkout
Update local pages (if the client supports caching):
tldr -u
Чтобы просмотреть все команды в кеше, запустите:
tldr --list
Если вы хотите очистить локальный кеш, используйте флаг -c
, --clear-cache
.
tldr --clear-cache
После очистки кеша не забудьте обновить локальный кеш:
tldr --update
Для получения более подробной информации обратитесь к разделу справки tldr
:
tldr --help
Usage:
tldr [options] <command>...
tldr [options]
Options:
-h --help Show this screen
-v --version Show version information
-l --list List all commands in the cache
-f --render <file> Render a specific markdown file
-o --os <type> Override the operating system [linux, osx, sunos, windows]
-u --update Update the local cache
-c --clear-cache Clear the local cache
-p --pager Use a pager to page output
-m --markdown Display the raw markdown instead of rendering it
-q --quiet Suppress informational messages
--config-path Show config file path
--seed-config Create a basic config
--color <when> Control when to use color [always, auto, never] [default: auto]
Examples:
$ tldr tar
$ tldr --list
To control the cache:
$ tldr --update
$ tldr --clear-cache
To render a local file (for testing):
$ tldr --render /path/to/file.md
Ресурс:
- Репозиторий Tealdeer на GitHub
Связанное чтение:
- Хорошие альтернативы man-страницам, которые должен знать каждый пользователь Linux
- Как создавать и поддерживать собственные справочные страницы
- Научитесь эффективно использовать справочные страницы
- Как установить отсутствующие man-страницы команд в Ubuntu
- Pinfo — программа CLI для чтения информации и справочных страниц в цвете