From 1fb24ef1ee6c84e5dc9bf1dbf43ca261f54d6fc0 Mon Sep 17 00:00:00 2001 From: Claude Date: Sun, 22 Mar 2026 15:25:45 +0800 Subject: [PATCH] docs: clarify personal Weixin is beta-only in README and INSTALL State that Weixin (ilink) personal WeChat requires cc-connect@beta or prerelease binaries; stable npm/latest release does not ship it yet. --- INSTALL.md | 43 ++++++++++++++++++++++++++++++++++--------- README.md | 8 +++++--- README.zh-CN.md | 8 +++++--- 3 files changed, 44 insertions(+), 15 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index a25fb50..89710c9 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -4,13 +4,13 @@ ## What is cc-connect? -cc-connect bridges local AI coding assistants to messaging platforms (Feishu, DingTalk, Telegram, Slack, Discord, LINE, WeChat Work, QQ), enabling bidirectional chat with your local AI agent from anywhere. +cc-connect bridges local AI coding assistants to messaging platforms (Feishu, DingTalk, Telegram, Slack, Discord, LINE, WeChat Work, QQ), and — in **beta / pre-release builds only** — **personal WeChat** via the **Weixin (ilink)** platform. Stable releases focus on the first set of platforms; **personal WeChat is not part of the default stable npm binary yet.** GitHub: https://github.com/chenhg5/cc-connect **IMPORTANT: If you are an AI agent helping a user install cc-connect, use interactive tools (like AskUserQuestion) to guide them through configuration choices:** - Agent selection (Claude Code, Cursor, Gemini, etc.) -- Platform selection (Feishu, Telegram, Discord, etc.) +- Platform selection (Feishu, Telegram, Discord, etc.) — if the user wants **personal WeChat (Weixin ilink)**, they **must** install a **beta / pre-release** build (`cc-connect@beta` or a GitHub/Gitee prerelease asset), not the stable default - API keys and authentication tokens - Project paths and preferences @@ -26,16 +26,39 @@ npm install -g cc-connect After installation, the `cc-connect` binary will be available globally. -### Option B: Download binary from GitHub Releases +This installs the **latest stable** release. It does **not** include the **Weixin (personal WeChat, ilink)** platform until that feature is promoted to stable. -Go to https://github.com/chenhg5/cc-connect/releases and download the binary for your platform: +### Option A-beta: npm beta (required for personal WeChat / Weixin ilink) -- `cc-connect-linux-amd64` / `cc-connect-linux-arm64` -- `cc-connect-darwin-amd64` / `cc-connect-darwin-arm64` -- `cc-connect-windows-amd64.exe` +**Personal WeChat** support ships only in **beta and pre-release** channels for now. It is **not** a formal stable feature yet — behavior and packaging may change before a stable release. ```bash -# Example for Linux amd64: +npm install -g cc-connect@beta +``` + +Verify: + +```bash +cc-connect --version +``` + +For binaries, use a **Pre-release** from [GitHub Releases](https://github.com/chenhg5/cc-connect/releases) (tags like `v1.x.x-beta.x`) or your mirror (e.g. Gitee), not only `latest` stable. + +### Option B: Download binary from GitHub Releases + +Go to https://github.com/chenhg5/cc-connect/releases and download the binary for your platform. + +- **Stable:** use the **Latest** release assets (names may include version, e.g. `cc-connect-vX.Y.Z-linux-amd64`). +- **Personal WeChat (Weixin):** download a **Pre-release** / beta tag asset — **`latest` stable does not include Weixin** until the feature is promoted. + +Typical artifact names (check the release page for exact filenames): + +- Linux: `cc-connect--linux-amd64` (or `.tar.gz`) +- macOS: `cc-connect--darwin-amd64` / `arm64` +- Windows: `cc-connect--windows-amd64.exe` (or `.zip`) + +```bash +# Example for Linux amd64 (replace URL with the asset link from the release you chose): curl -L -o cc-connect https://github.com/chenhg5/cc-connect/releases/latest/download/cc-connect-linux-amd64 chmod +x cc-connect sudo mv cc-connect /usr/local/bin/ @@ -372,7 +395,9 @@ enable_markdown = false # true = Markdown messages (WeChat Work app only; perso **Detailed guide:** [docs/wecom.md](docs/wecom.md) -### Weixin (personal, ilink) — No public IP needed +### Weixin (personal, ilink) — Beta / pre-release only; no public IP needed + +> **Release channel:** Personal WeChat is supported only in **beta and pre-release** builds of cc-connect (`npm install -g cc-connect@beta` or prerelease binaries from GitHub/Gitee). The **stable** default release **does not** ship the `weixin` platform yet. Treat this as **not production-stable** until an announcement promotes it to stable. Personal WeChat uses Tencent’s **ilink bot HTTP API** (same family as OpenClaw `openclaw-weixin`). The recommended flow is CLI QR login, which writes `token` (and related fields) into `config.toml`. diff --git a/README.md b/README.md index c5acdbf..b71b621 100644 --- a/README.md +++ b/README.md @@ -57,7 +57,7 @@ **7 AI Agents** — Claude Code, Codex, Cursor Agent, Qoder CLI, Gemini CLI, OpenCode, iFlow CLI. Use whichever fits your workflow, or all of them at once. ### 📱 Platform Flexibility -**10 Chat Platforms** — Feishu, DingTalk, Slack, Telegram, Discord, WeChat Work, Weixin (personal ilink), LINE, QQ, QQ Bot (Official). Most need **zero public IP**. +**10 Chat Platforms** — Feishu, DingTalk, Slack, Telegram, Discord, WeChat Work, LINE, QQ, QQ Bot (Official), plus **Weixin (personal ilink)** for **personal WeChat**. *Personal WeChat is **beta / pre-release only*** — install [`cc-connect@beta`](https://www.npmjs.com/package/cc-connect?activeTab=versions) or a [GitHub pre-release](https://github.com/chenhg5/cc-connect/releases) binary; the default **stable** npm package does **not** ship the `weixin` platform yet. Most platforms need **zero public IP**. ### 🔄 Multi-Agent Orchestration **Multi-Bot Relay** — Bind multiple bots in a group chat and let them communicate with each other. Ask Claude, get insights from Gemini — all in one conversation. @@ -117,6 +117,8 @@ npm install -g cc-connect npm install -g cc-connect@beta ``` +> **Personal WeChat (Weixin ilink):** only available in **beta / pre-release** builds (`cc-connect@beta` or a prerelease asset under [Releases](https://github.com/chenhg5/cc-connect/releases)). **Stable** `npm install -g cc-connect` does **not** include this platform until it graduates from beta. + **Download binary from [GitHub Releases](https://github.com/chenhg5/cc-connect/releases):** ```bash @@ -190,7 +192,7 @@ cc-connect update --pre # Beta (includes pre-releases) | Platform | Discord | ✅ Gateway — no public IP needed | | Platform | LINE | ✅ Webhook — public URL required | | Platform | WeChat Work | ✅ WebSocket / Webhook | -| Platform | Weixin (personal, ilink) | ✅ HTTP long polling — no public IP needed | +| Platform | Weixin (personal, ilink) | 🧪 **Beta / pre-release** — HTTP long polling — no public IP needed | | Platform | QQ (NapCat/OneBot) | ✅ WebSocket — Beta | | Platform | QQ Bot (Official) | ✅ WebSocket — no public IP needed | @@ -206,7 +208,7 @@ cc-connect update --pre # Beta (includes pre-releases) | Slack | [docs/slack.md](docs/slack.md) | Socket Mode | No | | Discord | [docs/discord.md](docs/discord.md) | Gateway | No | | WeChat Work | [docs/wecom.md](docs/wecom.md) | WebSocket / Webhook | No (WS) / Yes (Webhook) | -| Weixin (personal) | [docs/weixin.md](docs/weixin.md) | HTTP long polling (ilink) | No | +| Weixin (personal) | [docs/weixin.md](docs/weixin.md) | HTTP long polling (ilink) — **beta only** | No | | QQ / QQ Bot | [docs/qq.md](docs/qq.md) | WebSocket | No | --- diff --git a/README.zh-CN.md b/README.zh-CN.md index 34b4945..9627bae 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -57,7 +57,7 @@ **7 大 AI Agent** — Claude Code、Codex、Cursor Agent、Qoder CLI、Gemini CLI、OpenCode、iFlow CLI。按需选用，或同时使用全部。 ### 📱 平台灵活性 -**10 大聊天平台** — 飞书、钉钉、Slack、Telegram、Discord、企业微信、微信个人号（ilink）、LINE、QQ、QQ 官方机器人。大部分**无需公网 IP**。 +**10 大聊天平台** — 飞书、钉钉、Slack、Telegram、Discord、企业微信、LINE、QQ、QQ 官方机器人，以及 **微信个人号（ilink）**。其中 **个人微信目前仅在 Beta / 预发布版本中提供**，需安装 `npm install -g cc-connect@beta` 或从 [GitHub Releases 预发布](https://github.com/chenhg5/cc-connect/releases) 下载带 beta 标签的包；**稳定版** npm 包**尚未**内置 `weixin` 平台。大部分平台**无需公网 IP**。 ### 🔄 多 Agent 编排 **多机器人中继** — 在群聊中绑定多个机器人，让它们相互协作。问 Claude，再听 Gemini 的见解 — 同一个对话搞定。 @@ -117,6 +117,8 @@ npm install -g cc-connect npm install -g cc-connect@beta ``` +> **微信个人号（Weixin ilink）：** 仅在 **Beta / 预发布** 中提供（`cc-connect@beta` 或 Releases 里带 `beta` / `prerelease` 的资源）。**稳定版** `npm install -g cc-connect` **暂时不包含**该通道，正式版上线前请以 Beta 说明为准。 + **从 [GitHub Releases](https://github.com/chenhg5/cc-connect/releases) 下载：** ```bash @@ -190,7 +192,7 @@ cc-connect update --pre # Beta 版（含 pre-release） | Platform | Discord | ✅ Gateway — 无需公网 IP | | Platform | LINE | ✅ Webhook — 需要公网 URL | | Platform | 企业微信 | ✅ WebSocket / Webhook | -| Platform | 微信个人号（ilink） | ✅ HTTP 长轮询 — 无需公网 IP | +| Platform | 微信个人号（ilink） | 🧪 **Beta / 预发布** — HTTP 长轮询 — 无需公网 IP | | Platform | QQ (NapCat/OneBot) | ✅ WebSocket — Beta | | Platform | QQ 官方机器人 | ✅ WebSocket — 无需公网 IP | @@ -206,7 +208,7 @@ cc-connect update --pre # Beta 版（含 pre-release） | Slack | [docs/slack.md](docs/slack.md) | Socket Mode | 不需要 | | Discord | [docs/discord.md](docs/discord.md) | Gateway | 不需要 | | 企业微信 | [docs/wecom.md](docs/wecom.md) | WebSocket / Webhook | 不需要 (WS) / 需要 (Webhook) | -| 微信个人号（ilink） | [docs/weixin.md](docs/weixin.md) | HTTP 长轮询（ilink） | 不需要 | +| 微信个人号（ilink） | [docs/weixin.md](docs/weixin.md) | HTTP 长轮询（ilink），**仅 Beta** | 不需要 | | QQ / QQ 机器人 | [docs/qq.md](docs/qq.md) | WebSocket | 不需要 | ---