Хотите всегда иметь под рукой шпаргалку по командам Linux, без необходимости обращаться к manpages каждый раз и разбираться в их использовании? Для этого существует инструмент под названием cheat. Он поможет быстро освежить память или познакомиться с новой командой.
В Linux есть команда cheat
Cheat — это инструмент для Linux, написанный на Go. Он использует шпаргалки по командам Linux, собранные сообществом, чтобы предоставить основные примеры использования каждой команды. Это может быть особенно полезно, когда вам нужен краткий обзор команды.
Предположим, вы часто используете команду sed. У нее много опций, и чтение manpages не всегда приносит результаты, а поиск в Интернете для конкретных сценариев может занять много времени. В таких случаях можно воспользоваться командой cheat, чтобы увидеть наиболее распространенные примеры использования sed с практическими иллюстрациями.
Установка и настройка cheat в Linux
Давайте разберемся, как установить этот инструмент на вашу систему Linux. Я буду демонстрировать на примере Ubuntu 24.04 LTS. Однако команды, которые я приведу, подойдут и для других дистрибутивов Linux. Для установки cheat можно воспользоваться одной из следующих команд. Прежде чем выполнять, обязательно проверьте страницу релизов на GitHub и используйте последнюю версию (у меня это 4.4.2), а также выберите правильный пакет для вашей системы.
Эта команда загрузит пакет, распакует его, предоставит исполняемое разрешение и переместит его в директорию "/usr/local/bin".
Если на вашем компьютере установлен Go, вы также можете использовать его для установки cheat.
Кроме того, существуют пакеты, поддерживаемые сообществом, которые можно установить через менеджер пакетов. Например, если у вас активирован Snap, вы можете установить его с помощью:
Для проверки успешной установки выполните:
После установки cheat необходимо сделать три вещи:
К счастью, все они выполняются автоматически при первом запуске cheat.
Файл конфигурации будет создан в директории "~/.config/cheat". Это YAML-файл, содержащий необходимые настройки, которые обеспечат комфортное использование cheat. Если вы хотите внести изменения, ищите этот файл.
Вы также можете изменить путь к файлу конфигурации с помощью переменных окружения.
Шпаргалки представляют собой простые текстовые файлы, содержащие название команды, для которой они созданы. Например, шпаргалка для команды cd будет файлом, который содержит список шпаргалок для этой команды. По умолчанию команда cheat не предоставляет шпаргалок. Вместо этого она использует шпаргалки, собранные сообществом, которые вам предлагают загрузить при первом запуске.
Эти шпаргалки хранятся в cheatpaths — наборе директорий, где расположены ваши шпаргалки. Вы можете настроить cheatpaths в файле conf.yml, добавив больше путей или изменив существующие.
Команда cheat поддерживает функцию автозавершения. Однако она доступна только для bash, fish и zsh. Вы также можете интегрироваться с fzf. Для этого сначала сделайте fzf доступным в вашем PATH. Затем выполните:
Мы рассмотрели основные настройки, которые вам понадобятся для работы с cheat. Конечно, это не все возможности этого инструмента.
Как использовать cheat
Теперь давайте разберем, как можно использовать команду cheat для получения шпаргалок для других команд в Linux. Вернемся к нашему примеру с командой sed. Чтобы получить ее шпаргалку, просто выполните:
Это обеспечит вас примерами использования команды sed в различных случаях. В отличие от manpage, вам не придется вводить все вручную. Вы можете просто взять пример, адаптировать его под свои нужды и выполнить команду. Если вы хотите просмотреть все доступные шпаргалки, выполните:
Это выведет список всех команд с имеющимися шпаргалками, их расположение и теги. Теги — это категории, к которым относится команда. Вы также можете просмотреть шпаргалки по определенному тегу. Например, если вы хотите увидеть доступные шпаргалки с тегом 'packaging', выполните:
Это позволит вам проверить доступные шпаргалки для команд определенного типа. Вы также можете просматривать шпаргалки по пути. По умолчанию существует путь "community" и "personal".
Вы также можете искать слова и фразы в шпаргалках, используя флаг -s.
Вы также можете использовать regex для поиска. В этом примере мы ищем IP-адреса.
Здесь видно, что отображаемые шпаргалки содержат IP-адреса, соответствующие нашему regex. Вы также можете комбинировать флаги для более точного поиска.
В этом примере мы ищем шпаргалки в пути community, которые имеют тег "networking" и соответствуют regex для IP-адресов.
Управление шпаргалками
Шпаргалки лежат в основе команды cheat. Чем лучше вы умеете управлять и организовывать свои шпаргалки, тем легче вам будет находить нужные. Здорово, что вы можете загрузить шпаргалки от сообщества во время первоначальной настройки. Если вы этого не сделали, их можно загрузить позже с GitHub.
То же самое касается и файла конфигурации.
Поскольку cheat использует шпаргалки от сообщества, не стоит ожидать, что для каждой команды или инструмента Linux будет шпаргалка. Тем не менее, вы можете создавать свои собственные шпаргалки.
Чтобы создать шпаргалку, выполните:
К примеру, я создаю шпаргалку для команды ripgrep.
Если шпаргалки для этой команды нет, откроется пустой файл в текстовом редакторе. Введите ваш текст здесь и сохраните файл. Вот примеры шпаргалки, которую я создал для команды ripgrep. Попробуйте следовать такому же стилю.
После сохранения вы можете вызвать команду для отображения ее шпаргалки.
Если вы хотите отредактировать существующую шпаргалку, вы можете использовать тот же флаг -e. Это откроет файл, содержащий шпаргалку для этой команды, и позволит вам добавить свои заметки или сценарии использования команды.
Создатели команды cheat сделали Bash-скрипт, который позволяет легко поддерживать ваши шпаргалки. Сначала ознакомьтесь со скриптом по обслуживанию шпаргалок. Если вы хотите скачать и запустить его, используйте следующие команды:
С помощью этого скрипта вы сможете обновлять шпаргалки от сообщества, которые у вас есть. Более того, вы также можете загружать свои шпаргалки в удаленные репозитории, такие как GitHub.
Если вам трудно запоминать команды Linux, cheat — это отличный инструмент для быстрого обращения к информации. Однако это не единственный инструмент для этой цели. Существует еще один инструмент под названием tldr, который выполняет похожие функции. Наличие таких инструментов — это отличный способ освоить новые команды Linux.
Если вам понравилась эта статья, подпишитесь, чтобы не пропустить еще много полезных статей!
Вы также можете читать наши материалы в:
- Telegram: https://t.me/gergenshin
- Яндекс Дзен: https://dzen.ru/gergen
- Официальный сайт: https://www-genshin.ru