Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.velesagent.com/llms.txt

Use this file to discover all available pages before exploring further.

​
CLI и эксплуатация

CLI нужен для первичной настройки, локального общения с Велесом, запуска сервера, OAuth-входа, диагностики каналов и эксплуатации в Docker/systemd.

​
Основные команды

КомандаНазначение
nanobot onboardСоздать конфигурацию и рабочую область
nanobot onboard --wizardИнтерактивная настройка
nanobot agent -m "..."Одно сообщение Велесу
nanobot agentИнтерактивный CLI-чат
nanobot gatewayЗапуск сервера Велеса
nanobot statusСтатус конфигурации, рабочей области и провайдеров
nanobot provider login ...OAuth-вход
nanobot channels loginПривязка моста WhatsApp
nanobot channels statusСтатус каналов
nanobot plugins listСписок встроенных каналов и каналов-расширений
nanobot secrets generate-keyСгенерировать главный ключ для зашифрованных секретов

​
Onboard

nanobot onboard
nanobot onboard --wizard
nanobot onboard --config ~/.nanobot-work/config.json --workspace ~/.nanobot-work/workspace
Если файл конфигурации уже существует, обычный onboard предлагает:
  • перезаписать значения по умолчанию;
  • обновить конфигурацию, сохранив существующие значения и добавив новые поля.

​
Локальный чат

Одно сообщение: 
nanobot agent -m "Составь краткий план работы"
Интерактивно: 
nanobot agent
С отдельной сессией: 
nanobot agent --session cli:research
С отдельной рабочей областью или конфигурацией: 
nanobot agent -c ~/.nanobot-work/config.json -w ~/.nanobot-work/workspace
Флаги вывода: 
nanobot agent --no-markdown
nanobot agent --logs

​
Сервер Велеса

nanobot gateway
nanobot gateway --port 18791
nanobot gateway --config ~/.nanobot-work/config.json
nanobot gateway --workspace /tmp/veles-sandbox
nanobot gateway --verbose
Сервер запускает:
  • цикл обработки сообщений Велеса;
  • HTTP API и внутренние вызовы;
  • управление каналами;
  • службу расписаний;
  • службу периодических проверок;
  • подключения MCP.
При остановке сервер закрывает MCP, каналы, расписания, периодические проверки и сохраняет ожидающие сессии на диск.

​
Статус

nanobot status
Команда показывает:
  • путь к конфигурации;
  • рабочую область;
  • модель по умолчанию;
  • состояние ключей API, OAuth и локальных провайдеров.

​
OAuth

nanobot provider login openai-codex
nanobot provider login github-copilot
Для Codex с зашифрованным хранилищем нужен NANOBOT_SECRETS_MASTER_KEY. Сгенерировать: 
nanobot secrets generate-key

​
Каналы

nanobot channels status
nanobot channels login
nanobot plugins list
channels login нужен для сценариев с мостом вроде WhatsApp. Для Telegram обычно достаточно токена в конфигурации и запущенного сервера.

​
Периодические проверки

Периодическая проверка читает HEARTBEAT.md в рабочей области и выполняет задачи через обычный цикл Велеса. Пример: 
## Periodic Tasks

- [ ] Каждый будний день присылай краткий список просроченных задач.
Сервер должен быть запущен, а Велес должен знать последний активный внешний канал, куда доставлять результат.

​
Docker Compose

docker compose run --rm nanobot-cli onboard
docker compose up -d nanobot-gateway
docker compose logs -f nanobot-gateway
docker compose down

​
Docker

docker build -t nanobot .
docker run -v ~/.nanobot:/root/.nanobot --rm nanobot onboard
docker run -v ~/.nanobot:/root/.nanobot -p 18790:18790 nanobot gateway
docker run -v ~/.nanobot:/root/.nanobot --rm nanobot agent -m "Привет"
Монтирование ~/.nanobot сохраняет конфигурацию, рабочую область, служебное состояние и зашифрованные секреты между запусками.

​
Пользовательская служба systemd

Минимальный unit: 
[Unit]
Description=Сервер Велеса
After=network.target

[Service]
Type=simple
ExecStart=%h/.local/bin/nanobot gateway
Restart=always
RestartSec=10
NoNewPrivileges=yes
ProtectSystem=strict
ReadWritePaths=%h

[Install]
WantedBy=default.target
Команды: 
systemctl --user daemon-reload
systemctl --user enable --now nanobot-gateway
systemctl --user status nanobot-gateway
journalctl --user -u nanobot-gateway -f