Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Справочник CLI

Все команды работают в контексте активного проекта (см. cps project use) и требуют входа (cps login). Глобальный флаг --json выводит машиночитаемый JSON вместо таблиц.

Окружение переопределяет конфиг: CPS_API_URL, CPS_TOKEN, CPS_PROJECT_ID.

Аутентификация и контекст

КомандаНазначение
cps login --token <t>Сохранить токен и адрес API в конфиг.
cps whoamiПоказать текущего пользователя/org.
cps versionВерсия CLI.
cps project listПроекты вашей org.
cps project use <prj_id>Сделать проект активным.
cps project create <name>Создать проект.

Машины

cps new <image> --name <n> [--start] [--wait] [опции]
ФлагПо умолчаниюОписание
--cpu <n>1vCPU.
--ram <n>512 (MiB)Память; принимает 2G, 512M.
--disk <n>4Диск в GiB.
--ttl <d>24hВремя жизни; 0 — постоянная машина. Принимает 2h, 30m, 7d.
--ssh-key <path>—Публичный ключ, который прописать внутрь.
--region <r>—Предпочитаемый регион/хост.
--require <label>—Требуемые метки хоста (можно несколько).
--start—Сразу запустить после создания.
--wait—Дождаться готовности.
КомандаНазначение
cps ps [--all]Список машин (--all включает удалённые).
cps status <m>Подробный статус машины.
cps start <m> / cps stop <m>Запустить / остановить.
cps rm <m> --yesУдалить машину.
cps wait <m> --timeout <s>Дождаться готовности.
cps clone <src> --name <n> [--start] [--wait]Клонировать машину.
cps console <m>Подключиться к серийной консоли.

Доступ и файлы

КомандаНазначение
cps ssh <m> [--identity <key>] [-- <cmd>]Root-шелл по SSH (через туннель); с командой — выполнить и выйти.
cps exec <m> [--timeout <s>] -- <cmd>Разовая команда, вернуть stdout/stderr.
cps cp [--recursive] <src> <dst>Копировать файлы (m:/path — путь внутри машины).
cps ssh-proxy <project> <m>Вывести ProxyCommand для нативного ssh/scp.

Публикация портов (ingress)

КомандаНазначение
cps expose <m> <port>Публичный HTTPS-URL на внутренний порт; печатает https://rte-….cps.run.
cps routesАктивные маршруты.
cps unexpose <selector>Снять маршрут.

Snapshot и backup

Машина должна быть остановлена. Snapshot — быстрая точка восстановления; backup — durable-копия в S3 (переносима между хостами).

КомандаНазначение
cps snapshot create <m> --name <n> [--wait]Снять snapshot.
cps snapshot list [<m>]Список snapshot’ов.
cps snapshot show <snap>Детали.
cps snapshot restore <snap> --name <n> [--start] [--wait]Восстановить в новую машину.
cps snapshot rm <snap> [--yes]Удалить.
cps backup create <m> --name <n> [--wait]Создать backup.
cps backup list [<m>] / show <b> / restore <b> … / rm <b> [--yes]Управление backup’ами.

Метрики

КомандаНазначение
cps metrics <m>Текущие CPU / память.
cps metrics <m> --history [--window <s>]История за окно (из ClickHouse).
cps operationsНедавние асинхронные операции проекта.

Секреты

Секреты проекта шифруются at-rest и доступны машинам проекта.

КомандаНазначение
cps secret set KEY=VALUE …Задать секреты.
cps secret listИмена секретов (без значений).
cps secret rm <name>Удалить.

Токены

КомандаНазначение
cps token create [--name <n>] [--ttl <d>]Выпустить токен (секрет показывается один раз).
cps token listВаши токены.
cps token rm <token_id>Отозвать.

Образы

Реестр образов в S3; хосты подтягивают образ по требованию (см. также API).

КомандаНазначение
cps image push <id> --kernel <vmlinux> --rootfs <ext4> [--name] [--version] [--arch] [--boot-args]Загрузить и зарегистрировать образ.
cps image listДоступные образы.
cps image rm <id> [--yes]Удалить образ из реестра и S3.

Администрирование

Требует admin-токена. Обычным пользователям недоступно.

КомандаНазначение
cps admin org create <name> --cpu --ram --disk --max-machinesСоздать org с квотой (авто-создаёт проект default).
cps admin org list / usage <org>Список org / потребление vs квота.
cps admin org quota set <org> …Изменить квоту.
cps admin user create <org> --name [--email] / user rm <user>Пользователи.
cps admin token issue <org> <user> [--name] [--ttl]Выпустить пользовательский токен.
cps admin hosts / cps admin host <inspect|drain|cordon|uncordon|tag> <host>Управление флотом.