Даведнік CLI

sudo aihummer up
aihummer status

# Only check whether a newer release exists
aihummer update --check

# Apply the update
sudo aihummer update

sudo aihummer restart
aihummer logs                 # the gateway unit's journal (default; follows)
aihummer logs --no-follow     # print the tail of the journal and exit
aihummer logs aihummer-stt    # another systemd unit's journal
sudo aihummer stop

aihummer doctor

aihummer backup /var/backups/aihummer
aihummer restore /var/backups/aihummer/aihummer-2026-07-05.sql

sudo aihummer set-password --login admin

aihummer settings set AIHUMMER_STT_URL http://127.0.0.1:8001
aihummer settings get AIHUMMER_STT_URL
aihummer settings list

aihummer license keygen                # generate a signing key
aihummer license sign                  # sign a license
aihummer license show <token>          # decode + verify a token

aihummer loadtest

aihummer plugin init <kind>            # scaffold a manifest (connector|service|openapi|mcp)
aihummer plugin validate manifest.json # validate a manifest against the contract
aihummer plugin keygen                 # ed25519 author key (.key + .pub)
aihummer plugin package ./my-plugin    # build a tarball + .sha256
aihummer plugin sign --key author.key --manifest ./my-plugin/manifest.json my-plugin-1.0.0.tar.gz

# Publish privately to your instance (public publishing is done in the portal — "My plugins")
aihummer plugin publish --private --instance https://host --token <admin> my-plugin-1.0.0.tar.gz

Гэта `aihummer` Камандны інструмент кіруе ўсталёўкай на хосце: ён запускае і абнаўляе шлюз (самая ўсталёўка выконваецца праз асабістую спасылку для ўсталёўкі з партала вашага акаўнта), кантралюе сэрвіс systemd шлюза, выконвае дыягностыку, апрацоўвае рэзервовыя копіі, чытае і запісвае налады кантрольнай плоскасці і падпісвае ліцэнзіі. На гэтай старонцы пералічаны ўсе каманды. ## Каманды | Камандаванне | Што гэта робіць | |---|---| | `up` / `install` | Запусціць службу systemd шлюза (`systemctl start`). Нічога не ўсталёўвае — усталёўка адбываецца праз скрыпт ўсталёўкі па вашай асабістай спасылцы. | | `update [--check]` | Абнавіцца да апошняй версіі (праверыць подпіс + замяніць бінарны файл + перазапусціць) `--check` толькі паведамляе, ці даступна абнаўленне. | | `restart` | Перазапусціць службу шлюзу (`systemctl restart`). | | `stop` | Спыніце службу шлюза (`systemctl stop`). | | `logs [unit] [--no-follow]` | Адсочванне журналу аднаго блока systemd(`journalctl -u`); па змаўчанні выкарыстоўваецца шлюзавы блок. `--no-follow` выводзіць апошнія радкі журнала і завяршае працу; без яго каманда працягвае сачыць. | | `status` | Агляд усталёўкі, стан службаў і гатоўнасць шлюза (`/readyz`). Раздзел **Кампаненты** паведамляе стан неабавязковых сайдкар-юнітаў (пошук, браўзер, маўленне ў тэкст, тэкст у маўленне, відэа); калі `systemctl` недаступны, ён сумленна кажа, што стан невядомы, а не «не ўсталявана». | | `doctor` | Дыягностыка з трыма вердыктамі: усё добра, працуе з папярэджаннямі (N) або знойдзены праблемы. Праверкі Node.js і матэрыялу рэгістрацыі ў флоце — папярэджанні, а не збоі. | | `backup [dir]` | `pg_dump` захоўванне стану PostgreSQL у файл; калі каталог не паказаны, выкарыстоўваецца каталог па змаўчанні. | | `restore <file>` | Аднавіць PostgreSQL з рэзервовай копіі, якая была створана `backup`. | | `uninstall [flags]` | Выдаліць ўстаноўку (глядзіце наступныя сцяжкі). Патрэбныя правы root — запусціце гэта з `sudo`. | | `set-password` / `admin-password` | Усталюеце/стварэце лакальны пароль адміністратара (`[--login admin] [--password X]`). | | `settings {set\|get\|list}` | Чытанне/запіс налад кіравальнага пласта ў базе даных — вось так наладжваюцца ручкі каталога Settings з CLI замест `gateway.env`. | | `license {keygen\|sign\|show <token>}` | Кіраванне ліцэнзіямі: ствараць ключ, падпісваць, дэкадаваць і правяраць дадзены токен. | | `loadtest` | Правядзіце нагрузачны тэст на шлюзе. | | `plugin {init\|validate\|keygen\|package\|sign\|publish}` | Плагін SDK: стварэнне каркаса, праверка, ключы, упакоўка, подпіс і публікацыя. | | `version` | Друкуйце версію. | | `help` | Паказаць дапамогу. | ### `uninstall` сцяжкі | Сцяг | Эфект | |---|---| | `--purge` | Таксама выдаліць дадзеныя (поўнае выдаленне). | | `--yes` | Прапусціць акно пацверджання. | | `--no-backup` | Не стварайце рэзервовую копію перад выдаленнем. | | `--backup-dir <dir>` | Запісвайце рэзервовую копію перад выдаленнем у гэты каталог. | ## Прыклады выкарыстання ### Усталяваць і запусціць Усталёўка ажыццяўляецца праз асабістую спасылку ўстаноўкі з вашага акаўнта (глядзі [Устаноўка](/be/v1.0/getting-started/installation)); пасля гэтага запускаецца CLI і правярае сэрвіс: ```bash sudo aihummer up aihummer status ``` ### Абнаўленне ```bash # Only check whether a newer release exists aihummer update --check # Apply the update sudo aihummer update ``` ### Кантроль сэрвісу і журналы Каманды ўплываюць на адзіны блок systemd шлюза (`AIHUMMER_SERVICE`, па змоўчанні `aihummer-gateway`); `logs` прымае любую назву адзінкі systemd. ```bash sudo aihummer restart aihummer logs # the gateway unit's journal (default; follows) aihummer logs --no-follow # print the tail of the journal and exit aihummer logs aihummer-stt # another systemd unit's journal sudo aihummer stop ``` ### Дыягностыка ```bash aihummer doctor ``` ### Рэзервовае капіраванне і аднаўленне `backup` кіруе `pg_dump` запіс стану самалёта PostgreSQL у файл `restore` бярэ гэты файл дампа. ```bash aihummer backup /var/backups/aihummer aihummer restore /var/backups/aihummer/aihummer-2026-07-05.sql ``` > [!TIP] > Postgres з'яўляецца крыніцай праўды, але ваша `AIHUMMER_MASTER_KEY` і пляма > каталог павінен быць рэзервова захаваны асобна — без галоўнага ключа, шыфраваны > сакрэты нельга аднавіць ### Усталяваць пароль адміністратара Каманда прымае `[--login admin] [--password X]` і патрэбы `AIHUMMER_DATABASE_URL` — звычайна забіраецца з `gateway.env` калі запускаць ад імя карыстальніка ўстаноўкі або праз `sudo`. ```bash sudo aihummer set-password --login admin ``` ### Налады кантрольнай плоскасці `settings` чытае і запісвае кнопкі налады каталога непасрэдна ў базе дадзеных — у тым жа сховішчы, у якім вэб-адмін інтэрфейс (Кіраванне → Налады) робіць рэдагаванне. Вось як налады каталога настроены праз CLI: `gateway.env` іхнія каштоўнасці ігнаруюцца. ```bash aihummer settings set AIHUMMER_STT_URL http://127.0.0.1:8001 aihummer settings get AIHUMMER_STT_URL aihummer settings list ``` `settings list` паказвае толькі ключы каталога, бачныя карыстальніку (сістэмныя і ўнутраныя ключы схаваныя); кожны ключ пазначаны крыніцай — `[db]` для значэнняў, якія вы ўсталёўваеце, `[unset]` з каталожным па змаўчанні інакш. ### Ліцэнзіі `license show` патрабуе `<token>` спрэчка і `AIHUMMER_LICENSE_PUBKEY` зменная: яна дэкадуе і правярае **дадзены** токен — не адлюстроўвае бягучую ліцэнзію інстанцыі. ```bash aihummer license keygen # generate a signing key aihummer license sign # sign a license aihummer license show <token> # decode + verify a token ``` ### Тэст нагрузкі ```bash aihummer loadtest ``` ### Убудовы ```bash aihummer plugin init <kind> # scaffold a manifest (connector|service|openapi|mcp) aihummer plugin validate manifest.json # validate a manifest against the contract aihummer plugin keygen # ed25519 author key (.key + .pub) aihummer plugin package ./my-plugin # build a tarball + .sha256 aihummer plugin sign --key author.key --manifest ./my-plugin/manifest.json my-plugin-1.0.0.tar.gz # Publish privately to your instance (public publishing is done in the portal — "My plugins") aihummer plugin publish --private --instance https://host --token <admin> my-plugin-1.0.0.tar.gz ``` Для поўнага SDK і для публікацыі ў агульны каталог з партала («Мае плагіны») глядзіце [SDK для убудоў](/be/v1.0/marketplace/sdk) і [Апублікаванне плагіна](/be/v1.0/marketplace/publishing). > [!WARNING] > `uninstall` патрабуецца root: выканайце `sudo aihummer uninstall`. І > `sudo aihummer uninstall --purge --yes` выдаляе дадзеныя і прапускае > падцверджанне — пераканайцеся, што ў вас ёсць правераная рэзервовая копія. ## Асяроддзе Зменныя `aihummer` сам інструмент счытвае: | Зменная | Мэта | |---|---| | `AIHUMMER_SERVICE` | Імя адзінкі сістэмы gateway (па змаўчанні `aihummer-gateway`) — мэта `up`/`restart`/`stop`/`logs`. | | `AIHUMMER_GATEWAY_URL` | Шлюзавы URL для `status`/`doctor`/`loadtest` (па змоўчанні `http://127.0.0.1:8780`). | | `AIHUMMER_DATABASE_URL` | Postgres DSN — патрабуецца для `backup`/`restore`/`set-password`/`settings`. | | `AIHUMMER_LANG` | Мова вываду CLI і даведкі: `ru` (прадвызначана) або `en`. | Большасці каманд патрэбны доступ адміністратара (`systemctl`) — run them with `sudo`. ## Куды далей - Настройце экземпляр [Зменныя асяроддзя](/be/v1.0/reference/env-vars). - Вызначце, якімі інструментамі агент можа карыстацца: [Каталог інструментаў](/be/v1.0/reference/tools-catalog).