Skip to content

id-andyyy/LabAI

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🧪 LabAI

AI-ассистент для выполнения лабораторных работ. Автономно выполняет твою лабораторную работу — от задания до готового отчёта по ГОСТу. Ты всё ещё можешь контролировать процесс — через пошаговую инструкцию, черновик, доработку и генерацию документа.

Хватит писать отчёты самому — доверь это дело ЛАБАЮ!

Работает как набор slash-команд для Claude Code.

📋 Требования

  • Claude Code (CLI)
  • Python 3.10+ (для генерации DOCX/PDF)

📦 Установка

# Клонируй репозиторий
git clone https://github.com/id-andyyy/LabAI.git

# Переименуй папку в название своей лабы (для удобства)
mv LabAI "Лаба 3 — Сетевые протоколы"

# Перейди в папку и запусти Claude Code
cd "Лаба 3 — Сетевые протоколы"
claude

Для каждой новой лабораторной — клонируй заново в отдельную папку. Так файлы разных работ не будут мешать друг другу.

Если у тебя есть пример готовой лабораторной работы (своя прошлая работа, работа одногруппника, образец от преподавателя) — положи его в папку проекта. При /lab-setup ассистент проанализирует пример: стили оформления, уровень детализации текста, титульный лист — и будет ориентироваться на него при написании и генерации отчёта.

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

/lab-setup              — один раз: настройка окружения
↓
Положи задание в task.md (или task.pdf, task.docx — setup распарсит)
↓
/lab-instructions       — получаешь пошаговую инструкцию
↓
Выполняешь инструкцию, заполняешь результаты в instructions.md
↓
/lab-draft              — получаешь черновик отчёта (report.md)
↓
/lab-improve            — дорабатываешь по замечаниям (можно несколько раз)
↓
/lab-research           — добавляешь доп. исследование
↓
/lab-conclusion         — итоговый вывод
↓
/lab-report             — генерация финального документа (DOCX/PDF/MD)

🛠 Команды

⚙️ /lab-setup

Первоначальная настройка. Задаёт вопросы о тебе (ФИО, группа), об окружении (ОС, доступное ПО) и о пожеланиях к оформлению. Анализирует пример готовой работы (если есть) — определяет стили, уровень детализации, особенности оформления. Создаёт виртуальное окружение Python и устанавливает зависимости. Парсит весь документ задания целиком (текст, теория, изображения) — сохраняет полный контекст для последующих этапов.

Когда вызывать: один раз в начале. Можно повторно, если что-то изменилось.

📝 /lab-instructions

Читает задание, при необходимости ищет информацию в интернете, и создаёт instructions.md — подробную пошаговую инструкцию: какую программу открыть, что нажать, какую команду ввести. В нужных местах расставляет метки для скриншотов и плейсхолдеры для результатов.

Когда вызывать: после /lab-setup, когда задание уже разобрано.

🆘 /lab-help

Помощь при выполнении инструкции. Что-то не работает, ошибка, непонятен шаг — опиши проблему. Ассистент ответит и при необходимости обновит инструкцию (изменённые пункты помечаются символом ⚠️).

Когда вызывать: в процессе выполнения инструкции.

/lab-help команда ping возвращает "Request timed out"

🔄 /lab-update

Системное обновление инструкции. Не одна конкретная ошибка, а инструкция в целом устарела и расходится с реальностью — множество шагов стали неактуальны. Обновляет незавершённые разделы, не трогая уже выполненные.

Когда вызывать: если инструкция перестала соответствовать действительности.

📄 /lab-draft

Создаёт черновик отчёта report.md — полный текст без изображений. Структура: цель работы, основная часть с разбором каждого задания, плейсхолдеры для рисунков, подписи к ним. Учитывает требования ГОСТ и выбранный стиль изложения.

Когда вызывать: после выполнения инструкции, когда результаты заполнены в instructions.md.

✨ /lab-improve

Доработка отчёта по замечаниям. Опиши, что не устраивает — добавить, убрать, расписать подробнее, сократить. Можно вызывать многократно.

Когда вызывать: после /lab-draft, если нужны правки.

/lab-improve раздел про DNS слишком короткий, распиши подробнее

🔬 /lab-research

Добавляет в отчёт раздел дополнительного исследования. Укажи тему — ассистент разберётся, нужны ли дополнительные действия.

  • Нужны действия — добавит шаги в instructions.md (помечены ⚠️). Выполни их, затем вызови /lab-research снова.
  • Не нужны — сразу напишет аналитический раздел в report.md.

Когда вызывать: когда основной черновик готов.

/lab-research сравнение TCP и UDP при передаче мультимедиа

🏁 /lab-conclusion

Пишет итоговый вывод по всей работе (~0.5 страницы А4): что сделано, что выяснено, какие особенности замечены. Без воды и пересказа отчёта.

Когда вызывать: после /lab-research, перед финальной генерацией документа.

📎 /lab-report

Генерация финального документа. Проверяет полноту отчёта, обрабатывает изображения из папки images/, подставляет их на места плейсхолдеров и генерирует документ в выбранном формате (DOCX, PDF или MD).

Когда вызывать: в самом конце, когда report.md полностью готов.

📁 Структура файлов

.
├── task.md              ← твоё задание (кладёшь сюда)
├── instructions.md      ← пошаговая инструкция (генерируется)
├── report.md            ← черновик отчёта (генерируется)
├── images/              ← скриншоты (кладёшь сюда)
├── CLAUDE.md            ← конфигурация ассистента
└── .claude/
    ├── lab/             ← служебные файлы
    │   ├── config.json
    │   ├── source-material.md  ← полный текст документа (теория + задание + картинки)
    │   ├── source-images/      ← изображения, извлечённые из документа
    │   ├── assignment.md       ← выделенное задание
    │   ├── scripts/
    │   └── templates/
    └── skills/          ← скиллы (команды)

🗺 Типичные сценарии

🟢 Стандартный путь — от задания до документа с доп. исследованием:

/lab-setup → /lab-instructions → выполнение → /lab-draft → /lab-research → /lab-conclusion → /lab-report

🔵 Без доп. исследования — только основная часть:

/lab-setup → /lab-instructions → выполнение → /lab-draft → /lab-conclusion → /lab-report

🟣 Без инструкций — в лабе нет практических действий от пользователя (расчёты, теория, анализ — агент справится сам):

/lab-setup → /lab-draft → /lab-conclusion → /lab-report

🆘 Застрял на шаге инструкции:

/lab-help <описание проблемы>

🔄 Инструкция сильно устарела:

/lab-update

✨ Хочешь поправить отчёт:

/lab-improve <что именно не так>

💬 Обратная связь

Нашёл баг, есть идея или предложение по улучшению — открывай Issue или присылай Pull Request.

📄 Лицензия

Проект распространяется под лицензией MIT.

About

🤖🧪 AI-ассистент ЛАБАЙ для автономного выполнения лабораторных работ

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages