mcpField
C
claude-to-im

claude-to-im

github.com/op7418Agent 工作流2.9k7.1k 次安装31 周前更新
代码仓库

关于 claude-to-im

claude-to-im 是用于配置和管理 Claude 与消息平台之间桥接的技能,涵盖设置向导及启动、停止、查看状态和诊断等操作。

主要功能

  1. 01交互式渠道配置
  2. 02启动和停止桥接
  3. 03查看状态与日志
  4. 04更新配置
  5. 05运行诊断检查

适用场景

  1. 01将 Claude 连接到支持的消息平台
  2. 02检查桥接是否正在运行
  3. 03桥接出现问题后查看日志

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/op7418/claude-to-im-skill --skill claude-to-im

安装后在 Claude Code 中输入/claude-to-im确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

.gitignore
CLAUDE.md
config.env.example
SECURITY.md
LICENSE
README.md
README_CN.md
package-lock.json
package.json
evals/
evals.json
references/
setup-guides.md
troubleshooting.md
usage.md
token-validation.md
scripts/
build.js
daemon.ps1
daemon.sh
supervisor-macos.sh
doctor.sh
install-codex.sh
supervisor-linux.sh
supervisor-windows.ps1
src/__tests__/
llm-provider.test.ts
codex-provider.test.ts
config.test.ts
store.test.ts
permission.test.ts
weixin-adapter.test.ts
weixin-api.test.ts
logger.test.ts

详细介绍

Claude-to-IM 桥接技能

你正在管理 Claude-to-IM 桥接。 用户数据存储在 ~/.claude-to-im/。

技能目录(SKILL_DIR)位于 ~/.claude/skills/claude-to-im。 在 Codex 安装中,该目录也可能位于 ~/.codex/skills/Claude-to-IM-skill。 如果这两个路径都不存在,请使用 Glob,匹配模式 **/skills/**/claude-to-im/SKILL.md 或 **/skills/**/Claude-to-IM-skill/SKILL.md,并根据结果推导根目录。

命令解析

将用户的意图从 $ARGUMENTS 解析为以下子命令之一:

用户表达(示例)子命令
setup、configure、配置、我想在飞书上用 Claude、帮我连接 Telegram、帮我接微信setup
start、start bridge、启动、启动桥接start
stop、stop bridge、停止、停止桥接stop
status、bridge status、状态、运行状态、怎么看桥接的运行状态status
logs、logs 200、查看日志、查看日志 200logs
reconfigure、修改配置、帮我改一下 token、换个 botreconfigure
doctor、diagnose、诊断、挂了、没反应了、bot 没反应、出问题了doctor

消歧:status 与 doctor——用户只是想检查桥接是否正在运行(获取信息)时,使用 status。用户报告问题或怀疑某些功能无法正常运行(进行诊断)时,使用 doctor。如无法确定,且用户描述了症状(例如“没反应了”“挂了”),优先使用 doctor。

提取 logs 的可选数字参数(默认为 50)。

在向用户询问任何平台凭据之前,请先在内部阅读 SKILL_DIR/references/setup-guides.md,了解如何获取各项凭据。不要一开始就把完整指南发给用户——只需说明他们接下来要执行的具体步骤(例如:“前往 https://open.feishu.cn → 你的应用 → 凭证,找到 App ID”)。如果用户表示不知道如何操作,再展示指南中的相关部分。

运行环境检测

执行任何子命令前,先检测当前运行环境:

  1. Claude Code——可使用 AskUserQuestion 工具。用它来运行交互式设置向导。
  2. Codex / 其他环境——无法使用 AskUserQuestion。改为提供非交互式指导:说明步骤,展示 SKILL_DIR/config.env.example,并请用户手动创建 ~/.claude-to-im/config.env。

你可以通过检查可用工具列表中是否包含 AskUserQuestion 来进行判断。

配置检查(适用于 start、stop、status、logs、reconfigure、doctor)

运行 setup 以外的任何子命令前,检查 ~/.claude-to-im/config.env 是否存在:

  • 如果不存在:
    • 在 Claude Code 中:告知用户“未找到配置”,并使用 AskUserQuestion 自动启动 setup 向导。
    • 在 Codex 中:告知用户“未找到配置。请根据示例创建 ~/.claude-to-im/config.env:”,然后展示 SKILL_DIR/config.env.example 的内容并停止。不要尝试启动守护进程——没有 config.env 时,进程会在启动时崩溃,并留下过期的 PID 文件,阻止后续启动。
  • **如果存在:**继续执行用户请求的子命令。

子命令

setup

运行交互式设置向导。此子命令需要 AskUserQuestion。如果该工具不可用(Codex 环境),则展示 SKILL_DIR/config.env.example 的内容,并逐字段解释,然后指导用户手动创建配置文件。

如果可以使用 AskUserQuestion,则每次只收集一个字段。每次用户回答后,在继续下一个问题前,先向用户确认收到的值(对于密钥,仅显示最后 4 个字符)。

第 1 步——选择渠道 询问要启用哪些渠道(telegram、discord、feishu、qq、weixin)。接受以逗号分隔的输入。简要介绍各渠道:

  • telegram — 最适合个人使用。支持流式预览和内联权限按钮。
  • discord — 适合团队使用。支持服务器、频道和用户级访问控制。
  • feishu (Lark) — 适用于 Feishu/Lark 团队。支持流式卡片、工具进度和内联权限按钮。
  • qq — 仅支持 QQ C2C 私聊。不支持内联权限按钮和流式预览。权限需使用文本 /perm ... 命令。
  • weixin — 微信二维码登录。仅支持一个关联账号;新登录会替换之前的账号。不支持内联权限按钮和流式预览。权限需使用文本 /perm ... 命令或快速回复 1/2/3。语音消息仅使用微信自带的语音转文字结果;桥接程序不会转录原始语音。

步骤 2 — 收集各渠道的令牌

对于每个已启用的渠道,每次收集一项凭据。用一句话告知用户在哪里找到每项信息。仅当用户请求帮助或表示不知道如何操作时,才显示完整指南部分(来自 SKILL_DIR/references/setup-guides.md):

  • Telegram:Bot Token → 确认(掩码显示)→ Chat ID(获取方法请参阅指南)→ 确认 → Allowed User IDs(可选)。**重要:**必须至少设置 Chat ID 或 Allowed User IDs,否则机器人会拒绝所有消息。
  • Discord:Bot Token → 确认(掩码显示)→ Allowed User IDs → Allowed Channel IDs(可选)→ Allowed Guild IDs(可选)。**重要:**必须至少设置 Allowed User IDs 或 Allowed Channel IDs,否则机器人会拒绝所有消息(默认拒绝)。
  • Feishu:App ID → 确认 → App Secret → 确认(掩码显示)→ Domain(可选)→ Allowed User IDs(可选)。收集完凭据后,说明用户必须完成的两阶段设置:
    • 阶段 1(启动桥接程序前):(A) 批量添加权限,(B) 启用机器人能力,(C) 发布首个版本并由管理员审批。这样权限和机器人才能生效。
    • 阶段 2(需要桥接程序正在运行):(D) 运行 /claude-to-im start,(E) 配置事件(im.message.receive_v1)和回调(card.action.trigger),并启用长连接模式,(F) 发布第二个版本并由管理员审批。
    • **为什么分为两个阶段:**保存事件订阅时,Feishu 会验证 WebSocket 连接;如果桥接程序未运行,保存操作会失败。桥接程序需要已发布的权限才能连接。
    • 只需提供简短清单;用户提出要求时才展示完整指南。
  • QQ:先收集两个必填字段,再收集可选字段:
    1. QQ App ID(必填)→ 确认
    2. QQ App Secret(必填)→ 确认(掩码显示)
    1. Allowed User OpenIDs(可选,按 Enter 跳过)——注意:这是 user_openid,不是 QQ 号。如果用户还没有 openid,可以留空。
    2. Image Enabled(可选,默认为 true,按 Enter 跳过)——如果底层提供方不支持图像输入,请设为 false
    3. Max Image Size MB(可选,默认为 20,按 Enter 跳过)
    • 提醒用户:QQ 首个版本仅支持 C2C 私聊沙盒接入。不支持群聊或频道、内联按钮或流式预览。
  • Weixin:不要询问静态令牌。改为:
    1. 告知用户,此渠道使用二维码登录,而非手动输入凭据。
    2. 运行 cd SKILL_DIR && npm run weixin:login
    3. 辅助程序会写入 ~/.claude-to-im/runtime/weixin-login.html,并尝试在本地浏览器中自动打开。
    4. 如果无法自动打开,告知用户手动打开该 HTML 文件,并使用 WeChat 扫描二维码。
    5. 等待辅助程序报告成功,然后确认关联账号已保存到本地。
    • 简要说明:关联的 Weixin 账号保存在 ~/.claude-to-im/data/weixin-accounts.json 中。再次运行辅助程序会替换之前关联的账号。
    • 简要说明:CTI_WEIXIN_MEDIA_ENABLED 仅控制是否下载入站图像、文件和视频。对于语音消息,桥接程序只接受 WeChat 内置语音转文字功能返回的文本。如果 WeChat 未提供转写文本,桥接程序会回复错误,而不会下载或转写原始音频。

步骤 3 — 常规设置

询问运行时、默认工作目录、模型和模式:

  • 运行时:claude(默认)、codex、auto
    • claude — 使用 Claude Code CLI + Claude Agent SDK(需要安装 claude CLI)
    • codex — 使用 OpenAI Codex SDK(需要 codex CLI;通过 codex auth login 或 OPENAI_API_KEY 进行身份验证)
    • auto — 优先尝试 Claude;如果未找到 Claude CLI,则回退到 Codex
  • 工作目录:默认为 $CWD
  • 模型(可选):留空以使用运行时自带的默认模型。如果用户想覆盖默认值,请让他们输入模型名称。不要硬编码或推荐特定模型名称——可用模型会随时间变化。
  • 模式:code(默认)、plan、ask

步骤 4 — 写入配置并验证

  1. 显示包含所有设置的最终摘要表(密钥仅显示最后 4 个字符)
  2. 写入前请用户确认
  3. 使用 Bash 创建目录结构:mkdir -p ~/.claude-to-im/{data,logs,runtime,data/messages}
  4. 使用 Write 创建 ~/.claude-to-im/config.env,并将所有设置以 KEY=VALUE 格式写入
  5. 使用 Bash 设置权限:chmod 600 ~/.claude-to-im/config.env
  6. 验证令牌 — 阅读 SKILL_DIR/references/token-validation.md,了解各平台对应的准确命令和预期响应。这可以在用户尝试启动守护进程前,发现拼写错误和凭据错误。对于 Weixin,成功扫码登录即视为验证通过。
  7. 使用摘要表报告结果。如果任何验证失败,说明可能的问题及修复方法。
  8. 成功后,告知用户:“设置完成!运行 /claude-to-im start 即可启动桥接服务。”
start

预检查: 确认 ~/.claude-to-im/config.env 存在(见上文“配置检查”)。如果该文件不存在,守护进程会立即崩溃并留下过期的 PID 文件。

运行:bash "SKILL_DIR/scripts/daemon.sh" start

向用户显示输出。如果失败,告知用户:

  • 运行 doctor 进行诊断:/claude-to-im doctor
  • 查看最近的日志:/claude-to-im logs
stop

运行:bash "SKILL_DIR/scripts/daemon.sh" stop

status

运行:bash "SKILL_DIR/scripts/daemon.sh" status

logs

从参数中提取可选的行数 N(默认为 50)。 运行:bash "SKILL_DIR/scripts/daemon.sh" logs N

reconfigure
  1. 从 ~/.claude-to-im/config.env 读取当前配置
  2. 以清晰的表格显示当前设置,并遮盖所有密钥(仅显示最后 4 个字符)
  3. 使用 AskUserQuestion 询问用户想要更改哪些内容
  4. 收集新值时,告知用户在哪里可以找到该值;只有用户请求帮助时,才显示 SKILL_DIR/references/setup-guides.md 中的完整指南
  5. 以原子方式更新配置文件(写入临时文件,再重命名)
  6. 重新验证所有已更改的令牌
  7. 提醒用户:“运行 /claude-to-im stop,然后运行 /claude-to-im start,以应用更改。”

如果用户想在 reconfigure 期间切换 Weixin 账号,请再次运行 cd SKILL_DIR && npm run weixin:login。每次成功扫码都会替换先前关联的本地账号。

doctor

运行:bash "SKILL_DIR/scripts/doctor.sh"

显示结果,并针对任何失败项建议修复方法。常见修复方法:

  • 缺少 SDK cli.js → cd SKILL_DIR && npm install
  • dist/daemon.mjs 过期 → cd SKILL_DIR && npm run build
  • 缺少配置 → 运行 setup
  • 缺少或已过期的 Weixin 账号 → cd SKILL_DIR && npm run weixin:login
  • Weixin 语音消息提示缺少语音转文字功能 → 启用微信自身的语音转文字功能后重新发送;桥接服务不会自行转录原始语音

对于更复杂的问题(未收到消息、权限超时、内存占用高、PID 文件过期),请阅读 SKILL_DIR/references/troubleshooting.md,了解详细的诊断步骤。

Feishu 升级说明: 如果用户从此技能的旧版本升级后,Feishu 出现权限错误(例如流式卡片无法使用、输入状态指示器失败、权限按钮无响应),根本原因几乎肯定是 Feishu 后端缺少权限或回调。请用户参阅 SKILL_DIR/references/setup-guides.md 中的“从先前版本升级”一节 — 他们需要添加新的权限范围(cardkit:card:write、cardkit:card:read、im:message:update、im:message.reactions:read、im:message.reactions:write_only),添加 card.action.trigger 回调,并重新发布应用。升级需要两轮发布,因为添加回调需要建立活动的 WebSocket 连接(桥接服务必须正在运行)。

说明

  • 始终在输出中隐藏密钥(仅显示最后 4 个字符)——用户经常在错误报告中分享终端输出,因此泄露令牌会构成安全事故。
  • 启动守护进程前,始终检查是否存在 config.env——否则进程会在启动时崩溃,并留下过期的 PID 文件,阻止后续启动(需要手动清理)。
  • 守护进程作为后台 Node.js 进程运行,由平台监管程序管理(macOS 上使用 launchd,Linux 上使用 setsid,Windows 上使用 WinSW/NSSM)。
  • 配置保存在 ~/.claude-to-im/config.env 中——会在不同会话之间保留。

评论

支持 Markdown