cheat

Простенькая утилита, отображающая шпаргалки на заданную тему.

Сборка

Сборка стандартная для Rust:

cargo build --release

Установка

Для установки надо скопировать cheat.exe в какой-нибудь каталог, доступный в PATH.

После установки нужно запустить cheat --init и, при желании, скопировать в ~/.cheat примеры шпаргалок из каталога cheats.

Использование

cheat [OPTIONS] [TOPIC [CHAPTER]]

Доступные опции:

• -i, --init — создать служебный каталог и конфиг по умолчанию.
• -e, --edit TOPIC — редактировать шпаргалку с темой TOPIC.

При вызове без параметров выводится список доступных тем.

Шпаргалка представляет собой Markdown-файл. Заголовки первого уровня разделяют её на разделы (пример см. в cheats/tar.md).

Вызов cheat tar покажет всю шпаргалку tar полностью.

Вызов cheat tar extract покажет только раздел extract из шпаргалки tar.

Файл конфигурации

Конфигурация хранится в служебном каталоге в файле config.toml. Пример конфигурации:

[common]
editor = "nvim"

[aliases]
compress = "tar compress"

• common.editor — редактор для шпаргалок. Если не указан, то берётся из переменной окружения EDITOR.
• aliases — словарь алиасов. Для каждой темы или комбинации «тема-раздел» можно задать сокращённый алиас. В данном случае алиасу compress соответствует тема tar и раздел compress.