docs(readme): add Prerequisites section with agent-CLI-first install order (#1464) (#1466)

New users installing cc-connect were hitting a fail-fast path
("claudecode: claude CLI not found in PATH", Web UI on :9820 never
comes up) because the README jumped straight to installing
cc-connect itself with no guidance on installing the agent CLI first
and authenticating it. Issue #1464 (NirvanaCh7, fresh macOS Homebrew
install) hit this; historical #1122 and #1139 were related but
closed COMPLETED without addressing the README.

Add a top-level "Prerequisites" section (zh-CN: "准备工作") to both
README.md and README.zh-CN.md, placed immediately before "Quick
Start". The section walks through the install order:

1. Install the agent CLI (Claude Code / Codex / Gemini / iFlow /
   Qoder / Cursor Agent / OpenCode) — pick one, verify it's on PATH
2. Authenticate the agent (e.g. `claude login`) — stores creds in
   home dir
3. Install cc-connect (npm / Homebrew / binary)
4. Start cc-connect and open Web UI on http://localhost:9820
5. Configure platform bot tokens in the Web UI

The section explicitly warns about the failure mode so users
recognize it before they hit it. cc-connect startup logic is
unchanged — the fail-fast behavior is intentional and well-tested.

Co-authored-by: dev-claudecode <dev-claudecode@cc-connect.local>
Co-authored-by: Claude Opus 4.7 <noreply@anthropic.com>
This commit is contained in:
authored and GitHub committed 2026-08-13 16:46:43 +08:00
1 parent 2ca3218660
commit 91a4d74e7a
2 files changed
+170

No files matched your search

+85
View File
@@ -276,6 +276,91 @@ High-level view of what each **built-in platform** can do in cc-connect.
</p>
## 📋 Prerequisites
> **Install in this exact order** — cc-connect is a bridge for local AI coding agents, so the agent CLI must be installed and authenticated *before* cc-connect starts. Skipping ahead will cause `cc-connect` to exit with `claudecode: claude CLI not found in PATH` (or similar for your chosen agent), and the Web UI on `:9820` will never come up.
### 1️⃣ Install your AI Agent CLI
Pick the agent you want to bridge. You need **at least one**.
```bash
# Claude Code (most common)
brew install --cask claude-code # macOS / Linux Homebrew
# or
npm install -g @anthropic-ai/claude-code # any platform via npm
# OpenAI Codex
npm install -g @openai/codex
# Google Gemini CLI
npm install -g @google/gemini-cli
# iFlow CLI
npm install -g @iflow-ai/iflow-cli
# Qoder CLI
curl -fsSL https://qoder.com/install | bash
```
For **Cursor Agent** and **OpenCode**, follow the official install pages:
- Cursor Agent: <https://docs.cursor.com/agent>
- OpenCode: <https://github.com/opencode-ai/opencode>
Verify the binary is on your `PATH`:
```bash
claude --version # or: codex / gemini / opencode / qodercli / cursor-agent ...
```
### 2️⃣ Authenticate the agent
Each agent has its own login flow — run the agent once interactively so it stores credentials in your home directory:
```bash
claude login # opens a browser to authenticate
# or
codex login # /gemini / opencode auth — see the agent's docs
```
If you skip this step, `cc-connect` will still start, but the agent will reject every prompt with an auth error.
### 3️⃣ Install cc-connect
```bash
# npm (any platform)
npm install -g cc-connect
# Homebrew (macOS / Linux)
brew install cc-connect
# Or download a binary from https://github.com/chenhg5/cc-connect/releases
```
### 4️⃣ Start cc-connect and open the Web UI
```bash
cc-connect # starts the service; first run auto-creates ~/.cc-connect/config.toml
```
On first launch, cc-connect prints something like:
```
Web admin: http://localhost:9820
```
Open that URL in your browser. If `9820` is already in use, pass `--web-port 9821` or set `web_port` in `config.toml`.
> **Note:** `cc-connect web` *only* opens the browser and the config UI — it does **not** start the service. You still need `cc-connect` running in another terminal.
### 5️⃣ Configure platform bot tokens in the Web UI
In the Web UI, create a project, then add at least one platform (Feishu / Telegram / Discord / Slack / DingTalk / WeChat Work / QQ / LINE / Weixin) and paste the bot token from that platform's developer console. Save and cc-connect will hot-reload.
That's it — send a message to your bot and cc-connect will relay it to your local agent.
---
## 🚀 Quick Start
### 🤖 Install & Configure via AI Agent (Recommended)
+85
View File
@@ -275,6 +275,91 @@
</p>
## 📋 准备工作
> **请严格按照以下顺序安装** — cc-connect 是本地 AI 编程 Agent 的桥接工具,因此对应的 Agent CLI 必须先安装并完成登录认证,之后 cc-connect 才能正常启动。如果跳过前面的步骤直接启动 cc-connect,进程会直接退出并报错 `claudecode: claude CLI not found in PATH`(其他 Agent 报错类似),Web UI 在 `:9820` 也就无从访问。
### 1️⃣ 安装 AI Agent CLI
选择你要桥接的 Agent,至少装一个。
```bash
# Claude Code(最常用)
brew install --cask claude-code # macOS / Linux Homebrew
# 或
npm install -g @anthropic-ai/claude-code # 任意平台通过 npm
# OpenAI Codex
npm install -g @openai/codex
# Google Gemini CLI
npm install -g @google/gemini-cli
# iFlow CLI
npm install -g @iflow-ai/iflow-cli
# Qoder CLI
curl -fsSL https://qoder.com/install | bash
```
**Cursor Agent** 和 **OpenCode** 请参考各自的官方安装文档:
- Cursor Agent: <https://docs.cursor.com/agent>
- OpenCode: <https://github.com/opencode-ai/opencode>
确认可执行文件在 `PATH` 中:
```bash
claude --version # 或 codex / gemini / opencode / qodercli / cursor-agent ...
```
### 2️⃣ 完成 Agent 登录认证
每个 Agent 都有自己的登录流程 — 先在终端交互式跑一次,让它把凭据存到你的 home 目录:
```bash
claude login # 会在浏览器里打开授权页面
# 或
codex login # / gemini / opencode 等也类似,请参考各自文档
```
跳过这一步的话,cc-connect 仍能启动,但 Agent 会因为未认证拒绝所有请求。
### 3️⃣ 安装 cc-connect
```bash
# npm(任意平台)
npm install -g cc-connect
# Homebrew(macOS / Linux)
brew install cc-connect
# 也可以从 https://github.com/chenhg5/cc-connect/releases 直接下载二进制
```
### 4️⃣ 启动 cc-connect 并打开 Web UI
```bash
cc-connect # 启动服务;首次运行会自动生成 ~/.cc-connect/config.toml
```
首次启动时,cc-connect 会打印类似:
```
Web admin: http://localhost:9820
```
在浏览器里打开该地址。如果 `9820` 已被占用,可以传 `--web-port 9821` 或在 `config.toml` 里设置 `web_port`。
> **注意:** `cc-connect web` *只* 打开浏览器和配置界面,并**不会**启动服务本身。仍需要在另一个终端里跑 `cc-connect`。
### 5️⃣ 在 Web UI 里配置平台 Bot Token
在 Web UI 里新建一个项目,然后添加至少一个平台(飞书 / Telegram / Discord / Slack / 钉钉 / 企业微信 / QQ / LINE / 微信 ilink),把该平台开发者后台的 Bot Token 粘贴进去。保存后 cc-connect 会热加载。
至此完成 — 给你的 Bot 发条消息,cc-connect 就会把它转给本地的 Agent。
---
## 🚀 快速开始
### 🤖 通过 AI Agent 安装配置(推荐)