# CLI-команды cobot

`cobot` — единая точка входа для управления всем проектом. Все операции с роботом, симулятором, Docker-контейнерами и документацией выполняются через эту команду.

## Справка

```bash
cobot -h
```

Вывод справки разделён на 4 группы команд:

- **Setup commands** — настройка системы
- **Run commands** — запуск проекта
- **Build commands** — сборка ROS 2
- **Management commands** — управление пакетом

Некоторые команды имеют собственные подкоманды. Пример:

```bash
cobot doc-setup rebuild   # подкоманда rebuild для doc-setup
cobot doc-setup --help    # справка по подкомандам конкретной команды
```

---

## Setup commands

Команды первичной и повторной настройки системы.

### `cobot setup`

Мастер-команда первого запуска. Проводит через три шага:

1. Настройка сервера документации
2. Параметры робота (`cobot-setting.yaml`) — IP, порт FRI, инструмент
3. Выбор среды сборки: ROS2 Jazzy нативно или Docker-образ

```bash
cobot setup
```

Используйте эту команду при первой установке вместо ручного запуска каждой setup-команды.

---

### `cobot local-setup`

Локальная установка ROS 2 Jazzy без Docker: скачивает зависимости через `rosdep`, собирает workspace через `colcon`.

```bash
cobot local-setup
```

!!! note
    После выполнения обязательно выполните `source ~/.bashrc` или откройте новый терминал.

---

### `cobot docker-setup`

Сборка или скачивание готовых Docker-образов для запуска проекта в изоляции. Доступны два варианта:

- **Сборка из Dockerfile** — дольше, но даёт актуальную версию
- **Скачивание готового образа** — быстрее, использует pre-built образ

```bash
cobot docker-setup
```

---

### `cobot doc-setup`

Разворачивает локальный MkDocs-сервер документации — полную копию [онлайн-документации](https://daniel-robotics.gitverse.site/lightweight-cobot/).

```bash
cobot doc-setup          # запустить / собрать документацию
cobot doc-setup rebuild  # пересобрать документацию
```

После запуска документация будет доступна по адресу `http://localhost:8000`.

---

### `cobot robot-setup`

Интерактивный мастер настройки файла `cobot-setting.yaml`. Запрашивает IP-адрес робота, порт FRI, активный инструмент и другие параметры.

```bash
cobot robot-setup
```

!!! tip
    Используйте именно эту команду для изменения конфигурации — она валидирует введённые значения и исключает синтаксические ошибки. Подробнее о параметрах — в разделе [Конфигурация системы](configuration.md).

---

## Run commands

### `cobot run`

Запускает весь стек: hardware interface, MoveIt 2, RViz и опциональные компоненты (Foxglove, REST API). При запуске предлагает выбор:

- **Docker или локально**
- **Симулятор (Webots) или реальный робот**

```bash
cobot run                 # интерактивный выбор режима
cobot run --simulate      # принудительно запустить симулятор
```

---

## Build commands

### `cobot rebuild`

Пересборка ROS 2 workspace через `colcon`. Используется при изменении исходного кода пакетов.

```bash
cobot rebuild
```

!!! note
    Работает только для локальной установки (не Docker). Эквивалент `colcon build --mixin release`.

---

### `cobot clean`

Удаляет сгенерированные папки сборки. Предлагает выбор, какие именно удалить:

- `build/` — артефакты компиляции
- `install/` — установленные файлы пакетов
- `log/` — логи сборки

```bash
cobot clean
```

---

## Management commands

### `cobot update`

Скачивает последнюю версию проекта с GitVerse и переустанавливает CLI `cobot`.

```bash
cobot update
```

---

### `cobot delete`

Удаляет компоненты проекта с системы. Предложит выбор: удалить только проект, Docker-образы и контейнеры, или также ROS 2.

```bash
cobot delete
```

!!! danger
    Операция необратима. Удалённые файлы и Docker-образы потребуют повторной установки.

---

**Управление роботом:** [Управление через REST API](control/rest-api.md)