mirror of
https://github.com/chenhg5/cc-connect.git
synced 2026-10-25 17:36:43 +08:00
feat(docs): enhance gitignore and revamp README with new banner and structure
generated by llmgit Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
1 parent
bd5ce073c8
commit
b91bb8388d
4 files changed
+533
-151
No files matched your search
+117
-7
@@ -1,14 +1,124 @@
|
||||
# ============================================================================
|
||||
# Binary outputs
|
||||
# ============================================================================
|
||||
/cc-connect
|
||||
config.toml
|
||||
.cc-connect/
|
||||
*.exe
|
||||
*.exe~
|
||||
*.dll
|
||||
*.so
|
||||
*.dylib
|
||||
*.test
|
||||
*.out
|
||||
|
||||
# ============================================================================
|
||||
# Go workspace & tooling
|
||||
# ============================================================================
|
||||
# Test binary, built with `go test -c`
|
||||
*.test
|
||||
|
||||
# Output of the go coverage tool
|
||||
coverage.html
|
||||
coverage.txt
|
||||
*.out
|
||||
|
||||
# Go workspace files (go.work)
|
||||
go.work
|
||||
go.work.sum
|
||||
|
||||
# Go module environment (local proxy settings)
|
||||
go.env
|
||||
|
||||
# Dependency directories
|
||||
vendor/
|
||||
|
||||
# ============================================================================
|
||||
# Project-specific
|
||||
# ============================================================================
|
||||
# Runtime configuration (contains secrets)
|
||||
config.toml
|
||||
.env
|
||||
.DS_Store
|
||||
dist
|
||||
test
|
||||
RELEASE.md
|
||||
*.local.toml
|
||||
|
||||
# CC-Connect runtime state
|
||||
.cc-connect/
|
||||
|
||||
# npm (for npm package distribution)
|
||||
.npmrc
|
||||
scripts
|
||||
package-lock.json
|
||||
|
||||
# ============================================================================
|
||||
# Build & distribution
|
||||
# ============================================================================
|
||||
dist/
|
||||
build/
|
||||
bin/
|
||||
release/
|
||||
|
||||
# ============================================================================
|
||||
# Testing & temporary files
|
||||
# ============================================================================
|
||||
test/
|
||||
scripts/
|
||||
tmp/
|
||||
temp/
|
||||
*.tmp
|
||||
*.swp
|
||||
*.swo
|
||||
*~
|
||||
*.pid
|
||||
*.log
|
||||
|
||||
# ============================================================================
|
||||
# IDE & Editor
|
||||
# ============================================================================
|
||||
.vscode/
|
||||
.idea/
|
||||
*.iml
|
||||
*.ipr
|
||||
*.iws
|
||||
.vs/
|
||||
*.suo
|
||||
*.user
|
||||
*.userosscache
|
||||
*.sln.docstates
|
||||
|
||||
# Emacs
|
||||
*~
|
||||
\#*\#
|
||||
.\#*
|
||||
|
||||
# Vim
|
||||
*.swp
|
||||
*.swo
|
||||
*.swn
|
||||
|
||||
# macOS
|
||||
.DS_Store
|
||||
.AppleDouble
|
||||
.LSOverride
|
||||
|
||||
# ============================================================================
|
||||
# Documentation (drafts)
|
||||
# ============================================================================
|
||||
RELEASE.md
|
||||
DRAFTS.md
|
||||
NOTES.md
|
||||
|
||||
# ============================================================================
|
||||
# System
|
||||
# ============================================================================
|
||||
# Thumbs.db on Windows
|
||||
Thumbs.db
|
||||
ehthumbs.db
|
||||
Desktop.ini
|
||||
|
||||
# ============================================================================
|
||||
# Security
|
||||
# ============================================================================
|
||||
# Never commit secrets or credentials
|
||||
*.key
|
||||
*.pem
|
||||
*.p12
|
||||
*.pfx
|
||||
secrets/
|
||||
credentials/
|
||||
@@ -1,45 +1,134 @@
|
||||
# cc-connect
|
||||
<p align="center">
|
||||
<img src="./docs/images/banner.svg" alt="CC-Connect Banner" width="800"/>
|
||||
</p>
|
||||
|
||||
[](https://github.com/chenhg5/cc-connect/actions/workflows/ci.yml)
|
||||
[](https://github.com/chenhg5/cc-connect/releases)
|
||||
[](https://discord.gg/kHpwgaM4kq)
|
||||
[](https://t.me/+odGNDhCjbjdmMmZl)
|
||||
[](https://opensource.org/licenses/MIT)
|
||||
<p align="center">
|
||||
<a href="https://github.com/chenhg5/cc-connect/actions/workflows/ci.yml">
|
||||
<img src="https://github.com/chenhg5/cc-connect/actions/workflows/ci.yml/badge.svg" alt="CI Status"/>
|
||||
</a>
|
||||
<a href="https://github.com/chenhg5/cc-connect/releases">
|
||||
<img src="https://img.shields.io/github/v/release/chenhg5/cc-connect?include_prereleases" alt="Release"/>
|
||||
</a>
|
||||
<a href="https://www.npmjs.com/package/cc-connect">
|
||||
<img src="https://img.shields.io/npm/dm/cc-connect?logo=npm" alt="npm downloads"/>
|
||||
</a>
|
||||
<a href="https://github.com/chenhg5/cc-connect/blob/main/LICENSE">
|
||||
<img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License"/>
|
||||
</a>
|
||||
<a href="https://goreportcard.com/report/github.com/chenhg5/cc-connect">
|
||||
<img src="https://goreportcard.com/badge/github.com/chenhg5/cc-connect" alt="Go Report Card"/>
|
||||
</a>
|
||||
</p>
|
||||
|
||||
English | [中文](./README.zh-CN.md)
|
||||
<p align="center">
|
||||
<a href="https://discord.gg/kHpwgaM4kq">
|
||||
<img src="https://img.shields.io/badge/Discord-Join-5865F2?logo=discord&logoColor=white" alt="Discord"/>
|
||||
</a>
|
||||
<a href="https://t.me/+odGNDhCjbjdmMmZl">
|
||||
<img src="https://img.shields.io/badge/Telegram-Group-26A5E4?logo=telegram&logoColor=white" alt="Telegram"/>
|
||||
</a>
|
||||
</p>
|
||||
|
||||
**Control your local AI agents from any chat app. Anywhere, anytime.**
|
||||
<p align="center">
|
||||
<a href="./README.md">English</a> | <a href="./README.zh-CN.md">中文</a>
|
||||
</p>
|
||||
|
||||
cc-connect bridges AI agents running on your machine to the messaging platforms you already use. Code review, research, automation, data analysis — anything an AI agent can do, now accessible from your phone, tablet, or any device with a chat app.
|
||||
---
|
||||
|
||||
```
|
||||
You (Phone / Laptop / Tablet)
|
||||
│
|
||||
┌───────────────┼───────────────┐
|
||||
▼ ▼ ▼
|
||||
Feishu Slack Telegram ...9 platforms
|
||||
│ │ │
|
||||
└───────────────┼───────────────┘
|
||||
▼
|
||||
┌────────────┐
|
||||
│ cc-connect │ ← your dev machine
|
||||
└────────────┘
|
||||
┌─────┼─────┐
|
||||
▼ ▼ ▼
|
||||
Claude Gemini Codex ...7 agents
|
||||
Code CLI OpenCode / iFlow
|
||||
<p align="center">
|
||||
<b>Control your local AI agents from any chat app. Anywhere, anytime.</b>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
cc-connect bridges AI agents running on your machine to the messaging platforms you already use.<br/>
|
||||
Code review, research, automation, data analysis — anything an AI agent can do,<br/>
|
||||
now accessible from your phone, tablet, or any device with a chat app.
|
||||
</p>
|
||||
|
||||
```mermaid
|
||||
graph TD
|
||||
User[👤 You - Phone / Laptop / Tablet]
|
||||
|
||||
subgraph Platforms["📱 Chat Platforms - 9 Supported"]
|
||||
Feishu["Feishu/Lark"]
|
||||
Slack["Slack"]
|
||||
Telegram["Telegram"]
|
||||
Discord["Discord"]
|
||||
DingTalk["DingTalk"]
|
||||
WeCom["WeChat Work"]
|
||||
LINE["LINE"]
|
||||
QQ["QQ"]
|
||||
end
|
||||
|
||||
CC[cc-connect<br/>Your Dev Machine]
|
||||
|
||||
subgraph Agents["🤖 AI Agents - 7 Supported"]
|
||||
Claude["Claude Code"]
|
||||
Gemini["Gemini CLI"]
|
||||
Codex["Codex"]
|
||||
Cursor["Cursor"]
|
||||
Qoder["Qoder"]
|
||||
OpenCode["OpenCode"]
|
||||
iFlow["iFlow CLI"]
|
||||
end
|
||||
|
||||
User --> Feishu
|
||||
User --> Slack
|
||||
User --> Telegram
|
||||
User --> Discord
|
||||
User --> DingTalk
|
||||
User --> WeCom
|
||||
|
||||
Feishu --> CC
|
||||
Slack --> CC
|
||||
Telegram --> CC
|
||||
Discord --> CC
|
||||
DingTalk --> CC
|
||||
WeCom --> CC
|
||||
|
||||
CC --> Claude
|
||||
CC --> Gemini
|
||||
CC --> Codex
|
||||
CC --> Cursor
|
||||
CC --> Qoder
|
||||
|
||||
style CC fill:#0ea5e9,stroke:#0284c7,color:#fff
|
||||
style Platforms fill:#1e293b,stroke:#334155,color:#94a3b8
|
||||
style Agents fill:#1e293b,stroke:#334155,color:#94a3b8
|
||||
```
|
||||
|
||||
### Why cc-connect?
|
||||
---
|
||||
|
||||
- **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.
|
||||
- **9 Chat Platforms** — Feishu, DingTalk, Slack, Telegram, Discord, WeChat Work, LINE, QQ, QQ Bot (Official). Most need zero public IP.
|
||||
- **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.
|
||||
- **Full Control from Chat** — Switch models (`/model`), tune reasoning (`/reasoning`), change permission modes (`/mode`), manage sessions, all via slash commands.
|
||||
- **Agent Memory** — Read and write agent instruction files (`/memory`) without touching the terminal.
|
||||
- **Scheduled Tasks** — Set up cron jobs in natural language. "Every day at 6am, summarize GitHub trending" just works.
|
||||
- **Voice & Images** — Send voice messages or screenshots; cc-connect handles STT/TTS and multimodal forwarding.
|
||||
- **Multi-Project** — One process, multiple projects, each with its own agent + platform combo.
|
||||
## ✨ Why cc-connect?
|
||||
|
||||
### 🤖 Universal Agent Support
|
||||
**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
|
||||
**9 Chat Platforms** — Feishu, DingTalk, Slack, Telegram, Discord, WeChat Work, LINE, QQ, QQ Bot (Official). Most 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.
|
||||
|
||||
### 🎮 Complete Chat Control
|
||||
**Full Control from Chat** — Switch models (`/model`), tune reasoning (`/reasoning`), change permission modes (`/mode`), manage sessions, all via slash commands.
|
||||
|
||||
### 🧠 Persistent Memory
|
||||
**Agent Memory** — Read and write agent instruction files (`/memory`) without touching the terminal.
|
||||
|
||||
### ⏰ Intelligent Scheduling
|
||||
**Scheduled Tasks** — Set up cron jobs in natural language. *"Every day at 6am, summarize GitHub trending"* just works.
|
||||
|
||||
### 🎤 Multimodal Support
|
||||
**Voice & Images** — Send voice messages or screenshots; cc-connect handles STT/TTS and multimodal forwarding.
|
||||
|
||||
### 📦 Multi-Project Architecture
|
||||
**Multi-Project** — One process, multiple projects, each with its own agent + platform combo.
|
||||
|
||||
### 🌍 Multilingual Interface
|
||||
**5 Languages** — Native support for English, Chinese (Simplified & Traditional), Japanese, and Spanish. Built-in i18n ensures everyone feels at home.
|
||||
|
||||
---
|
||||
|
||||
<p align="center">
|
||||
<img src="docs/images/screenshot/cc-connect-lark.JPG" alt="飞书" width="32%" />
|
||||
@@ -50,17 +139,29 @@ cc-connect bridges AI agents running on your machine to the messaging platforms
|
||||
<em>Left:Lark | Telegram | Right:Wechat</em>
|
||||
</p>
|
||||
|
||||
## Quick Start
|
||||
---
|
||||
|
||||
### Install & Configure via AI Agent (Recommended)
|
||||
## 🚀 Quick Start
|
||||
|
||||
Send this to Claude Code or any AI coding agent, and it will handle the entire installation and configuration for you:
|
||||
### 🤖 Install & Configure via AI Agent (Recommended)
|
||||
|
||||
```
|
||||
Please refer to https://raw.githubusercontent.com/chenhg5/cc-connect/refs/heads/main/INSTALL.md to help me install and configure cc-connect
|
||||
> **The easiest way** — Send this to Claude Code or any AI coding agent, and it will handle the entire installation and configuration for you:
|
||||
|
||||
```bash
|
||||
Follow https://raw.githubusercontent.com/chenhg5/cc-connect/refs/heads/main/INSTALL.md to install and configure cc-connect.
|
||||
|
||||
IMPORTANT: Use interactive tools (like AskUserQuestion) to guide me through configuration choices:
|
||||
- Agent selection (Claude Code, Cursor, Gemini, etc.)
|
||||
- Platform selection (Feishu, Telegram, Discord, etc.)
|
||||
- API keys and authentication tokens
|
||||
- Project paths and preferences
|
||||
|
||||
Don't guess values—always ask me to choose via interactive prompts.
|
||||
```
|
||||
|
||||
### Manual Install
|
||||
---
|
||||
|
||||
### 📦 Manual Install
|
||||
|
||||
**Via npm:**
|
||||
|
||||
@@ -92,7 +193,9 @@ cd cc-connect
|
||||
make build
|
||||
```
|
||||
|
||||
### Configure
|
||||
---
|
||||
|
||||
### ⚙️ Configure
|
||||
|
||||
```bash
|
||||
mkdir -p ~/.cc-connect
|
||||
@@ -100,13 +203,17 @@ cp config.example.toml ~/.cc-connect/config.toml
|
||||
vim ~/.cc-connect/config.toml
|
||||
```
|
||||
|
||||
### Run
|
||||
---
|
||||
|
||||
### ▶️ Run
|
||||
|
||||
```bash
|
||||
./cc-connect
|
||||
```
|
||||
|
||||
### Upgrade
|
||||
---
|
||||
|
||||
### 🔄 Upgrade
|
||||
|
||||
```bash
|
||||
# npm
|
||||
@@ -117,7 +224,9 @@ cc-connect update # Stable
|
||||
cc-connect update --pre # Beta (includes pre-releases)
|
||||
```
|
||||
|
||||
## Support Matrix
|
||||
---
|
||||
|
||||
## 📊 Support Matrix
|
||||
|
||||
| Component | Type | Status |
|
||||
|-----------|------|--------|
|
||||
@@ -140,7 +249,9 @@ cc-connect update --pre # Beta (includes pre-releases)
|
||||
| Platform | QQ (NapCat/OneBot) | ✅ WebSocket — Beta |
|
||||
| Platform | QQ Bot (Official) | ✅ WebSocket — no public IP needed |
|
||||
|
||||
## Platform Setup Guides
|
||||
---
|
||||
|
||||
## 📖 Platform Setup Guides
|
||||
|
||||
| Platform | Guide | Connection | Public IP? |
|
||||
|----------|-------|------------|------------|
|
||||
@@ -152,9 +263,11 @@ cc-connect update --pre # Beta (includes pre-releases)
|
||||
| WeChat Work | [docs/wecom.md](docs/wecom.md) | WebSocket / Webhook | No (WS) / Yes (Webhook) |
|
||||
| QQ / QQ Bot | [docs/qq.md](docs/qq.md) | WebSocket | No |
|
||||
|
||||
## Key Features
|
||||
---
|
||||
|
||||
### Session Management
|
||||
## 🎯 Key Features
|
||||
|
||||
### 💬 Session Management
|
||||
|
||||
```
|
||||
/new [name] Start a new session
|
||||
@@ -163,7 +276,9 @@ cc-connect update --pre # Beta (includes pre-releases)
|
||||
/current Show current session
|
||||
```
|
||||
|
||||
### Permission Modes
|
||||
---
|
||||
|
||||
### 🔐 Permission Modes
|
||||
|
||||
```
|
||||
/mode Show available modes
|
||||
@@ -171,39 +286,51 @@ cc-connect update --pre # Beta (includes pre-releases)
|
||||
/mode default # Ask for each tool
|
||||
```
|
||||
|
||||
### Provider Management
|
||||
---
|
||||
|
||||
### 🔄 Provider Management
|
||||
|
||||
```
|
||||
/provider list List providers
|
||||
/provider switch <name> Switch API provider at runtime
|
||||
```
|
||||
|
||||
### Scheduled Tasks
|
||||
---
|
||||
|
||||
```
|
||||
### ⏰ Scheduled Tasks
|
||||
|
||||
```bash
|
||||
/cron add 0 6 * * * Summarize GitHub trending
|
||||
```
|
||||
|
||||
📖 **Full documentation:** [docs/usage.md](docs/usage.md)
|
||||
|
||||
## Documentation
|
||||
---
|
||||
|
||||
## 📚 Documentation
|
||||
|
||||
- [Usage Guide](docs/usage.md) — Complete feature documentation
|
||||
- [INSTALL.md](INSTALL.md) — AI-agent-friendly installation guide
|
||||
- [config.example.toml](config.example.toml) — Configuration template
|
||||
|
||||
## Community
|
||||
---
|
||||
|
||||
## 👥 Community
|
||||
|
||||
- [Discord](https://discord.gg/kHpwgaM4kq)
|
||||
- [Telegram](https://t.me/+odGNDhCjbjdmMmZl)
|
||||
|
||||
## Contributors
|
||||
---
|
||||
|
||||
## 🙏 Contributors
|
||||
|
||||
<a href="https://github.com/chenhg5/cc-connect/graphs/contributors">
|
||||
<img src="https://contrib.rocks/image?repo=chenhg5/cc-connect" />
|
||||
<img src="https://contrib.rocks/image?repo=chenhg5/cc-connect&v=20250313" />
|
||||
</a>
|
||||
|
||||
## Star History
|
||||
---
|
||||
|
||||
## ⭐ Star History
|
||||
|
||||
<a href="https://www.star-history.com/#chenhg5/cc-connect&Date">
|
||||
<picture>
|
||||
@@ -213,6 +340,14 @@ cc-connect update --pre # Beta (includes pre-releases)
|
||||
</picture>
|
||||
</a>
|
||||
|
||||
## License
|
||||
---
|
||||
|
||||
MIT
|
||||
## 📄 License
|
||||
|
||||
MIT License
|
||||
|
||||
---
|
||||
|
||||
<p align="center">
|
||||
<sub>Built with ❤️ by the cc-connect community</sub>
|
||||
</p>
|
||||
+199
-86
@@ -1,45 +1,134 @@
|
||||
# cc-connect
|
||||
<p align="center">
|
||||
<img src="./docs/images/banner.svg" alt="CC-Connect Banner" width="800"/>
|
||||
</p>
|
||||
|
||||
[](https://github.com/chenhg5/cc-connect/actions/workflows/ci.yml)
|
||||
[](https://github.com/chenhg5/cc-connect/releases)
|
||||
[](https://discord.gg/kHpwgaM4kq)
|
||||
[](https://t.me/+odGNDhCjbjdmMmZl)
|
||||
[](https://opensource.org/licenses/MIT)
|
||||
<p align="center">
|
||||
<a href="https://github.com/chenhg5/cc-connect/actions/workflows/ci.yml">
|
||||
<img src="https://github.com/chenhg5/cc-connect/actions/workflows/ci.yml/badge.svg" alt="CI Status"/>
|
||||
</a>
|
||||
<a href="https://github.com/chenhg5/cc-connect/releases">
|
||||
<img src="https://img.shields.io/github/v/release/chenhg5/cc-connect?include_prereleases" alt="Release"/>
|
||||
</a>
|
||||
<a href="https://www.npmjs.com/package/cc-connect">
|
||||
<img src="https://img.shields.io/npm/dm/cc-connect?logo=npm" alt="npm downloads"/>
|
||||
</a>
|
||||
<a href="https://github.com/chenhg5/cc-connect/blob/main/LICENSE">
|
||||
<img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License"/>
|
||||
</a>
|
||||
<a href="https://goreportcard.com/report/github.com/chenhg5/cc-connect">
|
||||
<img src="https://goreportcard.com/badge/github.com/chenhg5/cc-connect" alt="Go Report Card"/>
|
||||
</a>
|
||||
</p>
|
||||
|
||||
[English](./README.md) | 中文
|
||||
<p align="center">
|
||||
<a href="https://discord.gg/kHpwgaM4kq">
|
||||
<img src="https://img.shields.io/badge/Discord-Join-5865F2?logo=discord&logoColor=white" alt="Discord"/>
|
||||
</a>
|
||||
<a href="https://t.me/+odGNDhCjbjdmMmZl">
|
||||
<img src="https://img.shields.io/badge/Telegram-Group-26A5E4?logo=telegram&logoColor=white" alt="Telegram"/>
|
||||
</a>
|
||||
</p>
|
||||
|
||||
**在任何聊天工具里,远程操控你的本地 AI Agent**
|
||||
<p align="center">
|
||||
<a href="./README.md">English</a> | <a href="./README.zh-CN.md">中文</a>
|
||||
</p>
|
||||
|
||||
cc-connect 把运行在你机器上的 AI Agent 桥接到你日常使用的即时通讯工具。代码审查、资料研究、自动化任务、数据分析 —— 只要 AI Agent 能做的事,都能通过手机、平板或任何有聊天应用的设备来完成。
|
||||
---
|
||||
|
||||
```
|
||||
你(手机 / 电脑 / 平板)
|
||||
│
|
||||
┌───────────────┼───────────────┐
|
||||
▼ ▼ ▼
|
||||
飞书 Slack Telegram ...9 个平台
|
||||
│ │ │
|
||||
└───────────────┼───────────────┘
|
||||
▼
|
||||
┌────────────┐
|
||||
│ cc-connect │ ← 你的开发机
|
||||
└────────────┘
|
||||
┌─────┼─────┐
|
||||
▼ ▼ ▼
|
||||
Claude Gemini Codex ...7 个 Agent
|
||||
Code CLI OpenCode / iFlow
|
||||
<p align="center">
|
||||
<b>在任何聊天工具里,远程操控你的本地 AI Agent。随时随地,随心所欲。</b>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
cc-connect 把运行在你机器上的 AI Agent 桥接到你日常使用的即时通讯工具。<br/>
|
||||
代码审查、资料研究、自动化任务、数据分析 —— 只要 AI Agent 能做的事,<br/>
|
||||
都能通过手机、平板或任何有聊天应用的设备来完成。
|
||||
</p>
|
||||
|
||||
```mermaid
|
||||
graph TD
|
||||
User[👤 你 - 手机 / 电脑 / 平板]
|
||||
|
||||
subgraph Platforms["📱 聊天平台 - 支持 9 个"]
|
||||
Feishu["飞书/Lark"]
|
||||
Slack["Slack"]
|
||||
Telegram["Telegram"]
|
||||
Discord["Discord"]
|
||||
DingTalk["钉钉"]
|
||||
WeCom["企业微信"]
|
||||
LINE["LINE"]
|
||||
QQ["QQ"]
|
||||
end
|
||||
|
||||
CC[cc-connect<br/>你的开发机]
|
||||
|
||||
subgraph Agents["🤖 AI Agent - 支持 7 个"]
|
||||
Claude["Claude Code"]
|
||||
Gemini["Gemini CLI"]
|
||||
Codex["Codex"]
|
||||
Cursor["Cursor"]
|
||||
Qoder["Qoder"]
|
||||
OpenCode["OpenCode"]
|
||||
iFlow["iFlow CLI"]
|
||||
end
|
||||
|
||||
User --> Feishu
|
||||
User --> Slack
|
||||
User --> Telegram
|
||||
User --> Discord
|
||||
User --> DingTalk
|
||||
User --> WeCom
|
||||
|
||||
Feishu --> CC
|
||||
Slack --> CC
|
||||
Telegram --> CC
|
||||
Discord --> CC
|
||||
DingTalk --> CC
|
||||
WeCom --> CC
|
||||
|
||||
CC --> Claude
|
||||
CC --> Gemini
|
||||
CC --> Codex
|
||||
CC --> Cursor
|
||||
CC --> Qoder
|
||||
|
||||
style CC fill:#0ea5e9,stroke:#0284c7,color:#fff
|
||||
style Platforms fill:#1e293b,stroke:#334155,color:#94a3b8
|
||||
style Agents fill:#1e293b,stroke:#334155,color:#94a3b8
|
||||
```
|
||||
|
||||
### 核心亮点
|
||||
---
|
||||
|
||||
- **7 大 AI Agent** — Claude Code、Codex、Cursor Agent、Qoder CLI、Gemini CLI、OpenCode、iFlow CLI,按需选用,也可以同时使用
|
||||
- **9 大聊天平台** — 飞书、钉钉、Slack、Telegram、Discord、企业微信、LINE、QQ、QQ 官方机器人,大部分无需公网 IP
|
||||
- **多机器人中继** — 在群聊中绑定多个机器人,让它们相互协作。问 Claude,再听 Gemini 的见解 — 同一个对话搞定
|
||||
- **聊天即控制** — 切换模型 `/model`、切换推理强度 `/reasoning`、切换权限 `/mode`、管理会话,全部通过斜杠命令完成
|
||||
- **Agent 记忆** — 在聊天中直接读写 Agent 指令文件 `/memory`,无需回到终端
|
||||
- **定时任务** — 自然语言创建 cron 任务,"每天早上6点帮我总结 GitHub trending" 即刻生效
|
||||
- **语音 & 图片** — 发语音或截图,cc-connect 自动转文字和多模态转发
|
||||
- **多项目管理** — 一个进程同时管理多个项目,各自独立的 Agent + 平台组合
|
||||
## ✨ 为什么选择 cc-connect?
|
||||
|
||||
### 🤖 通用 Agent 支持
|
||||
**7 大 AI Agent** — Claude Code、Codex、Cursor Agent、Qoder CLI、Gemini CLI、OpenCode、iFlow CLI。按需选用,或同时使用全部。
|
||||
|
||||
### 📱 平台灵活性
|
||||
**9 大聊天平台** — 飞书、钉钉、Slack、Telegram、Discord、企业微信、LINE、QQ、QQ 官方机器人。大部分**无需公网 IP**。
|
||||
|
||||
### 🔄 多 Agent 编排
|
||||
**多机器人中继** — 在群聊中绑定多个机器人,让它们相互协作。问 Claude,再听 Gemini 的见解 — 同一个对话搞定。
|
||||
|
||||
### 🎮 完整的聊天控制
|
||||
**聊天即控制** — 切换模型 (`/model`)、切换推理强度 (`/reasoning`)、切换权限模式 (`/mode`)、管理会话,全部通过斜杠命令完成。
|
||||
|
||||
### 🧠 持久化记忆
|
||||
**Agent 记忆** — 在聊天中直接读写 Agent 指令文件 (`/memory`),无需回到终端。
|
||||
|
||||
### ⏰ 智能定时任务
|
||||
**定时任务** — 自然语言创建 cron 任务。"每天早上6点总结 GitHub trending" 即刻生效。
|
||||
|
||||
### 🎤 多模态支持
|
||||
**语音 & 图片** — 发语音或截图,cc-connect 自动处理 STT/TTS 和多模态转发。
|
||||
|
||||
### 📦 多项目架构
|
||||
**多项目管理** — 一个进程同时管理多个项目,各自独立的 Agent + 平台组合。
|
||||
|
||||
### 🌍 多语言界面
|
||||
**5 种语言** — 原生支持英语、中文(简体/繁体)、日语和西班牙语。内置 i18n 让每个人都能得心应手。
|
||||
|
||||
---
|
||||
|
||||
<p align="center">
|
||||
<img src="docs/images/screenshot/cc-connect-lark.JPG" alt="飞书" width="32%" />
|
||||
@@ -47,20 +136,32 @@ cc-connect 把运行在你机器上的 AI Agent 桥接到你日常使用的即
|
||||
<img src="docs/images/screenshot/cc-connect-wechat.JPG" alt="微信" width="32%" />
|
||||
</p>
|
||||
<p align="center">
|
||||
<em>左:飞书 | Telegram | 右:个人微信(通过企业微信关联)</em>
|
||||
<em>左:飞书 | Telegram | 右:微信</em>
|
||||
</p>
|
||||
|
||||
## 快速开始
|
||||
---
|
||||
|
||||
### 通过 AI Agent 安装配置(推荐)
|
||||
## 🚀 快速开始
|
||||
|
||||
把下面这段话发给 Claude Code 或其他 AI Agent,它会帮你完成整个安装和配置过程:
|
||||
### 🤖 通过 AI Agent 安装配置(推荐)
|
||||
|
||||
```
|
||||
> **最简单的方式** — 把这段话发给 Claude Code 或其他 AI 编码 Agent,它会帮你完成整个安装和配置过程:
|
||||
|
||||
```bash
|
||||
请参考 https://raw.githubusercontent.com/chenhg5/cc-connect/refs/heads/main/INSTALL.md 帮我安装和配置 cc-connect
|
||||
|
||||
重要提示:请使用交互式工具(如 AskUserQuestion)引导我完成配置选择:
|
||||
- Agent 选择(Claude Code、Cursor、Gemini 等)
|
||||
- 平台选择(飞书、Telegram、Discord 等)
|
||||
- API 密钥和认证令牌
|
||||
- 项目路径和个人偏好配置
|
||||
|
||||
不要猜测值——始终通过交互式提示让我选择或提供相关配置。
|
||||
```
|
||||
|
||||
### 手动安装
|
||||
---
|
||||
|
||||
### 📦 手动安装
|
||||
|
||||
**通过 npm:**
|
||||
|
||||
@@ -92,7 +193,9 @@ cd cc-connect
|
||||
make build
|
||||
```
|
||||
|
||||
### 配置
|
||||
---
|
||||
|
||||
### ⚙️ 配置
|
||||
|
||||
```bash
|
||||
mkdir -p ~/.cc-connect
|
||||
@@ -100,43 +203,30 @@ cp config.example.toml ~/.cc-connect/config.toml
|
||||
vim ~/.cc-connect/config.toml
|
||||
```
|
||||
|
||||
最简配置:
|
||||
---
|
||||
|
||||
```toml
|
||||
[[projects]]
|
||||
name = "my-project"
|
||||
|
||||
[projects.agent]
|
||||
type = "claudecode"
|
||||
|
||||
[projects.agent.options]
|
||||
work_dir = "/path/to/your/project"
|
||||
|
||||
[[projects.platforms]]
|
||||
type = "telegram"
|
||||
|
||||
[projects.platforms.options]
|
||||
token = "123456:ABC-xxx"
|
||||
```
|
||||
|
||||
### 运行
|
||||
### ▶️ 运行
|
||||
|
||||
```bash
|
||||
./cc-connect
|
||||
```
|
||||
|
||||
### 升级
|
||||
---
|
||||
|
||||
### 🔄 升级
|
||||
|
||||
```bash
|
||||
# npm
|
||||
npm install -g cc-connect # 稳定版
|
||||
npm install -g cc-connect
|
||||
|
||||
# 二进制自更新
|
||||
cc-connect update # 稳定版
|
||||
cc-connect update --pre # Beta 版(含 pre-release)
|
||||
cc-connect update # 稳定版
|
||||
cc-connect update --pre # Beta 版(含 pre-release)
|
||||
```
|
||||
|
||||
## 支持状态
|
||||
---
|
||||
|
||||
## 📊 支持状态
|
||||
|
||||
| 组件 | 类型 | 状态 |
|
||||
|------|------|------|
|
||||
@@ -149,17 +239,19 @@ cc-connect update --pre # Beta 版(含 pre-release)
|
||||
| Agent | iFlow CLI | ✅ 已支持 |
|
||||
| Agent | Goose (Block) | 🔜 计划中 |
|
||||
| Agent | Aider | 🔜 计划中 |
|
||||
| Platform | 飞书 (Lark) | ✅ WebSocket 长连接 — 无需公网 IP |
|
||||
| Platform | 钉钉 (DingTalk) | ✅ Stream 模式 — 无需公网 IP |
|
||||
| Platform | 飞书 (Lark) | ✅ WebSocket — 无需公网 IP |
|
||||
| Platform | 钉钉 | ✅ Stream — 无需公网 IP |
|
||||
| Platform | Telegram | ✅ Long Polling — 无需公网 IP |
|
||||
| Platform | Slack | ✅ Socket Mode — 无需公网 IP |
|
||||
| Platform | Discord | ✅ Gateway — 无需公网 IP |
|
||||
| Platform | LINE | ✅ Webhook — 需要公网 URL |
|
||||
| Platform | 企业微信 (WeChat Work) | ✅ WebSocket / Webhook |
|
||||
| Platform | 企业微信 | ✅ WebSocket / Webhook |
|
||||
| Platform | QQ (NapCat/OneBot) | ✅ WebSocket — Beta |
|
||||
| Platform | QQ 官方机器人 (QQ Bot) | ✅ WebSocket — 无需公网 IP |
|
||||
| Platform | QQ 官方机器人 | ✅ WebSocket — 无需公网 IP |
|
||||
|
||||
## 平台接入指南
|
||||
---
|
||||
|
||||
## 📖 平台接入指南
|
||||
|
||||
| 平台 | 指南 | 连接方式 | 需要公网 IP? |
|
||||
|------|------|---------|-------------|
|
||||
@@ -171,18 +263,22 @@ cc-connect update --pre # Beta 版(含 pre-release)
|
||||
| 企业微信 | [docs/wecom.md](docs/wecom.md) | WebSocket / Webhook | 不需要 (WS) / 需要 (Webhook) |
|
||||
| QQ / QQ 机器人 | [docs/qq.md](docs/qq.md) | WebSocket | 不需要 |
|
||||
|
||||
## 常用命令
|
||||
---
|
||||
|
||||
### 会话管理
|
||||
## 🎯 核心功能
|
||||
|
||||
### 💬 会话管理
|
||||
|
||||
```
|
||||
/new [名称] 创建新会话
|
||||
/list 列出会话
|
||||
/list 列出所有会话
|
||||
/switch <id> 切换会话
|
||||
/current 查看当前会话
|
||||
```
|
||||
|
||||
### 权限模式
|
||||
---
|
||||
|
||||
### 🔐 权限模式
|
||||
|
||||
```
|
||||
/mode 查看可用模式
|
||||
@@ -190,42 +286,51 @@ cc-connect update --pre # Beta 版(含 pre-release)
|
||||
/mode default # 每次工具调用前询问
|
||||
```
|
||||
|
||||
### Provider 管理
|
||||
---
|
||||
|
||||
### 🔄 Provider 管理
|
||||
|
||||
```
|
||||
/provider list 列出 Provider
|
||||
/provider switch <名称> 运行时切换 API Provider
|
||||
```
|
||||
|
||||
### 定时任务
|
||||
---
|
||||
|
||||
```
|
||||
### ⏰ 定时任务
|
||||
|
||||
```bash
|
||||
/cron add 0 6 * * * 帮我总结 GitHub trending
|
||||
```
|
||||
|
||||
📖 **完整文档:** [docs/usage.zh-CN.md](docs/usage.zh-CN.md)
|
||||
|
||||
## 文档
|
||||
---
|
||||
|
||||
## 📚 文档
|
||||
|
||||
- [使用指南](docs/usage.zh-CN.md) — 完整功能文档
|
||||
- [INSTALL.md](INSTALL.md) — AI Agent 友好的安装指南
|
||||
- [config.example.toml](config.example.toml) — 配置模板
|
||||
|
||||
## 社区
|
||||
---
|
||||
|
||||
## 👥 社区
|
||||
|
||||
- [Discord](https://discord.gg/kHpwgaM4kq)
|
||||
- [Telegram](https://t.me/+odGNDhCjbjdmMmZl)
|
||||
- 微信用户群
|
||||
|
||||
<img src="https://quick.go-admin.cn/ai/article/cc-connect_wechat_group.JPG" alt="用户群" width="100px" />
|
||||
---
|
||||
|
||||
## 贡献者
|
||||
## 🙏 贡献者
|
||||
|
||||
<a href="https://github.com/chenhg5/cc-connect/graphs/contributors">
|
||||
<img src="https://contrib.rocks/image?repo=chenhg5/cc-connect" />
|
||||
<img src="https://contrib.rocks/image?repo=chenhg5/cc-connect&v=20250313" />
|
||||
</a>
|
||||
|
||||
## Star History
|
||||
---
|
||||
|
||||
## ⭐ Star History
|
||||
|
||||
<a href="https://www.star-history.com/#chenhg5/cc-connect&Date">
|
||||
<picture>
|
||||
@@ -235,6 +340,14 @@ cc-connect update --pre # Beta 版(含 pre-release)
|
||||
</picture>
|
||||
</a>
|
||||
|
||||
## License
|
||||
---
|
||||
|
||||
MIT
|
||||
## 📄 License
|
||||
|
||||
MIT License
|
||||
|
||||
---
|
||||
|
||||
<p align="center">
|
||||
<sub>由 cc-connect 社区用 ❤️ 构建</sub>
|
||||
</p>
|
||||
@@ -0,0 +1,24 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 800 200">
|
||||
<defs>
|
||||
<linearGradient id="textGrad" x1="0%" y1="0%" x2="100%" y2="0%">
|
||||
<stop offset="0%" style="stop-color:#0ea5e9;stop-opacity:1" />
|
||||
<stop offset="100%" style="stop-color:#0284c7;stop-opacity:1" />
|
||||
</linearGradient>
|
||||
<filter id="glow">
|
||||
<feGaussianBlur stdDeviation="1.5" result="coloredBlur"/>
|
||||
<feMerge>
|
||||
<feMergeNode in="coloredBlur"/>
|
||||
<feMergeNode in="SourceGraphic"/>
|
||||
</feMerge>
|
||||
</filter>
|
||||
</defs>
|
||||
|
||||
<!-- Background -->
|
||||
<rect width="800" height="200" fill="#0f172a"/>
|
||||
|
||||
<!-- Title -->
|
||||
<text x="400" y="115" font-family="system-ui, -apple-system, sans-serif" font-size="72" fill="url(#textGrad)" text-anchor="middle" font-weight="bold" filter="url(#glow)" letter-spacing="-2">CC-Connect</text>
|
||||
|
||||
<!-- Subtitle -->
|
||||
<text x="400" y="150" font-family="system-ui, -apple-system, sans-serif" font-size="16" fill="#94a3b8" text-anchor="middle">Bridge AI Agents to Chat Platforms</text>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 1.0 KiB |
Reference in new issue
Block a user