Обзор CLI
CLI Status200, status200, управляет вашим проектом Status200 из терминала или скрипта. Она выводит, читает, создаёт, изменяет, удаляет и считает мониторы, инциденты, оповещения, страницы состояния и другие записи, которые предлагает API Status200, с API-ключом вашего проекта.
Как работает CLI
Каждая команда отправляет один запрос к REST API Status200 и выводит ответ. API-ключ и адрес вашего Status200 CLI берёт из флагов, переменных окружения или контекста, который сохранила команда status200 login. Ключ решает, что команда может читать и изменять, точно так же, как в API.
Одна команда, один запрос
Команды для записей входят в CLI: у каждого вида записей, который API Status200 открывает инструментам, есть своя, это те же записи, для которых у сервера MCP есть инструменты. Запустите status200 resources, чтобы вывести их.
Перед началом
- Node.js и npm актуальной LTS-версии, чтобы установить CLI.
- API-ключ вашего проекта. Создайте его в Настройки проекта → Расширенный → Ключи API кнопкой Создать: API-ключ: см. Создайте API-ключ.
- В Status200 Cloud — план Growth или выше. API-ключи проекта работают только на нём: см. API-ключи и SCIM ниже их плана.
Установка CLI
Установите пакет @status200/cli из npm. Он добавляет команду status200, а --version выводит установленную версию:
npm install -g @status200/cli
status200 --versionCLI выпускается вместе с Status200 и имеет тот же номер версии. В самостоятельно размещённом Status200 установите CLI той же версии, что и ваш Status200, чтобы её команды соответствовали записям вашего сервера:
npm install -g @status200/cli@<your-oneuptime-version>Первые команды
Сохраните API-ключ
Войдите с ключом и адресом вашего Status200. CLI сохраняет их как контекст с именем
defaultи с этого момента использует его:status200 login <your-api-key> https://status200.ruОна отвечает
Logged in successfully. Context "default" is now active.В самостоятельно размещённом Status200 используйте его адрес вместоhttps://status200.ru.Выведите свои инциденты
status200 incident listДесять самых новых инцидентов появляются в виде таблицы.
loginсохраняет ключ, не проверяя его, поэтому именно эта команда первой показывает, что ключ работает: если его отклонили, см. Устранение неполадок.Посмотрите, чем ещё можно управлять
status200 resourcesСписок показывает каждый вид записей, с которым можно работать, и его команду, например
monitor,status-pageилиon-call-policy.
Команды кратко
| Команда | Что делает | Подробнее |
|---|---|---|
status200 login <api-key> <instance-url> | Сохраняет API-ключ и адрес как контекст | Аутентификация |
status200 context list, use, current, delete | Выводит, переключает, показывает и удаляет сохранённые контексты | Аутентификация |
status200 whoami | Показывает URL и API-ключ, которые использует следующая команда | Аутентификация |
status200 deploy | Записывает развёртывание или другое изменение для графиков и Status200 AI | Развёртывания и изменения |
status200 <resource> list, get, create, update, delete, count | Работает с одним видом записей | Операции с ресурсами |
status200 resources | Выводит виды записей с их командами | Справочник команд |
status200 version | Выводит версию CLI | Справочник команд |
status200 help [command] | Показывает справку по команде | Получение справки |
Глобальные параметры
Эти параметры работают с любой командой, до неё или после:
| Параметр | Что делает |
|---|---|
--api-key <key> | API-ключ для этой команды вместо сохранённого |
--url <url> | Адрес вашего Status200 для этой команды |
--context <name> | Сохранённый контекст для этой команды вместо текущего |
-o, --output <format> | table, json или wide: см. Форматы вывода |
--no-color | Выводит без цветов |
-V, --version | Выводит версию CLI |
-h, --help | Показывает справку по команде |
Получение справки
У каждой команды есть своя справка с её аргументами, параметрами и значениями по умолчанию:
status200 --help
status200 help incident
status200 incident list --help