安装与快速上手

HookNexus CLI 是官方命令行工具：管理 endpoint、在终端里实时查看 webhook、查看已存储请求，以及把线上流量转发到本机 URL。

开源仓库： github.com/hooknexus/hooknexus-cli

环境要求

• Node.js 18 及以上
• 全局安装需要 npm、pnpm 或 yarn

安装

npm

npm install -g hooknexus

pnpm

pnpm add -g hooknexus

yarn

yarn global add hooknexus

全局安装后，在终端使用 hooknexus。部分环境下还可使用别名 hnx（见 npm 包中的 bin 字段）。

验证：

hooknexus --version
hooknexus --help

登录

当前 login 仅支持 GitHub OAuth。CLI 会打开浏览器完成流程，成功后在本机保存 JWT。

1. 执行：

   hooknexus login

2. 在浏览器中完成登录。

3. 终端提示成功后即可使用。

若本地已有登录态，CLI 可能会询问是否切换账号。

快速开始

# 1. 登录
hooknexus login

# 2. 创建 endpoint
hooknexus endpoints create

# 3. 在终端监听 webhook
hooknexus listen

# 4. 转发到本机（将 PORT/PATH 换成含路径的完整 URL）
hooknexus forward --to http://localhost:PORT/PATH

更新

npm update -g hooknexus

若使用其他包管理器，请使用对应的「全局更新」命令。

卸载

npm uninstall -g hooknexus

CLI 如何连接 HookNexus

• 业务 API（默认）：https://api.hooknexus.com
• 认证 / 计费 API（默认）：https://api.infra-hub.hooknexus.com
• 登录成功后，凭据以 JWT 形式保存在本机。
• WebSocket 连接会同时携带 Authorization 头与 query token。

需要指向自建或预发环境时，可用 hooknexus config（见 命令参考）修改 apiUrl、webUrl 等。

下一步

• 命令参考
• 本地转发
• 故障排查

源码与贡献

• GitHub： hooknexus/hooknexus-cli — 源码、Issue 与开发说明（docs/development.md）。
• npm： hooknexus — 全局安装包名 hooknexus。