nodus-wechat
v0.8.0
Published
CLI installer for Nodus WeChat and Hermes native Weixin gateway settings.
Downloads
1,701
Readme
nodus-wechat
CLI installer for Nodus WeChat and Hermes native Weixin / WeChat gateway settings.
Run:
npx nodus-wechatCommands
npx nodus-wechat setup
npx nodus-wechat setup --install-hermes
npx nodus-wechat install-hermes
npx nodus-wechat setup-weixin
npx nodus-wechat install-openilink
npx nodus-wechat doctor
npx nodus-wechat start
npx nodus-wechat start --openilink
npx nodus-wechat start --no-install
npx nodus-wechat start --no-hermes
npx nodus-wechat start --no-dashboard
npx nodus-wechat start --docker
npx nodus-wechat status
npx nodus-wechat status --openilink
npx nodus-wechat logs
npx nodus-wechat logs --openilink
npx nodus-wechat stop
npx nodus-wechat uninstall --yes
npx nodus-wechat clean --yesFor a server-bound OpeniLink origin:
npx nodus-wechat setup \
--openilink-origin http://192.220.25.138:9800 \
--openilink-rp-id 192.220.25.138setup prompts for the AstraGate API key when --api-key is not supplied.
The default gateway base URL is https://api.nodus.sbs/.
Use --install-hermes or install-hermes to run the official Hermes installer
with --skip-setup and the same Hermes home used by this CLI.
Use setup-weixin to run the Hermes Weixin / WeChat QR setup guide. It will
ask you to select Weixin / WeChat, scan the QR code with WeChat, and choose
the direct-message access policy.
Use install-openilink only for the legacy OpeniLink POC mode.
Current behavior
- Creates local configuration at
~/.nodus-wechat/config.json. - Can install Hermes Agent CLI through the official NousResearch installer.
- Guides Weixin / WeChat QR binding through Hermes native gateway setup.
- Can install OpeniLink Hub native CLI through the official OpeniLink installer for legacy mode.
- Installs the legacy OpeniLink + webhook POC runtime at
~/.nodus-wechat/runtime. - Writes Hermes common settings to
~/.hermes/config.yaml. - Writes the AstraGate key to
~/.hermes/.envasASTRAGATE_API_KEY. - Sets Hermes static UI/message language to Simplified Chinese with
display.language: zh. - Writes runtime
.env, Docker Compose, webhook server, helper scripts, and the OpeniLink reply plugin. - Stores gateway base URL, api key, model, Hermes paths, OpeniLink origin, webhook port, and runtime path.
- Checks Node.js, local configuration, Hermes files, Weixin credentials, optional OpeniLink/Python/Docker availability, Hermes CLI availability, and WeChat app detection with
doctor. - Starts/stops Hermes Gateway and Hermes Dashboard with native host processes by default.
- Installs Hermes automatically during
startwhen the native CLI is missing. - Exposes the Hermes management/configuration UI at
http://127.0.0.1:9119. - Keeps OpeniLink available only when
start --openilinkis passed. - Keeps Docker Compose available only when
--dockeris passed. - Removes Nodus WeChat config/runtime files with
uninstall --yes. - Cleans Nodus WeChat config/runtime plus generated Hermes settings with
clean --yes.
Uninstall and clean
npx nodus-wechat stop
npx nodus-wechat uninstall --yesUse clean --yes when you also want to remove the generated Hermes settings:
npx nodus-wechat clean --yesclean --yes removes ~/.nodus-wechat, removes ASTRAGATE_API_KEY from
~/.hermes/.env, and removes ~/.hermes/config.yaml only when it still matches
the config generated by this CLI.
WeChat Flow
npx nodus-wechat setup
npx nodus-wechat install-hermes
npx nodus-wechat setup-weixin
npx nodus-wechat startAfter setup-weixin, WeChat becomes the chat entrypoint for Hermes through
Hermes' native Weixin adapter. OpeniLink is not required for the default path.
Legacy OpeniLink POC
If you explicitly run start --openilink, open the OpeniLink Hub shown by the CLI. In the Channel
Webhook settings, use:
Webhook URL: http://poc-webhook:9811/webhookIf --webhook-token was configured, set the Channel Webhook auth header to:
Authorization: Bearer <the same token>The bundled webhook responds to:
/ping
/status plus
/add-plus-dry-runPublish
npm run release:check
npm publishThe package is configured for public npm access. If npm reports E401, run
npm login first.
For npm Trusted Publishing, push this package to GitHub and configure npm to
trust the workflow at .github/workflows/publish.yml. The workflow publishes
with OIDC and does not need an NPM_TOKEN secret.
