From 628a85d1beb7ad367b4bf8947b40a3da08093d29 Mon Sep 17 00:00:00 2001 From: zhayujie Date: Fri, 27 Feb 2026 16:48:23 +0800 Subject: [PATCH] docs: update README.md --- README.md | 24 ++++-- docs/en/README.md | 176 +++++++++++++++++++++++++++++++++++++++++++ docs/intro/index.mdx | 2 +- 3 files changed, 193 insertions(+), 9 deletions(-) create mode 100644 docs/en/README.md diff --git a/README.md b/README.md index 358cd1f..4283508 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,15 @@ **CowAgent** 是基于大模型的超级AI助理，能够主动思考和任务规划、操作计算机和外部资源、创造和执行Skills、拥有长期记忆并不断成长。CowAgent 支持灵活切换多种模型，能处理文本、语音、图片、文件等多模态消息，可接入网页、飞书、钉钉、企业微信应用、微信公众号中使用，7*24小时运行于你的个人电脑或服务器中。 -📖能力介绍：[CowAgent 2.0](/docs/agent.md) +

+ 🌐 官网  ·  + 📖 文档中心  ·  + 🚀 快速开始 +

+ +

+ 中文 | English +

# 简介 @@ -30,7 +38,7 @@ ## 演示 -使用说明(Agent模式)：[CowAgent介绍](/docs/agent.md) +使用说明(Agent模式)：[CowAgent介绍](https://docs.cowagent.ai/intro/features) DEMO视频(对话模式)：https://cdn.link-ai.tech/doc/cow_demo.mp4 @@ -68,7 +76,7 @@ DEMO视频(对话模式)：https://cdn.link-ai.tech/doc/cow_demo.mp4 >**2024.10.31：** [1.7.3版本](https://github.com/zhayujie/chatgpt-on-wechat/releases/tag/1.7.3) 程序稳定性提升、数据库功能、Claude模型优化、linkai插件优化、离线通知 -更多更新历史请查看: [更新日志](/docs/release/history.md) +更多更新历史请查看: [更新日志](https://docs.cowagent.ai/releases/overview)
@@ -82,7 +90,7 @@ DEMO视频(对话模式)：https://cdn.link-ai.tech/doc/cow_demo.mp4 bash <(curl -sS https://cdn.link-ai.tech/code/cow/run.sh) ``` -脚本使用说明：[一键运行脚本](https://github.com/zhayujie/chatgpt-on-wechat/wiki/CowAgentQuickStart) +脚本使用说明：[一键运行脚本](https://docs.cowagent.ai/guide/quick-start) ## 一、准备 @@ -659,7 +667,7 @@ API Key创建：在 [控制台](https://aistudio.google.com/app/apikey?hl=zh-cn) - `feishu_event_mode`: 事件接收模式，`websocket`（推荐）或 `webhook` - WebSocket 模式需安装依赖：`pip3 install lark-oapi` -详细步骤和参数说明参考 [飞书接入](https://docs.link-ai.tech/cow/multi-platform/feishu) +详细步骤和参数说明参考 [飞书接入](https://docs.cowagent.ai/channels/feishu) @@ -675,7 +683,7 @@ API Key创建：在 [控制台](https://aistudio.google.com/app/apikey?hl=zh-cn) "dingtalk_client_secret": "CLIENT_SECRET" } ``` -详细步骤和参数说明参考 [钉钉接入](https://docs.link-ai.tech/cow/multi-platform/dingtalk) +详细步骤和参数说明参考 [钉钉接入](https://docs.cowagent.ai/channels/dingtalk)
@@ -694,7 +702,7 @@ API Key创建：在 [控制台](https://aistudio.google.com/app/apikey?hl=zh-cn) "wechatcomapp_aes_key": "AESKEY" } ``` -详细步骤和参数说明参考 [企微自建应用接入](https://docs.link-ai.tech/cow/multi-platform/wechat-com) +详细步骤和参数说明参考 [企微自建应用接入](https://docs.cowagent.ai/channels/wecom)
@@ -729,7 +737,7 @@ API Key创建：在 [控制台](https://aistudio.google.com/app/apikey?hl=zh-cn) } ``` -详细步骤和参数说明参考 [微信公众号接入](https://docs.link-ai.tech/cow/multi-platform/wechat-mp) +详细步骤和参数说明参考 [微信公众号接入](https://docs.cowagent.ai/channels/wechatmp) diff --git a/docs/en/README.md b/docs/en/README.md new file mode 100644 index 0000000..c9dc908 --- /dev/null +++ b/docs/en/README.md @@ -0,0 +1,176 @@ +

CowAgent

+ +

+ Latest release + License: MIT + Stars
+

+ +**CowAgent** is an AI super assistant powered by LLMs, capable of autonomous task planning, operating computers and external resources, creating and executing Skills, and continuously growing with long-term memory. It supports flexible model switching, handles text, voice, images, and files, and can be integrated into Web, Feishu, DingTalk, WeCom, and WeChat Official Account — running 7×24 hours on your personal computer or server. + +

+ 🌐 Website  ·  + 📖 Docs  ·  + 🚀 Quick Start +

+ +

+ 中文 | English +

+ +## Introduction + +> CowAgent is both an out-of-the-box AI super assistant and a highly extensible Agent framework. You can extend it with new model interfaces, channels, built-in tools, and the Skills system to flexibly implement various customization needs. + +- ✅ **Autonomous Task Planning**: Understands complex tasks and autonomously plans execution, continuously thinking and invoking tools until goals are achieved. Supports accessing files, terminal, browser, schedulers, and other system resources via tools. +- ✅ **Long-term Memory**: Automatically persists conversation memory to local files and databases, including core memory and daily memory, with keyword and vector retrieval support. +- ✅ **Skills System**: Implements a Skills creation and execution engine with multiple built-in skills, and supports custom Skills development through natural language conversation. +- ✅ **Multimodal Messages**: Supports parsing, processing, generating, and sending text, images, voice, files, and other message types. +- ✅ **Multiple Model Support**: Supports OpenAI, Claude, Gemini, DeepSeek, MiniMax, GLM, Qwen, Kimi, Doubao, and other mainstream model providers. +- ✅ **Multi-platform Deployment**: Runs on local computers or servers, integrable into Web, Feishu, DingTalk, WeChat Official Account, and WeCom applications. +- ✅ **Knowledge Base**: Integrates enterprise knowledge base capabilities via the [LinkAI](https://link-ai.tech) platform. + +## Disclaimer + +1. This project follows the [MIT License](/LICENSE) and is intended for technical research and learning. Users must comply with local laws, regulations, policies, and corporate bylaws. Any illegal or rights-infringing use is prohibited. +2. Agent mode consumes more tokens than normal chat mode. Choose models based on effectiveness and cost. Agent has access to the host OS — please deploy in trusted environments. +3. CowAgent focuses on open-source development and does not participate in, authorize, or issue any cryptocurrency. + +## Changelog + +> **2026.02.03:** [v2.0.0](https://github.com/zhayujie/chatgpt-on-wechat/releases/tag/2.0.0) — Full upgrade to AI super assistant with multi-step task planning, long-term memory, built-in tools, Skills framework, new models, and optimized channels. + +> **2025.05.23:** [v1.7.6](https://github.com/zhayujie/chatgpt-on-wechat/releases/tag/1.7.6) — Web channel optimization, AgentMesh multi-agent plugin, Baidu TTS, claude-4-sonnet/opus support. + +> **2025.04.11:** [v1.7.5](https://github.com/zhayujie/chatgpt-on-wechat/releases/tag/1.7.5) — wechatferry protocol, DeepSeek model, Tencent Cloud voice, ModelScope and Gitee-AI support. + +> **2024.12.13:** [v1.7.4](https://github.com/zhayujie/chatgpt-on-wechat/releases/tag/1.7.4) — Gemini 2.0 model, Web channel, memory leak fix. + +Full changelog: [Release Notes](https://docs.cowagent.ai/en/releases/overview) + +
+ +## 🚀 Quick Start + +The project provides a one-click script for installation, configuration, startup, and management: + +```bash +bash <(curl -sS https://cdn.link-ai.tech/code/cow/run.sh) +``` + +After running, the Web service starts by default. Access `http://localhost:9899/chat` to chat. + +Script usage: [One-click Install](https://docs.cowagent.ai/en/guide/quick-start) + +### Manual Installation + +**1. Clone the project** + +```bash +git clone https://github.com/zhayujie/chatgpt-on-wechat +cd chatgpt-on-wechat/ +``` + +**2. Install dependencies** + +```bash +pip3 install -r requirements.txt +pip3 install -r requirements-optional.txt # optional but recommended +``` + +**3. Configure** + +```bash +cp config-template.json config.json +``` + +Fill in your model API key and channel type in `config.json`. See the [configuration docs](https://docs.cowagent.ai/en/guide/manual-install) for details. + +**4. Run** + +```bash +python3 app.py +``` + +For server background run: + +```bash +nohup python3 app.py & tail -f nohup.out +``` + +### Docker Deployment + +```bash +wget https://cdn.link-ai.tech/code/cow/docker-compose.yml +# Edit docker-compose.yml with your config +sudo docker compose up -d +sudo docker logs -f chatgpt-on-wechat +``` + +
+ +## Models + +Supports mainstream model providers. Recommended models for Agent mode: + +| Provider | Recommended Model | +| --- | --- | +| MiniMax | `MiniMax-M2.5` | +| GLM | `glm-5` | +| Kimi | `kimi-k2.5` | +| Doubao | `doubao-seed-2-0-code-preview-260215` | +| Qwen | `qwen3.5-plus` | +| Claude | `claude-sonnet-4-6` | +| Gemini | `gemini-3.1-pro-preview` | +| OpenAI | `gpt-4.1` | +| DeepSeek | `deepseek-chat` | + +For detailed configuration of each model, see the [Models documentation](https://docs.cowagent.ai/en/models/index). + +
+ +## Channels + +Supports multiple platforms. Set `channel_type` in `config.json` to switch: + +| Channel | `channel_type` | Docs | +| --- | --- | --- | +| Web (default) | `web` | [Web Channel](https://docs.cowagent.ai/en/channels/web) | +| Feishu | `feishu` | [Feishu Setup](https://docs.cowagent.ai/en/channels/feishu) | +| DingTalk | `dingtalk` | [DingTalk Setup](https://docs.cowagent.ai/en/channels/dingtalk) | +| WeCom App | `wechatcom_app` | [WeCom Setup](https://docs.cowagent.ai/en/channels/wecom) | +| WeChat MP | `wechatmp` / `wechatmp_service` | [WeChat MP Setup](https://docs.cowagent.ai/en/channels/wechatmp) | +| Terminal | `terminal` | — | + +Multiple channels can be enabled simultaneously, separated by commas: `"channel_type": "feishu,dingtalk"`. + +
+ +## Enterprise Services + + + +> [LinkAI](https://link-ai.tech/) is a one-stop AI agent platform for enterprises and developers, integrating multimodal LLMs, knowledge bases, Agent plugins, and workflows. Supports one-click integration with mainstream platforms, SaaS and private deployment. + +
+ +## 🔗 Related Projects + +- [bot-on-anything](https://github.com/zhayujie/bot-on-anything): Lightweight and highly extensible LLM application framework supporting Slack, Telegram, Discord, Gmail, and more. +- [AgentMesh](https://github.com/MinimalFuture/AgentMesh): Open-source Multi-Agent framework for complex problem solving through agent team collaboration. + +## 🔎 FAQ + +FAQs: + +## 🛠️ Contributing + +Welcome to add new channels, referring to the [Feishu channel](https://github.com/zhayujie/chatgpt-on-wechat/blob/master/channel/feishu/feishu_channel.py) as an example. Also welcome to contribute new Skills, referring to the [Skill Creator docs](https://github.com/zhayujie/chatgpt-on-wechat/blob/master/skills/skill-creator/SKILL.md). + +## ✉ Contact + +Welcome to submit PRs and Issues, and support the project with a 🌟 Star. For questions, check the [FAQ list](https://github.com/zhayujie/chatgpt-on-wechat/wiki/FAQs) or search [Issues](https://github.com/zhayujie/chatgpt-on-wechat/issues). + +## 🌟 Contributors + +![cow contributors](https://contrib.rocks/image?repo=zhayujie/chatgpt-on-wechat&max=1000) diff --git a/docs/intro/index.mdx b/docs/intro/index.mdx index e381098..ebd263d 100644 --- a/docs/intro/index.mdx +++ b/docs/intro/index.mdx @@ -3,7 +3,7 @@ title: 项目介绍 description: CowAgent - 基于大模型的超级AI助理 --- -CowAgent +CowAgent **CowAgent** 是基于大模型的超级AI助理，能够主动思考和任务规划、操作计算机和外部资源、创造和执行Skills、拥有长期记忆并不断成长。