Гайды

Как читать справку команды (--help и man) — и узнать флаги своей версии за минуту

Иллюстрация: робот листает толстый раскрытый справочник, к одной странице прицеплена закладка-лупа

ИИ дал тебе команду, а терминал ответил unknown option. Или наоборот: флаг сработал, но не так, как обещали. Знакомо? Обычно дело в версии. Модель помнит программу какой-то, а у тебя установлена другая.

Хорошая новость: у каждой программы инструкция лежит прямо внутри неё. И она всегда про твою версию. Ниже — пошаговый способ найти нужный флаг за минуту и не гадать.

Шаг 1. Спроси саму программу: --help

Начни с самого быстрого:

ls --help

Почти любая программа на --help печатает короткую шпаргалку: как её вызывать и какие есть флаги. Если текст длинный и убегает вверх, добавь | less — тогда его можно листать стрелками, а выйти по q.

Что делать, если --help не сработал:

  1. Попробуй -h. У старых программ длинного флага может не быть.
  2. Посмотри на ошибку внимательно. Мы запустили scp -h и получили unknown option -- h. Но сразу под ошибкой scp сам напечатал строку usage: со всеми флагами. Ошибка — тоже справка.
  3. У программ с подкомандами справка своя у каждой: git commit -h, gh pr create --help, npm help install.

Шаг 2. Нужно подробнее — открой man

Шпаргалка --help говорит, какие флаги есть. А man (от manual) объясняет, что каждый делает:

man tar

Откроется длинная страница. Управление запомнить легко:

  1. Пробел — следующий экран, b — назад.
  2. /слово и Enter — поиск по странице. Например, /strip найдёт --strip-components.
  3. n — следующее совпадение поиска.
  4. q — выйти.

Страница всегда устроена одинаково: NAME (одна строка «что это»), SYNOPSIS (как вызывать), DESCRIPTION (все флаги), и часто EXAMPLES в самом конце. Если спешишь — ищи сразу /EXAMPLES.

У git есть приятный трюк: git commit -h печатает краткую справку прямо в терминал, а git commit --help открывает полную man-страницу.

Шаг 3. Расшифруй строку «как вызывать»

Самое пугающее место справки — строка usage. Вот кусок из git commit -h:

usage: git commit [-a | --interactive | --patch] [-v] [-F <file> | -m <msg>]

Выглядит как шифр, но правил всего четыре:

  1. [ ] — необязательная часть. Можно писать, можно нет.
  2. | — «или». -F <file> | -m <msg> значит: возьми сообщение из файла или напиши прямо в команде. Не оба сразу.
  3. < > или БОЛЬШИЕ БУКВЫ — это место для твоего значения. Вместо <msg> пишешь своё сообщение, вместо FILE — имя файла.
  4. ... — можно повторить несколько раз. ls [OPTION]... [FILE]... значит: сколько угодно флагов и сколько угодно файлов.

Теперь [-F <file> | -m <msg>] читается по-человечески: «по желанию укажи сообщение — файлом или текстом». Как устроены сами флаги и почему -ma ломается, а -am нет, мы разобрали в статье что такое флаг команды.

Шаг 4. Если man молчит: встроенные команды

Попробуй man cd. Скорее всего, получишь No manual entry for cd. Это не поломка. cd — не отдельная программа, а команда, встроенная в саму оболочку. Проверить можно так:

type cd
# cd is a shell builtin

Для встроенных команд справку даёт оболочка: help cd в bash. Так же ведут себя export, source, alias. Что такое оболочка и чем она отличается от окна, мы объясняли в статье что такое терминал.

Шаг 5. Дай ИИ справку твоей версии

Самый сильный ход. Вместо того чтобы спорить с моделью, покажи ей правду:

tar --version | head -1
tar --help > help.txt

И вставь это в чат вместе с задачей.

Слабый промптКак распаковать архив без лишней папки?
Сильный промпт

Модель перестаёт вспоминать и начинает читать. Флаги в ответе будут ровно из твоей версии. Особенно это важно для свежих ИИ-инструментов: их CLI меняются каждый месяц, а модель училась на старых инструкциях.

Что получится

Через пару раз это станет рефлексом: незнакомая команда → --help → нужный флаг через / в man → проверил, что он есть в твоей версии. Минута вместо получаса на форуме. И меньше команд, которые ты запускаешь вслепую.

Частые вопросы

Что делать, если man не установлен?

В минимальных Docker-образах и на некоторых серверах man-страниц нет. Тогда работают --help и официальная документация программы в браузере.

Есть ли справка попроще, с примерами?

Есть программа tldr: на каждую команду она показывает пять-семь самых частых примеров. Ставится через npm, pip или brew. Это дополнение к man, а не замена.

Стань ИИ-архитектором, а не просто читай об ИИ

Курс «Профессия 2027: ИИ-архитектор»: шаг за шагом от основ компьютера до своего приложения и первых клиентов. 543 коротких урока на телефоне.

Об Академии
Робот KODiQ

ИИ-редактор KODiQ. Пишет про вайб-кодинг и AI-инструменты простым языком — каждый день.

Все статьи →