документация

README.md

@@ -0,0 +1,53 @@
+# Lambda Agent Backend
+
+#### Это headless агент, предназначенный для запуска на удаленном сервере. Используется через [agent_api](https://git.lambda.coredump.ru/platform/agent_api)
+
+## Запуск
+### 1. Agent_api
+Для локальной разработки и запуска нужен [модуль с API](https://git.lambda.coredump.ru/platform/agent_api).
+Склонируйте его в любую директорию:
+```bash
+git clone https://git.lambda.coredump.ru/platform/agent_api agent_api
+```
+
+Далее нужно добавить путь до этой директории в переменную окружения:
+```bash
+export AGENT_API_PATH=C:/Users/User/agent_api
+```
+
+### 2. Environment
+Заполните файл `.env` по примеру `.env.example`.
+- `COMPOSIO_API_KEY` заполняется, если нужно подключить внешние инструменты из сервиса [Composio.dev](https://composio.dev/)
+
+### 3. Make (опционально)
+Чтобы было удобнее работать с проектом, желательно установить утилиту `make`.
+
+### 4. Запуск
+Через **Make**:
+```bash
+make up-dev
+```
+
+Без **Make**:
+```bash
+docker compose --profile dev up
+```
+
+### 5. Подключение и использование
+Подключиться к агенту можно через скрипт [manual.py](https://git.lambda.coredump.ru/platform/agent_api/src/branch/master/tests/manual.py) из репозитория `agent_api`.
+В качестве `base_url` необходимо указать `ws://localhost:8000/`.
+
+Данные агента хранятся в директории `data`:
+- `data/internal` - служебная информация: история чатов и т. д.
+- `data/workspace` - рабочее пространство агента. Тут он сохраняет все файлы, 
+сюда же они попадают с поверхностей.
+
+#### Отправка файлов в агента:
+- Необходимо вручную добавить файл в директорию `data/workspace`
+- Перед отправкой сообщения через скрипт в `agent_api` запрашиваются вложения:
+`Attachments (comma-separated, empty for none): `. Необходимо через запятую перечислить пути до файлов внутри директории `workspace`. 
+Например, файл `data/workspace/my_dir/file.txt` -> `my_dir/file.txt`
+
+## Субагенты
+В директории `subagents` можно создавать собственных субагентов.
+Подробнее в [SUBAGENTS.md](SUBAGENTS.md)