Настройка Depesher CLI и файла depesher.toml
Depesher CLI читает настройки из файла depesher/depesher.toml в системном каталоге конфигурации текущего пользователя. В файле задаются короткие имена каналов, адреса отправки и необязательный текст сообщения.
Подготовьте каналы
Для личных уведомлений создайте входящий канал и скопируйте его публичный адрес. Если нужна внешняя доставка, создайте и подтвердите исходящий канал, затем свяжите его с входящим. Без внешних способов сообщения можно читать в истории ЛК. Подробный порядок есть в статье «Первое уведомление».
Для рабочих уведомлений используйте публичный адрес канала нужной организации. Получателей и их личную доставку настройте по разделу ниже.
Если у входящего канала включена защита токеном, сохраните выданный токен: в интерфейсе он показывается только один раз. Его нужно записать в auth_token.
Создайте конфигурацию
Точный путь зависит от ОС. Посмотреть его можно командой:
bash
depesher --config-pathВ Linux и macOS файл конфигурации можно сразу открыть в Vim одной из команд:
bash
vim $(depesher --config-path)или:
bash
depesher --config-path | xargs vimВместо vim можно указать любой удобный вам редактор.
Типичные пути:
| ОС | Путь |
|---|---|
| Linux | ~/.config/depesher/depesher.toml |
| macOS | ~/Library/Application Support/depesher/depesher.toml |
| Windows | %APPDATA%\depesher\depesher.toml |
Если в системе переопределён каталог конфигурации, фактический путь может отличаться, поэтому ориентируйтесь на вывод depesher --config-path. Если файла нет, CLI создаёт его, не перезаписывая существующие настройки. Откройте файл по этому пути и настройте запись:
toml
[[channel]]
name = "backup_ch"
endpoint = "https://depesher.ru/w/ВАШ_PUBLIC_ID"
content_type = "text/plain"
template = "Бэкап выполнен успешно!"
auth_token = ""Замените endpoint адресом из личного кабинета. Пустой auth_token подходит для канала без защиты; для защищённого вставьте токен без префикса Bearer.
| Поле | Что указать |
|---|---|
name | Имя для команды CLI: строчные латинские буквы, цифры, дефис и подчёркивание ([a-z0-9-_]+). |
endpoint | URL входящего канала на https://depesher.ru. CLI ограничивает отправку этим origin. |
content_type | text/plain или text/markdown. |
template | Необязательный текст, который отправляется, если сообщение не передано аргументом. |
auth_token | Необязательный токен. CLI передаст его в заголовке Authorization: Bearer <token>. |
Имя backup_ch — локальное обозначение в конфиге. Оно не обязано совпадать с названием входящего канала в личном кабинете.
Каналы организации и серверные правила
Администратор или менеджер создаёт входящий канал в выбранной организации и назначает сотрудников или команды. Каждый потенциальный получатель выбирает свои подтверждённые способы в «Моей доставке». Пошаговая настройка — уведомления для команды.
В endpoint укажите скопированный публичный URL этого организационного канала, а в auth_token — его токен, если включена защита. Остальные поля и команды отправки используются так же, как для личного канала. После отправки назначенный сотрудник проверяет «Мои уведомления» и выбранный способ получения.
К тексту CLI на сервере применяются подключённые правила обработки: они могут изменить сообщение, важность, метки и маршрут. Для развилки успеха и ошибки используйте текстовые условия, например из сценария CI/CD. Структурированный JSON отправляйте по HTTP-инструкции: в конфиге CLI поддерживаются text/plain и text/markdown.
Поле template в depesher.toml — готовый текст по умолчанию, отправляемый при отсутствии аргумента сообщения. Шаблон Депешера применяется после серверных преобразований; для включения рабочего текста добавьте в него {{message}}. Перед реальной отправкой сохраните правила и проверьте их на примере.
Проверьте права на Linux и macOS
На Unix конфигурация должна быть обычным файлом, не символической ссылкой, с доступом только для владельца — режим 0600:
bash
chmod 600 "$(depesher --config-path)"В cron и других фоновых процессах учитывайте пользователя запуска: у другого пользователя будет свой системный каталог конфигурации и свой файл depesher.toml.
Добавьте ещё один канал
Для каждого направления добавьте отдельный блок [[channel]] с собственным именем:
toml
[[channel]]
name = "deploy_ch"
endpoint = "https://depesher.ru/w/PUBLIC_ID_КАНАЛА_СБОРОК"
content_type = "text/markdown"
template = "**Развёртывание завершено**"
auth_token = ""После сохранения выполните depesher --list, затем отправьте проверочное сообщение. Рабочие URL и токены храните в конфиге, а в опубликованных примерах используйте заглушки.