Ответ совпадает с вашей версией

Документация в терминале

Q: На каком языке пояснения?

Сообщения команд по умолчанию на английском. --notes ru переключает их и записки в новом сайте на русский.

Q: Где все флаги?

В спецификации 21, раздел 10: команды и флаги .

Образ HERON несёт свою документацию, поэтому ответ всегда совпадает с версией, которую вы запускаете, даже без интернета. Шесть команд покрывают чтение документации, ещё семь — всю жизнь сайта.

Команды ниже используют короткое имя heron из раздела «С чего начать». Без него поставьте перед docs команду docker run --rm ghcr.io/fmstm/heron:prod.

Простыми словами

Терминал — окно, где вы печатаете команду и нажимаете Enter вместо нажатия кнопок. HERON живёт там: любое действие — создать сайт, посмотреть его, собрать, прочитать документацию — это одна короткая строка. Учить сам терминал не нужно: достаточно копировать строки с этой страницы.

Пример. Забыли, что значит код ошибки. Напечатайте heron docs --search "E015" и нажмите Enter: терминал покажет файл и абзац с объяснением, даже без интернета.

Ни разу не открывали терминал? Как открыть его на macOS, Windows и Linux, показано на странице Docker и терминал.

Читать документацию

Посмотреть, что есть

Оглавление: с чего начать, роли для ИИ-агентов, гайды по порядку, справочник.

heron docs

Когда: В первый раз или когда забыли название темы.
Что вы увидите: Короткий список, сгруппированный как на этом сайте: с чего начать, роли для ИИ-агентов, гайды 01–06, спецификации. В каждой строке — имя темы, которое вводить дальше.
Следующий шаг: Выберите имя из списка и запустите heron docs с ним, например heron docs first-site.
Интернет не нужен: Всё внутри образа, который вы уже скачали.

Прочитать одну тему

Печатает документ целиком. Добавьте | less, чтобы листать постранично.

heron docs theme | less

Темы: readme, agents, concepts, first-site, pages, theme, seo, deploy, contract, engine, deploy-spec, distribution, architecture и роли architect, content, designer, builder, capabilities.
Прокрутка: С | less пробел листает дальше, b — назад, / и слово — поиск, q — выход.
Тот же текст, что здесь: heron docs seo печатает гайд, который можно прочитать и на странице SEO и языки, в вашей версии.
Язык: Документы написаны по-русски; на этом сайте они есть и по-английски.

Найти ответ

Ищет по всей документации и показывает файл, строку и текст вокруг. Работает и для слов, и для кодов ошибок.

heron docs --search "E023"

Типичный случай: Сборка остановилась с кодом ошибки: найдите его и прочитайте, как исправить.
Что получите: Каждое совпадение — файл, номер строки и несколько строк вокруг, так что ответ виден без открытия файла.
Ищутся и слова: heron docs --search "slug" найдёт все места, где объясняются адреса.
Кавычки: Если в запросе есть пробелы, берите его в кавычки: heron docs --search "redirect_from".

Взять образец файла

Печатает образец файла с пояснением каждого поля.

heron docs template page.md

Образцы: page.md, site.yaml, theme.yaml, structure.md.
Сохранить в файл: heron docs template site.yaml > site.yaml.sample запишет образец рядом с сайтом, дальше копируйте нужные куски.
С комментариями: У каждого поля комментарий: что оно делает и можно ли оставить его пустым.
Всегда актуально: Тесты HERON собирают эти образцы, поэтому они совпадают с вашей версией.

Выгрузить для редактора или агента

Записывает всю документацию папкой с работающими ссылками между файлами. Откройте её в редакторе или отдайте ИИ-агенту.

heron docs --export .heron-docs && ls .heron-docs

Зачем: Агент читает правила ровно вашей версии и не угадывает.
Куда попадает: Папка .heron-docs в текущей папке, с теми же именами файлов и рабочими ссылками, что в git.
Для агента: Скажите ему: «Сначала прочитай .heron-docs/AGENTS.md и работай в роли контента».
Не кладите в git: Добавьте .heron-docs/ в .gitignore; после обновления HERON выгрузите заново.

Без короткого имени

Те же команды напрямую из образа — для сервера или автосборки.

docker run --rm ghcr.io/fmstm/heron:prod docs --search "redirect_from"

Важно: Папку сайта нужно подключать только для --export: он записывает файлы.
Когда пригодится: На сервере без короткого имени heron, в задаче GitHub Actions или на компьютере коллеги.
Другая версия: Замените prod на точный тег, например 0.1.0, — и прочитаете документацию той версии.
Выгрузка без короткого имени: Добавьте -v "$PWD":/site -w /site, чтобы файлы попали в вашу папку.

Команды для сайта

Команда	Что делает
heron new my-site -y	Создаёт папку сайта с демо-страницами и темой, без вопросов; настройки делаются в конфигураторе
heron new my-site	То же, но в терминале спрашивает, на каком языке вам удобнее работать, название, домен, языки и основной язык
heron setup .	Конфигуратор: анкета о сайте; сохраняет ответы в site.yaml
heron page page about .	Добавляет страницу нужного типа с полным блоком для поиска и секциями
heron serve .	Показывает сайт на localhost:8000 и пересобирает при каждом сохранении
heron check .	Показывает все проблемы без сборки
heron build . --env prod --strict	Собирает итоговый сайт в dist/, открытый для поиска, любое предупреждение — ошибка
heron --version	Показывает версию, ветку, коммит и время сборки вашего HERON

Ошибки читаются как инструкции

Если что-то не так, HERON печатает код, где это случилось, что именно не так и что делать. Длинных технических трасс нет.

heron docs --search "E015"

Добавьте --debug к любой команде, если чините сам HERON и нужна полная трасса.

Вопросы

Нужен ли интернет для heron docs?

Нет. Документация внутри образа, поэтому работает и в самолёте, и на сервере без доступа к GitHub.

Почему важна версия документации?

Правила меняются от версии к версии. Если сайт собирается версией 0.1, верна документация 0.1, даже когда на GitHub уже новая.

На каком языке пояснения?

Сообщения команд по умолчанию на английском. --notes ru переключает их и записки в новом сайте на русский.

Где все флаги?

В спецификации 21, раздел 10: команды и флаги.