Использование скрипта Explain Shell в Linux

Использование утилит является неотъемлемой частью работы с командной строкой Linux. Их существует огромное количество, и запомнить для чего используется каждая просто невозможно. Именно здесь на помощь приходит скрипт Explain Shell, который поможет Вам в изучении команд оболочки.

В этой статье мы расскажем, как установить и использовать Explain Shell в операционной системе Linux.

Содержание:

1. Что такое Explain Shell
2. Написание скрипта Explain Shell
3. Установка Explain Shell в систему
4. Использование скрипта для объяснения команд
5. Выводы

Что такое Explain Shell

Explain Shell — это скрипт, предназначенный для помощи пользователям в изучении утилит оболочки в Linux. Он принимает заданную команду на вход и разбивает ее на отдельные компоненты (опции, аргументы). После чего дает им соответствующие объяснения. Особенностью Explain Shell является использование API. Это означает, что для функционирования скрипта у пользователя должно быть подключение к Интернету.

Важно: прежде чем написать скрипт Explain Shell, убедитесь, что у Вас в системе установлена утилита curl.

Для Debian / Ubuntu:

sudo apt install curl

Для CentOS / RHEL:

sudo yum install curl

Написание скрипта Explain Shell

Чтобы скрипт заработал, его нужно вписать в системный файл .bashrc.

Важно: код Explain Shell должен быть вставлен для каждого пользователя. Так как каждый пользователь имеет свой .bashrc.

Чтобы не повредить системный файл, желательно вставить сценарий в его нижнюю часть. Скрипт Explain Shell выглядит следующим образом.

# explain.sh begins
explain () {
if [ "$#" -eq 0 ]; then
while read -p "Command: " cmd; do
curl -Gs "https://www.mankier.com/api/explain/?cols="$(tput cols) --data-urlencode "q=$cmd"
done
echo "Bye!"
elif [ "$#" -eq 1 ]; then
curl -Gs "https://www.mankier.com/api/explain/?cols="$(tput cols) --data-urlencode "q=$1"
else
echo "Usage"
echo "explain interactive mode."
echo "explain 'cmd -o | ...' one quoted command to explain it."
fi
} 

Принцип работы этого кода следующий:

1. Пользователь указывает команду для объяснения.
2. Утилита curl с помощью API передает входную команду на сервер mankier.
3. Сайт mankier обрабатывает команду и находит данные о ней.
4. Скрипт выводит найденную информацию о команде в терминал.

Установка Explain Shell в систему

Итак, откройте .bashrc с помощью любого удобного текстового редактора. Мы будем использовать nano:

sudo nano .bashrc

Читайте также: Изучение базового написания скриптов оболочки (Shell Scripting) и файловой системы Linux, устранение неполадок — LFCS часть 10.

Затем пролистните его до конца и вставьте соответствующий код, как показано ниже:

Теперь сохраните изменения в файле .bashrc и перезагрузите систему.

Использование скрипта для объяснения команд

Чтобы пользоваться данным сценарием, Вы должны написать в окне терминала explain, и в качестве аргумента указать команду, о которой хотите получить объяснение. Допустим, что мы хотим узнать, для чего используется утилита echo:

explain 'echo'

У большинства утилит есть свои опции. Explain Shell также сможет их определить, если Вы напишете их вместе с командой. Например, узнаем, что означают параметры -a и -l утилиты ls:

explain 'ls -al'

Или же посмотрим, как скрипт объяснит значения опций команды tar -zxvf:

explain 'tar -zxvf'

Читайте также: Как извлечь Tar-файлы в каталог в Linux.

Скрипт не ограничивается обычными параметрами утилит. У Вас есть возможность вводить для объяснения сложные конструкции команд вместе с конвейерами перенаправления ввода / вывода. К примеру:

explain 'ls -l | grep -i Desktop'

Вы также можете использовать данный скрипт в интерактивном режиме. Для этого Вам просто нужно ввести в командной строке explain. Затем Explain Shell предложит вводить интересующие Вас команды. Например:

explain
ls
echo
grep

Выводы

Explain Shell предоставляет удобный способ изучения команд оболочки в Linux. Используя этот скрипт, Вы можете вводить команды в интерактивном режиме или предоставлять их в качестве аргументов для получения подробных объяснений. С помощью скрипта Explain Shell освоение команд оболочки становится более доступным, что позволяет пользователям эффективно работать в командной строки Linux.

Спасибо за время, уделенное прочтению статьи!

Если возникли вопросы — задавайте их в комментариях.

Подписывайтесь на обновления нашего блога и оставайтесь в курсе новостей мира инфокоммуникаций!

Чтобы знать больше и выделяться знаниями среди толпы IT-шников, записывайтесь на курсы Cisco, курсы по кибербезопасности, полный курс по кибербезопасности, курсы DevNet / DevOps (программируемые системы) от Академии Cisco, курсы Linux от Linux Professional Institute на платформе SEDICOMM University (Университет СЭДИКОММ).