快速开始
按照下面的顺序操作,通常几分钟就能收到第一条测试通知。
使用前准备
- 一台 macOS、Windows 或 Linux 电脑;
- 已安装并使用 Codex CLI 或 ChatGPT App 中的 Codex;
- 一个可以创建企业自建应用的飞书账号。
安装后的程序是独立可执行文件,不需要 Rust、Python 或 Node.js,也不需要管理员权限。
1. 安装
macOS 与 Linux
curl -fsSL https://raw.githubusercontent.com/JunieXD/codex-notify/main/scripts/install.sh | shWindows PowerShell
irm https://raw.githubusercontent.com/JunieXD/codex-notify/main/scripts/install.ps1 | iex安装脚本会识别当前平台,下载最新发行包并校验 SHA-256,然后自动把安装目录加入当前用户的 PATH。它不会立即修改 Codex 或飞书配置。
安装成功后,终端会直接显示下一步命令:首次安装运行 codex-notify init,已有安装升级后运行 codex-notify status 检查状态。在 macOS/Linux 上,如果安装目录原本不在 PATH,当前这一次 shell 无法被子进程反向修改,因此安装器会同时显示带完整程序路径的命令;可以立即复制运行,重新打开终端后再直接使用 codex-notify。
安装完成后检查版本:
codex-notify --version如果自动写入用户 PATH 失败,安装器会明确显示警告、需要添加的目录和仍可立即运行的完整路径命令。
Linux 环境
Linux 后台监听需要 systemd 用户会话,但不再依赖 GNOME Keyring 或其他 Secret Service。
2. 准备飞书应用
你需要创建一个飞书企业自建应用,启用机器人能力和发送消息权限,然后取得 App ID 与 App Secret。
如果没有使用过飞书开放平台,请直接跟随飞书应用配置教程。教程会解释每一个术语和操作入口。
3. 运行初始化
codex-notify init中文向导会依次询问:
- 飞书 App ID;
- 飞书 App Secret;
- 接收方式,首次使用建议选择邮箱;
- 接收者邮箱或对应 ID。
App Secret 输入时不会显示字符,这是正常现象。确认前不会修改任何文件;确认后会先备份现有 Codex 配置,再写入通知链和 Hook。
消息平台配置和 App Secret 会统一写入用户目录下的 ~/.codex-notify/config.toml。App Secret 是明文,请不要提交、同步或分享这个文件。
如果已经配置过,再次运行 init 会显示不含密钥的配置摘要,并默认保留当前配置。只有主动选择“重新配置”才会替换飞书设置。
4. 信任 Codex Hook
初始化会添加 UserPromptSubmit 和 Stop 两个 Hook。它们分别用于记录任务开始信息,以及在任务意外结束时提供兜底判断。
ChatGPT App(原 Codex App)
打开“设置” → “钩子”,在“用户”区域把 UserPromptSubmit 和 Stop 分别设为“信任”。
Codex CLI
在 Codex 中运行:
/hooks然后信任这两个 Hook。
5. 发送测试通知
codex-notify test
codex-notify doctor收到飞书测试卡片,并且 doctor 没有报告错误,就可以正常使用了。
如果没有收到消息,请查看排查常见问题。