Перейти к основному содержимому

Быстрый старт

Этот маршрут рассчитан на уже развёрнутый CodeGraph. Администратор должен выдать вам адрес экземпляра, учётную запись и доступ хотя бы к одному проекту.

Начало работы

Этот маршрут рассчитан на уже развёрнутый CodeGraph. Администратор должен выдать вам адрес экземпляра, учётную запись и доступ хотя бы к одному проекту. Для нового сервера сначала используйте руководство по установке.

1. Проверьте доступность экземпляра

Откройте <адрес-codegraph>/health. Успешный ответ подтверждает доступность API, но не актуальность графа вашего проекта. Если endpoint недоступен, передайте администратору адрес и время запроса; локальные команды из исходного репозитория для этого не нужны.

2. Выберите или импортируйте проект

Откройте /dashboard/projects и выберите доступный вам проект. Если роль разрешает импорт, добавьте репозиторий через интерфейс проектов и дождитесь окончания обработки. Не помещайте логин или токен в адрес репозитория: используйте одобренный в вашей инфраструктуре механизм учётных данных.

Перед анализом проверьте статус проекта и актуальность CPG. При статусе stale, pending или failed ответ может быть сформирован, но остаётся рекомендательным до обновления графа.

3. Выполните первую задачу

Начните с ограниченного вопроса с проверяемым результатом, например:

  • найдите точки входа компонента;
  • оцените последствия изменения конкретного символа;
  • проверьте ограниченный диапазон коммитов;
  • объясните цепочку зависимости и укажите исходные файлы.

Ответ связывает вывод с выбранным проектом и содержит ссылки на исходный код. Условия актуальности и доступности фиксируются рядом с результатом. Инженерное или безопасностное решение принимает ответственный специалист.

4. Посмотрите встроенное демо

Чтобы изучить интерфейс без импорта документов заказчика, откройте /dashboard/onboarding-research и выберите демо-профиль. Демонстрационные данные объясняют сценарий работы; результаты по вашему проекту появляются после его импорта и построения CPG.

Если первый запуск не удался

  • Проект не виден: попросите администратора проверить tenant- и project-доступ.
  • CPG отсутствует или устарел: дождитесь обновления проекта или запросите его.
  • Результат заблокирован: сохраните причину и идентификатор сессии для поддержки.
  • Ответ не содержит исходных свидетельств: сузьте вопрос и проверьте выбранный проект.

Источники контракта

  • src/api/main.py — сборка API и endpoint /health;
  • frontend/src/App.tsx — зарегистрированные маршруты dashboard;
  • src/api/routers/projects.py — операции с проектами;
  • src/services/cpg/ — жизненный цикл и актуальность графа проекта.

Далее: Установка · Конфигурация · Каталог сценариев