diff --git a/INSTALL.md b/INSTALL.md index 5897cbf..a80ea84 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -85,29 +85,35 @@ --- -## 4. Вписать свой ключ Polza.ai — обязательный шаг +## 4. Ключ Polza.ai — обязательный шаг -**Где взять ключ:** https://polza.ai/dashboard/api-keys (личный кабинет Polza.ai → -API-ключи → создать). Там же пополнить баланс — расход идёт с вашего счёта. +Ключ нужен обязательно, но вписать его можно двумя способами. -**Куда вписать:** файл `.env` в папке профиля. После установки рядом лежит шаблон -`.env.EXAMPLE`: +### Способ 1 — Блокнот (по умолчанию) -```powershell -cd $env:LOCALAPPDATA\hermes\profiles\vasily -copy .env.EXAMPLE .env -notepad .env -``` +Если в папке нет файла `key.env`, установщик создаст `.env` и откроет его в Блокноте: +впишите ключ после знака `=`, сохраните (Ctrl+S), закройте Блокнот. -В открывшемся файле — одна строка, вписать ключ **после знака `=`, без кавычек и пробелов**: +### Способ 2 — файл `key.env` рядом с `setup.cmd` + +Владелец агента кладёт рядом файл `key.env` с одной строкой: ``` HERMES_CUSTOM_POLZA_AI_API_KEY=ваш_ключ ``` -Ключ в `config.yaml` **не вписывать** — там только имя переменной -(`key_env: HERMES_CUSTOM_POLZA_AI_API_KEY`). Так ключ не уедет в репозиторий и не -потеряется при обновлении. +Тогда Блокнот не откроется — ключ подставится сам. В протоколе установки значение +ключа не печатается. + +> Если владелец передал образец `key.env.example` — переименуйте его в `key.env`, +> вставьте ключ и запустите `setup.cmd`. Ключ владелец передаёт **отдельно от архива**, +> чтобы он не разошёлся по копиям файла. + +### Где взять ключ + +Ключ выдаёт владелец агента (или вы создаёте свой в кабинете Polza.ai: +https://polza.ai/dashboard/api-keys, там же пополняется баланс — расход идёт со счёта +владельца ключа). Проверить, что Hermes видит файл: @@ -117,6 +123,12 @@ Должен вернуться путь `...\profiles\vasily\.env`. +### Куда ключ не вписывать + +Ключ в `config.yaml` **не вписывать** — там только имя переменной +(`key_env: HERMES_CUSTOM_POLZA_AI_API_KEY`). Так ключ не уезжает в репозиторий и не +теряется при обновлении. + --- ## 5. Запустить diff --git a/distribution.yaml b/distribution.yaml index c6218ca..c789e75 100644 --- a/distribution.yaml +++ b/distribution.yaml @@ -1,5 +1,5 @@ name: vasily -version: 1.2.1 +version: 1.2.2 description: "Личный помощник руководителя: документы, письма, договоры, расчёты, поиск, задачи." hermes_requires: ">=0.21.6" author: "AI laboratory SCRUM company"