Первое правило с источником

За несколько команд вы получите два Markdown-документа, найдёте правило доставки, откроете его источник и обновите срок. Все требования в этом примере вымышленные.

Подготовка

Нужны Git, Go 1.25.5 или новее, браузер и оболочка с командами mktemp и cp. Все команды выполняйте в одной оболочке. Исходные файлы репозитория останутся учебным образцом; работать будем с копией во временной папке.

git clone https://github.com/skosovsky/okf.git
cd okf
repo_root=$(pwd)
demo_dir=$(mktemp -d)
go build -o "$demo_dir/okf" ./cmd/okf
cp -R examples/project-knowledge/ru "$demo_dir/my-knowledge"

Посмотреть правило

Откройте retry-policy.md в редакторе. В начале указан тип заметки и источник, а сноска привязывает конкретное утверждение к требованиям:

type: Guide
title: Когда подключать оператора
sources:
  - id: requirements
    title: Учебные требования к доставке
    resource: source-material.md

В тексте указан срок 24 часа, после которого нужен оператор, и ссылка [^requirements]. source-material.md — предоставленный учебный источник. Корневой index.md объявляет okf_version: "0.2" и перечисляет оба документа.

Проверить и открыть

"$demo_dir/okf" validate --path "$demo_dir/my-knowledge" --spec 0.2 --strict --check-links --check-orphans --max-warnings=0
"$demo_dir/okf" view "$demo_dir/my-knowledge" --output "$demo_dir/my-knowledge.html" --spec 0.2 --lang ru

Ожидаемый результат: проверка без ошибок и предупреждений, файл my-knowledge.html. Откройте его в браузере, выберите Когда подключать оператора и перейдите по ссылке предоставленные требования в тексте заметки. Либо выберите Учебные требования к доставке в списке слева. Раздел источников показывает сведения о материале; для открытия локального документа используйте ссылку в тексте или список заметок. Проверка подтверждает структуру и локальные ссылки; срок сверяйте с текстом требований.

Найти ответ

"$demo_dir/okf" search "$demo_dir/my-knowledge" --query "доставку оператор" --limit 5
"$demo_dir/okf" search "$demo_dir/my-knowledge" --query "доставку оператор" --limit 5 --json

Ожидайте результаты из учебных документов, фрагменты текста и номера строк. Откройте найденный файл: оператор нужен после 24 часов неудачной доставки. Поиск требует всех слов в одном разделе, его заголовке или названии заметки. Он нормализует регистр и Unicode, но не переводит запрос и не подбирает синонимы.

Изменить требование и заметку

Учебное изменение: срок увеличен до 48 часов. В редакторе сначала замените 24 на 48 в source-material.md, затем сверьте правило и внесите такую же замену в retry-policy.md. Сохраните ссылку на источник. Не добавляйте verified или даты автоматически: это отдельные решения, требующие фактической проверки.

"$demo_dir/okf" validate --path "$demo_dir/my-knowledge" --spec 0.2 --strict --check-links --check-orphans --max-warnings=0
"$demo_dir/okf" search "$demo_dir/my-knowledge" --query "доставку оператор" --limit 5
"$demo_dir/okf" view "$demo_dir/my-knowledge" --output "$demo_dir/my-knowledge.html" --spec 0.2 --lang ru --overwrite

Теперь оба документа должны говорить о 48 часах. Повторный экспорт заменяет HTML только потому, что вы явно передали --overwrite; открытая ранее страница сама не обновится. Старые номера строк относятся к предыдущему состоянию файла.

Если не получилось

go не найден: установите требуемую версию Go и повторите сборку.
Выходной HTML уже существует: выберите новое имя или явно используйте --overwrite.
Поиск ничего не нашёл: возьмите слова из текста в том же языке; русская и английская папки содержат отдельные переводы.
Ссылка на источник не работает: проверьте resource: source-material.md, имя файла и корневой индекс.

Дальше: подготовить свои Markdown, установить навык или подключить MCP.