О проекте
Данный скрипт представляет из себя подобие локального справочника с механизмами поиска:
- по заглавию статьи
- по содержанию текста
являясь подобием / локальным аналогом Wiki с возможностью поиска информации через консоль. Подходит для хранения информации по типичным задачам (инструкции, статьи и пр.).
Поможет сохранить и быстро освежить имеющиеся знания, вместо постоянного поиска одного и того же в интернете.
Можно также создавать свои дополнительные статьи. См. “Создание и редактирование статей”
Проект находится в активной разработке, база статей постоянно растёт. В следующей версии также планируется добавить логику добавления лейблов в статьи и дополнительный поиск по лейблам.
Корретность работы скрипта протестирована на:
- Linux Mint 21.1
- Альт Рабочая станция 10.1
Запуск скрипта (без установки)
- Перейти в папку со скриптом
- bash bash-wiki.sh “искомое слово”
bash bash-wiki.sh "bash"
Установка скрипта
Для более быстрого запуска рекомендуется создать alias в .bashrc-файле. См.:
- Автоматическая установка скрипта
- Ручная настройка скрипта
Автоматическая установка скрипта
- Перейти в папку со скриптом
- Запустить
bash bash-wiki.sh --install
После чего скрипт можно будет запускать командой:
bash-wiki "поисковый запрос"
# вместо bash bash-wiki.sh "поисковый запрос"
Теперь скачанный скрипт можно удалить, так как он (а также все статьи) теперь находятся по пути:
~/.bash-wiki/*
Ручная настройка скрипта
Требуется выполнить поочерёдно две команды, не забыв указать корректный путь до скрипта
echo "alias bash-wiki='bash /путь/до/каталога/со/скриптом/bash-wiki.sh'" >> $HOME/.bashrc
bash
Аргументы скрипта
Узнать версию скрипта
bash bash-wiki.sh --v
Справка по аргументам
bash bash-wiki.sh --help
Подробнее о скрипте
bash bash-wiki.sh --info
Расположение статей
bash bash-wiki.sh --articles
Проверка статей
Если поиск работает некорректно, рекомендуется проверить статьи на корректное форматирование:
bash bash-wiki.sh --check
Поиск по заглавиям статей
bash bash-wiki.sh "процесс"
Отобразит в виде списка заглавия всех helper_*.md файлов, первая строка которых содержит искомое слово. Например:
bash bash-wiki.sh "процесс"
Поисковый запрос: 'процесс'
1: Убить процесс по имени
2: Убить процесс по id
3: Найти процесс по имени
4: Убить все копии процесса по имени
Введите номер статьи:
Введя необходимый пункт, отобразится желаемая статья.
Поиск по тексту статей
bash bash-wiki.sh "процесс" -t
Для поиска по тексту необходимо передать в качестве второго аргумента параметр -t.
bash-wiki "процесс" -t
Поисковый запрос: 'процесс'
Запущен полнотекстовый поиск.
-------------
# Убить процесс по имени
articles/help_1.md
# Убить процесс по имени
-------------
# Убить процесс по id
articles/help_2.md
# Убить процесс по id
-------------
# Найти процесс по имени
articles/help_3.md
# Найти процесс по имени
В таком случае на экран выведется:
- найденное совпадение строки, содержащей данный текст
- название статьи, в которой была найдена строка
- название файла, в котором содержится данный текст.
Создание и редактирование статей
Все статьи хранятся в директории со скриптом в каталоге articles.
Создание новых статей
Создать в каталоге articles, хранящемся в папке со скриптом, новый текстовый файл, начинающийся с help*.
Первая строка каждого файла - это заглавие, оно должно начинаться с "# ". Пример:
# Убить процесс по имени
Далее идёт тело статьи, которое может быть любым. Файл должен заканчиваться пустой строкой.
Редактирование существующих статей
Найти требуемый файл в каталоге /articles. При редактировании учитывать, что первая строка - это заглавие. Она должна начинаться с символа #.