Repository navigation
configuration
Эта страница нужна, когда вы снова и снова набираете один и тот же параметр или хотите, чтобы max
вёл себя иначе для одного аккаунта. Прочитав её, вы будете знать, где лежит файл настроек, что
делают основные настройки, как изменить одну из них и как проверить, какое значение действует.
Файл для начала работы не нужен: без него у каждой настройки есть встроенное значение.
Слова, которые встречаются на странице:
-
Файл настроек (
config.json) — текстовый файл, в которомmaxхранит ваши сохранённые выборы. -
Профиль — именованный набор настроек одного аккаунта MAX или одного бота, например
work. Его имя ставится перед командой:max work chats list. См. профили и боты. -
Параметр (флаг) — слово, добавленное к одной команде, например
--limit 5. Он меняет только этот запуск. -
Переменная окружения — именованное значение, которое терминал или процесс агента передаёт
max, напримерMAX_PROFILE=work. -
Значение по умолчанию — то, что
maxберёт, когда ничто другое значение не задало.
Это настройки, которые меняют чаще всего. Точное описание каждой — тип и все способы переопределения — в справочнике настроек.
| Настройка | Что делает | Встроенное значение |
|---|---|---|
limit |
сколько строк показывает список, если не указан --limit
|
20 |
sendsPerHour |
сколько сообщений профиль может отправить за час; останавливает цикл отправок |
30; у бота — без лимита, пока не задан в разделе bot
|
requestsPerMinute |
как часто max обращается к MAX после короткой серии запросов; 0 выключает темп (ограничения и ожидания) |
20 |
permissions |
что профилю можно: только читать, спрашивать перед изменением или делать без вопроса (права) | всё разрешено, кроме: удаление и ещё несколько необратимых изменений сначала спрашивают; автоответы не отправляют |
record |
записывать каждый запуск, чтобы посмотреть потом (диагностика) | false |
keepRunsForDays |
сколько дней хранятся записи запусков | 30 |
color |
цвет в таблицах | по терминалу |
senderColors |
свой цвет у каждого автора в списке сообщений | false |
timeoutMs |
сколько ждать ответа на один запрос к MAX, в миллисекундах. Чтобы ограничить команду целиком, используйте --timeout
|
по транспорту |
catchUpMarksRead |
inbox и review отмечают показанные чаты прочитанными. Собеседник это видит |
false |
serve |
запускать фоновый сервер max personal serve, когда команде нужен MAX (один вход на всё) |
true |
transcribeModel |
какой моделью распознавать голосовые сообщения | gigaam-v3 |
updateCheck |
раз в сутки сообщать, что вышла новая версия max
|
true |
defaultProfile |
какой профиль берёт команда, если профиль не назван | нет: без имени команда перечисляет профили |
Секрета в файле не бывает. В нём нет места для токена, номера телефона или идентификатора чата: токен хранится в ключнице системы, а где её нет — в файле, который можете читать только вы (где живёт токен).
Первая команда, которая читает настройки, создаёт начальный файл. Вот он, с одним добавленным профилем:
{
"defaults": { "limit": 20, "keepRunsForDays": 30, "sendsPerHour": 30, "updateCheck": true, "skillHint": true },
"profiles": {
"work": { "limit": 50 }
}
}-
defaultsдействует для всех профилей. -
profiles.workдействует только для профиляworkи важнееdefaults.
Поэтому max work chats list покажет 50 строк, а max personal chats list — 20. Добавьте --limit 5, чтобы
получить пять строк в одной команде. Уберите limit у профиля — и снова действует значение из
defaults.
Полный пример со всеми разделами
{
"defaultProfile": "personal",
"defaults": {
"limit": 20,
"keepRunsForDays": 14,
"sendsPerHour": 30,
"requestsPerMinute": 20,
"updateCheck": true,
"skillHint": true,
"transcribeModel": "gigaam-v3"
},
"profiles": {
"personal": {
"limit": 50,
"color": true,
"senderColors": true,
"record": true
},
"work": {
"permissions": { "messages": "readonly", "messages.send": "allow" },
"sendsPerHour": 10,
"serve": false
}
},
"personal": {
"defaults": { "catchUpMarksRead": false, "searchCatchUp": true }
},
"bot": {
"defaults": { "permissions": { "bot": "readonly", "bot.messages.send": "allow" } },
"profiles": {
"shop": { "sendsPerHour": 200, "readOtherBots": false }
}
}
}Что делает каждая часть:
-
defaultProfile:max chats listбез имени профиля работает сpersonal. Без этой настройки и безMAX_PROFILEтакая команда остановится и перечислит профили. -
defaults: эти значения получает каждый профиль, если не задал своё.updateCheck,skillHintиtranscribeModelдопустимы только здесь: программа и модели речи одни на все профили. -
profiles.personal: больше строк, цвета и запись каждого запуска — только дляpersonal. -
profiles.work: читать сообщения можно, отправлять можно, остальные изменения сообщений запрещены. Не больше 10 отправок в час. Фоновый сервер не запускается: каждая команда входит в MAX сама. -
personal.defaults: только для команд личного аккаунта, никогда дляmax … bot. Здесьmessages syncещё и готовит скачанные чаты к поиску. -
bot.defaults: только для команд бота (max shop bot …). Боты могут читать и отправлять, и больше ничего. -
bot.profiles.shop: ботshopможет отправить 200 сообщений в час и не читает то, что сохранили другие боты на этом компьютере.readOtherBotsдопустим только в разделеbot;serve,senderColorsиcatchUpMarksReadтам, наоборот, не принимаются.
| Система | Путь |
|---|---|
| Linux и macOS | ~/.config/max-cli/config.json |
| Windows | %APPDATA%\max-cli\Config\config.json |
max config show печатает путь, который действительно использует этот компьютер, и каждую настройку
со значением. В PowerShell набирайте max.cmd вместо max. Существующий файл начальным никогда не
заменяется.
-
В файле: значение сохранится для следующих команд.
max personal config set limit 50записывает его. -
Переменной окружения: значение действует в одном терминале или одном процессе агента.
Например,
MAX_PROFILEвыбирает профиль, аMAX_TIMEOUTограничивает время команды. Переменная есть не у каждой настройки. -
Параметром:
--limit 5меняет только эту команду.
Параметр важнее переменной окружения. Дальше идёт значение профиля в файле, затем defaults в
файле, затем встроенное значение. Настройка участвует только в тех способах, которые она
поддерживает; справочник настроек перечисляет их
для каждой настройки.
Файл можно править в любом текстовом редакторе или поручить это max. config set проверяет
значение до записи, поэтому никогда не сохраняет файл, от которого откажется следующая команда.
max personal config set limit 50 # профилю, с которым вы работаете
max work config set limit 50 # профилю work
max config set sendsPerHour 10 --defaults # всем профилям
max personal config unset limit # вернуть значение по умолчанию
max config show # проверить, что действует и откуда взялось каждое значениеОпечатка в имени настройки — ошибка, а не тихое значение по умолчанию: каждая команда останавливается и называет неверный ключ (опечатки в файле).
Профиль хранит настройки одного аккаунта или одного бота. Его имя ставится перед командой, например
max work config show. Чтобы работать от имени бота, а не личного аккаунта, добавьте bot после
имени. Как создавать профили и переключаться между ними, объясняет страница
профили и боты.
- Права: решить, что можно профилю и агенту, который с ним работает.
- Справочник настроек: каждая настройка, её тип, где она допустима, и все переменные окружения.
- Внешние модели: провайдеры, ключи и выбор модели для распознавания текста на картинках (OCR).