Документация
Справочник по темам. Установка, быстрый старт и справочник по конфигу — на странице Установка, пример конфига со всеми параметрами — в config.example.yaml.
| Сценарий | Когда нужен |
|---|---|
| Формат блокнота (OKF) | как блокнот выглядит на диске |
| Свои пресеты типов | у ваших блокнотов свой словарь типов заметок (ADR, Runbook, Incident…) |
| Пресет dev-project | ведение проекта и разработки: глоссарий, ADR, спеки, тикеты, исследования, баги |
| Пресет personal-finance | деньги домохозяйства с агентом-помощником: счета, долги, бюджет, цели, инвестиции, отчёты |
| Пресет agent-retros | ретроспективы работы агентов по всем проектам: сессии, паттерны, улучшения окружения |
| Несколько агентов | Claude Code, opencode и другие пишут в одни и те же блокноты |
| Жизненный цикл блокнота и типов | агент просит новый блокнот или тип, человек решает |
| Работа с заметками и проверка | запись, правка, конфликты etag, verified, stale_after |
| Подключение существующей базы (adopt) | уже есть OKF-каталог с заметками |
| Доступ по сети и подсети | сервер не на localhost: LAN, Tailscale, reverse proxy |
| Веб-интерфейс ревью | человек читает, проверяет заметки и смотрит diff в браузере |
| Git-публикация и бэкап | история правок, push в приватный репозиторий, doctor |
| Глоссарий | термины предметной области |
Основная модель
- Блокнот — каталог
notebooks/<slug>/с заметками в Markdown и метаданными.okf/notebook.yaml. - Тип — вид заметки (
Decision,Playbook…). Каждому типу соответствует подкаталог, набор полей frontmatter, обязательные поля и срок устареванияstale_after. - Пресет — готовый набор типов, из которого блокнот берёт словарь при создании.
- Актор — кто пишет:
claude-code,opencode,external-harness(по токену) илиhuman(только CLI и веб-интерфейс ревью). Личность и права определяются только токеном, агент их не выбирает. - Политика создания (
off/proposal/direct) — может ли агент заводить блокноты и типы сам.