Перейти к содержимому

Настройка 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-_]+).
endpointURL входящего канала на https://depesher.ru. CLI ограничивает отправку этим origin.
content_typetext/plain или text/markdown.
templateНеобязательный текст, который отправляется, если сообщение не передано аргументом.
auth_tokenНеобязательный токен. CLI передаст его в заголовке Authorization: Bearer <token>.

Имя backup_ch — локальное обозначение в конфиге. Оно не обязано совпадать с названием входящего канала в личном кабинете.

Проверьте права на 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 и токены храните в конфиге, а в опубликованных примерах используйте заглушки.