МессенджерыTelegram

Настройки CLI Telegram

Настройте профили CLI для Telegram, пути к файлам, переменные окружения и фоновую службу.

Сохраните настройки, которые иначе пришлось бы повторять в каждой команде. Здесь описаны их расположение и приоритет, чтобы изменить значение и проверить, какая настройка действует.

Изменить и проверить настройки →

Используйте эту страницу, когда вы снова и снова вводите одну и ту же опцию или если вы хотите, чтобы tg вел себя по-разному для одного аккаунта. В конце вы узнаете, где находится файл настроек, что делают общие настройки, как их изменить и как проверить, какое значение действует. Для работы файл настроек не обязателен: без него каждый параметр имеет встроенное значение.

Несколько слов, которые используются на этой странице:

  • Файл настроек (config.json): текстовый файл, в котором tg хранит сохранённые вами настройки.
  • Профиль: именованный набор настроек для одного аккаунта Telegram или одного бота, например work. Вы ставите его имя перед командой: tg work chats list. См. профили и боты.
  • Опция (или флаг): слово, добавляемое к одной команде, например --limit 5. Меняется только этот запуск.
  • Переменная среды: именованное значение, которое ваш терминал или процесс вашего агента присваивает tg, например TG_PROFILE=work.
  • По умолчанию: значение, которое tg использует, когда ничто другое его не устанавливает.

Что вы можете установить

Это настройки, которые меняет большинство людей. Для каждого из них есть точная запись с типом и всеми способами его переопределения в справке по настройкам.

НастройкаЧто он делаетВстроенное значение
limitсколько строк показывает список, если вы не добавляете --limit20
sends_per_hourнаибольшее количество сообщений, которые этот профиль может отправить за один час; останавливает цикл отправки30; у бота нет ограничений, пока они не установлены в разделе bot
requests_per_minuteкак быстро tg запрашивает информацию в Telegram после короткого всплеска; 0 выключает темп (ограничения и ожидания)не задано, что означает 60
permissionsчто может делать этот профиль: только чтение, сначала спросить или продолжить (разрешения)всё разрешено, но удаление и некоторые необратимые изменения требуют подтверждения; отправка автоответов запрещена
recordвести учет каждого запуска, чтобы просмотреть его позже (диагностика)false
keep_runs_for_daysсколько дней хранятся записи запусков30
colorцвет в таблицахопределяется вашим терминалом
sender_colorsсвой цвет для каждого отправителя в списке сообщенийfalse
timeout_msкак долго может ждать один запрос к Telegram, в миллисекундах. Чтобы ограничить всю команду, вместо этого используйте --timeoutсобственное ожидание соединения
proxyпрокси-сервер для доступа к Telegram, где он заблокирован (настройка прокси)нет
transcribe_withкто превращает голосовые сообщения в текст: auto, messenger или localauto
update_checkраз в день сообщать, когда появится более новая версия tgtrue

Этот файл никогда не хранит секрета. В нем нет места для вашей сессии, хэша приложения, номера телефона или пароля прокси. Сессия представляет собой отдельный файл, а хэш приложения и пароль прокси-сервера передаются в связку ключей вашей системы или, если его нет, в файл, который можете прочитать только вы (где находится логин).

Пример файла настроек

Первая команда, считывающая настройки, создает стартовый файл. Это выглядит так, с добавлением одного профиля:

{
  "defaults": { "limit": 20, "keep_runs_for_days": 30, "sends_per_hour": 30, "update_check": true, "skill_hint": true },
  "profiles": {
    "work": { "limit": 50 }
  }
}
  • defaults применяется к каждому профилю.
  • profiles.work применяется только к профилю work и выигрывает у defaults.

Таким образом, tg work chats list показывает 50 строк, а tg personal chats list — 20. Добавьте --limit 5, чтобы получить пять для одной команды. Удалите limit профиля, и значение defaults будет применено снова.

Полный пример с каждым разделом
{
  "defaults": {
    "limit": 20,
    "keep_runs_for_days": 14,
    "sends_per_hour": 30,
    "requests_per_minute": 60,
    "update_check": true,
    "skill_hint": true
  },
  "profiles": {
    "personal": {
      "limit": 50,
      "color": true,
      "sender_colors": true,
      "record": true
    },
    "work": {
      "permissions": { "messages": "readonly", "messages.send": "allow" },
      "sends_per_hour": 10,
      "proxy": "socks5://proxy.example:1080",
      "transcribe_with": "local"
    }
  },
  "personal": {
    "defaults": { "search_catch_up": true }
  },
  "bot": {
    "defaults": { "permissions": { "bot": "readonly", "bot.messages.send": "allow" } },
    "profiles": {
      "shop": { "sends_per_hour": 200, "read_other_bots": false }
    }
  }
}

Что делает каждая часть:

  • defaults: каждый профиль получает эти значения, если он не устанавливает свои собственные. update_check и skill_hint разрешены только здесь, поскольку для всех профилей существует одна копия tg.
  • profiles.personal: больше строк, цветов и запись каждого прогона, только для personal.
  • profiles.work: чтение сообщений разрешено, отправка разрешена, любое другое изменение сообщений запрещено. Максимум 10 отправок в час. Доступ к Telegram осуществляется через прокси-сервер SOCKS5. Голосовые сообщения на этом компьютере преобразуются в текст.
  • personal.defaults: применяется только к командам для личных аккаунтов, но не к tg … bot. Здесь messages sync также подготавливает полученные чаты для поиска.
  • bot.defaults: применяется только к командам бота (tg shop bot …). Боты могут читать и отправлять, и ничего больше.
  • bot.profiles.shop: бот shop может отправлять 200 сообщений в час и не может читать то, что сохранили другие боты на этом компьютере. read_other_bots разрешен только в разделе bot.

Где находится файл

СистемаПуть
Linux и macOS~/.config/tg-cli/config.json
Windows%APPDATA%\tg-cli\Config\config.json

tg config show печатает путь, который фактически использует этот компьютер, и каждый параметр с его значением. В PowerShell введите tg.cmd вместо tg. Существующий файл никогда не заменяется стартовым файлом.

Три способа задать значение

  • В файле: значение сохраняется для последующих команд. tg personal config set limit 50 сохраняет его.
  • С переменной среды: значение сохраняется для одного терминала или одного процесса агента. Например, TG_PROFILE выбирает профиль, а TG_TIMEOUT ограничивает продолжительность выполнения команды. Только некоторые настройки имеют переменную.
  • С опцией: --limit 5 изменяет только эту команду.

Какое значение имеет приоритет?

Опция побеждает переменную среды. Затем идет собственное значение профиля в файле, затем defaults в файле, затем встроенное значение. Настройка принимает участие только теми способами, которые она поддерживает; Справочник по настройкам перечисляет их для каждой настройки.

Изменить значение

Вы можете редактировать файл в любом текстовом редакторе или позволить tg сделать это. config set проверяет значение перед записью, поэтому никогда не сохраняет файл, который отклоняется более поздней командой.

tg personal config set limit 50        # the profile "personal"
tg work config set limit 50            # the profile "work"
tg config set sends_per_hour 10 --defaults   # every profile
tg personal config unset limit         # back to the default
tg personal config show                # check what is in force, and where each value came from

Параметр с ошибкой в ​​файле является ошибкой, а не молчаливым значением по умолчанию: каждая команда останавливается и называет неправильный ключ (опечатки в файле).

Профили и боты

В профиле хранятся настройки для одного аккаунта или одного бота. Поместите его имя перед командой, например tg work config show. Добавьте bot после имени, чтобы работать как бот, а не как ваш личный аккаунт. Профили и боты объясняет, как их создавать и переключать.

Дальше

  • Разрешения: выберите, какие действия может делать профиль и агент, который его использует.
  • Справочник по настройкам: каждый параметр, его тип, место его появления и каждая переменная среды.