Снимок документации · CLI 7.30.1 · SDK 2.6.53. Desktop использует среду выполнения из собственного выпуска. Команды и примеры сохранены из английского оригинала. Английский оригинал

Создание и использование первого AX Wiki

Перед началом

AX Wiki превращает выбранные материалы репозитория в страницы об архитектуре и процессах. Это знания о репозитории, отдельные от документации сайта AX Code. Сначала подключите поставщика и выберите доступную модель. При генерации выбранные доказательства отправляются этому поставщику, что может оплачиваться.

Запускайте из папки проекта. Git-проекты используют ближайший корень worktree даже при запуске из вложенной папки. Проверьте checkout и решите, нужно ли версионировать созданные файлы.

Предпросмотр и генерация

План показывает выбранные файлы и страницы без вызова модели. Просмотрите его до генерации:

ax-code wiki plan

Затем выполните генерацию настроенной моделью, проверьте результат и откройте локальный просмотрщик:

ax-code wiki generate
ax-code wiki doctor
ax-code wiki viz --open

Каталог по умолчанию — .ax-wiki/, начальная страница — .ax-wiki/quickstart.md; .ax-wiki/.manifest.json хранит источники и хеши. Генерация может обновить блок указателей Wiki в AGENTS.md; используйте --skip-agents, чтобы пропустить этот шаг. Просмотрите полученный diff.

Чтение и полезные вопросы

Начните со вводной страницы, переходите к цитируемым файлам и спрашивайте, где реализован процесс. Просмотрщик показывает страницы, ссылки на источники и записанные связи. Остановите работающий на переднем плане CLI-просмотрщик с помощью Ctrl+C.

Используйте Wiki для ориентации, затем изучайте текущий код и тесты. Для точных символов, вызывающих функций и ссылок используйте анализ кода или LSP. Актуальная страница не доказывает полноту покрытия, правильность или производительность выполнения.

Поддержание актуальности

После изменений исходников обновите затронутые страницы и проверьте состояние:

ax-code wiki update
ax-code wiki status
ax-code wiki doctor

Команда состояния может завершиться успешно и при отсутствии Wiki; проверяйте сообщаемое наличие и исправность. Устаревший или нездоровый результат требует изучения. CLI-просмотрщик показывает фиксированный снимок: откройте его заново после обновления.

В текущих версиях TUI команда /wiki-viz открывает просмотрщик и запрашивает обслуживание. Интерактивное обслуживание во время простоя включено по умолчанию; основная работа приоритетнее. Запуск без интерфейса не включает этот планировщик.

Управление генерацией

Добавьте эти необязательные настройки в проектный ax-code.json. Замените ID моделью, доступной через ваше подключение. Пример отключает фоновое обслуживание, сохраняя явные команды:

{
  "wiki": {
    "enabled": true,
    "auto": false,
    "model": "provider/model"
  }
}

Явный --model provider/model переопределяет модель Wiki для этого вызова. Для моделей рассуждения генерация Wiki требует распознаваемого низкого или отключённого режима; выберите другую поддерживаемую модель, если политика отклоняет запрос.

Заметки сопровождающих размещайте в защищённых блоках, чтобы сохранить их при обновлениях:

<!-- AX-WIKI:PROTECTED:START project-note -->

Deployment requires maintainer review.

<!-- AX-WIKI:PROTECTED:END -->

Восстановление после проблем

Нет модели или ошибка аутентификации: проверьте доступ к поставщику и настроенную модель Wiki. Работающий выбор для чата не гарантирует доступность отдельной модели Wiki.
Тайм-аут или прерванная сборка: изучите ax-code wiki doctor и .ax-wiki/.build-report.json, устраните причину и повторите. Проверенные временные страницы могут использоваться повторно; неудачная сборка не означает, что опубликованы все страницы.
Конфликт ручных правок: сохраните заметки в защищённых блоках и проверьте изменения до повтора. --force разрешает замену правок вне этих блоков; используйте его осознанно.

Следующие шаги

Настройки Wiki, CI и устранение неполадок · Просмотрщик и автономный экспорт · Выбор модели · Главная страница документации