OpenWiki — это CLI-инструмент, который пишет и поддерживает документацию для кодовой базы. Создан специально для AI-агентов.
Запускаешь OpenWiki, настраиваешь модель и API-ключ, затем генерируешь документацию. Чтобы она не устаревала, в репозиторий добавляется GitHub Action — он раз в день автоматически открывает PR с обновлениями. Файл openwiki-update.yml надо положить в .github/workflows/openwiki-update.yml.
CLI работает в интерактивном режиме. Первый запуск: openwiki с запросом вроде «Сгенерируй документацию для этого репозитория». Если нужна одноразовая команда — флаг -p или --print: openwiki -p "Опиши, что ты умеешь". Такой вызов печатает ответ ассистента и завершается.
Если папки openwiki/ нет — Openwiki создаёт её с начальной документацией. Если уже есть — обновляет её на основе изменений в репозитории. По умолчанию после каждого запуска CLI остаётся открытым, чтобы можно было отправлять уточняющие сообщения.
OpenWiki автоматически дополняет файлы AGENTS.md и/или CLAUDE.md инструкциями — чтобы кодовый агент обращался к документации при поиске контекста. Если файла нет — OpenWiki создаст его.
При первом интерактивном запуске нужно указать провайдера инференса, API-ключ и LLM. Опционально можно добавить ключ LangSmith для трассировки в проект с именем openwiki. Все настройки и секреты сохраняются в ~/.openwiki/.env.
Из коробки OpenWiki поддерживает OpenRouter, Fireworks, Baseten, OpenAI и Anthropic. По умолчанию предопределены несколько моделей (GLM 5.2, Kimi K2.6, Sonnet 5 и другие), но у каждого провайдера можно указать свой кастомный ID модели.
Если нужного провайдера или модели нет — авторы предлагают открыть Pull Request.