# CoPaw
**Repository Path**: mxchen-team/CoPaw
## Basic Information
- **Project Name**: CoPaw
- **Description**: https://github.com/agentscope-ai/CoPaw , 原址, 方便大家使用
- **Primary Language**: Python
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 4
- **Created**: 2026-03-03
- **Last Updated**: 2026-03-03
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
# CoPaw
[](https://github.com/agentscope-ai/CoPaw)
[](https://pypi.org/project/copaw/)
[](https://copaw.agentscope.io/)
[](https://www.python.org/downloads/)
[](https://github.com/agentscope-ai/CoPaw)
[](LICENSE)
[](https://github.com/psf/black)
[](https://github.com/agentscope-ai/CoPaw/stargazers)
[](https://github.com/agentscope-ai/CoPaw/network)
[](https://deepwiki.com/agentscope-ai/CoPaw)
[](https://discord.gg/eYMpfnkG8h)
[](https://qr.dingtalk.com/action/joingroup?code=v1,k1,OmDlBXpjW+I2vWjKDsjvI9dhcXjGZi3bQiojOq3dlDw=&_dt_no_comment=1&origin=11)
[[文档](https://copaw.agentscope.io/)] [[English](README.md)]
懂你所需,伴你左右。
你的AI个人助理;安装极简、本地与云上均可部署;支持多端接入、能力轻松扩展。
> **核心能力:**
>
> **全域触达** — 钉钉、飞书、QQ、Discord、iMessage 等频道,一个 CoPaw 按需连接。
>
> **由你掌控** — 记忆与个性化由你掌控,本地或云端均可;定时与协作发往指定频道。
>
> **Skills 扩展** — 内置定时任务,自定义技能目录,CoPaw 自动加载,无绑定。
>
>
> 你可以用 CoPaw 做什么
>
>
>
> - **社交媒体**:每日热帖摘要(小红书、知乎、Reddit),B 站/YouTube 新视频摘要。
> - **生产力**:邮件与 Newsletter 精华推送到钉钉/飞书/QQ,邮件与日历整理联系人。
> - **创意与构建**:睡前说明目标、自动执行,次日获得雏形;从选题到成片全流程。
> - **研究与学习**:追踪科技与 AI 资讯,个人知识库检索复用。
> - **桌面与文件**:整理与搜索本地文件、阅读与摘要文档,在会话中索要文件。
> - **探索更多**:用 Skills 与定时任务组合成你自己的 agentic app。
>
>
---
## 目录
> **推荐阅读:**
>
> - **我想三条命令跑起来**: [快速开始](#快速开始) → 浏览器打开控制台。
> - **我想在钉钉 / 飞书 / QQ 里聊**: [快速开始](#快速开始) → [频道配置](https://copaw.agentscope.io/docs/channels)。
> - **我不想装 Python**:[一键安装](#一键安装beta持续完善中) 自动管理 Python,或使用 [魔搭一键配置](https://modelscope.cn/studios/fork?target=AgentScope/CoPaw) 云端部署。
- [快速开始](#快速开始)
- [API Key](#api-key)
- [本地模型](#本地模型)
- [文档](#文档)
- [从源码安装](#从源码安装)
- [为什么叫 CoPaw?](#为什么叫-copaw)
- [由谁构建](#由谁构建)
- [许可证](#许可证)
---
## 快速开始
### pip 安装 (推荐)
如果你习惯自行管理 Python 环境:
```bash
pip install copaw
copaw init --defaults
copaw app
```
在浏览器打开 **http://127.0.0.1:8088/** 即可使用控制台(与 CoPaw 对话、配置 Agent)。若要在钉钉、飞书、QQ 等 app 内对话,请在 [文档](https://copaw.agentscope.io/docs/channels) 中接入频道。

### 一键安装(beta,持续完善中)
无需预装 Python — 安装脚本自动处理一切:
**macOS / Linux:**
```bash
curl -fsSL https://copaw.agentscope.io/install.sh | bash
```
**Windows(PowerShell):**
```powershell
irm https://copaw.agentscope.io/install.ps1 | iex
```
然后打开新终端并运行:
```bash
copaw init --defaults # 或:copaw init(交互式)
copaw app
```
安装选项
**macOS / Linux:**
```bash
# 安装指定版本
curl -fsSL ... | bash -s -- --version 0.0.2
# 从源码安装(开发/测试用)
curl -fsSL ... | bash -s -- --from-source
# 安装本地模型支持
bash install.sh --extras llamacpp # llama.cpp(跨平台)
bash install.sh --extras mlx # MLX(Apple Silicon)
bash install.sh --extras llamacpp,mlx
# 升级 — 重新运行安装命令即可
curl -fsSL ... | bash
# 卸载
copaw uninstall # 保留配置和数据
copaw uninstall --purge # 删除所有内容
```
**Windows(PowerShell):**
```powershell
# 安装指定版本
irm ... | iex; .\install.ps1 -Version 0.0.2
# 从源码安装(开发/测试用)
.\install.ps1 -FromSource
# 安装本地模型支持
.\install.ps1 -Extras llamacpp # llama.cpp(跨平台)
.\install.ps1 -Extras mlx # MLX
.\install.ps1 -Extras llamacpp,mlx
# 升级 — 重新运行安装命令即可
irm ... | iex
# 卸载
copaw uninstall # 保留配置和数据
copaw uninstall --purge # 删除所有内容
```
### 使用 Docker
```bash
docker pull agentscope/copaw:latest
docker run -p 8088:8088 -v copaw-data:/app/working agentscope/copaw:latest
```
然后在浏览器打开 **http://127.0.0.1:8088/** 进入控制台。配置、记忆与 Skills 保存在 `copaw-data` 卷中。如需传入 API Key(如 `DASHSCOPE_API_KEY`),在 `docker run` 时添加 `-e VAR=value` 或 `--env-file .env`。
镜像从零构建。若需自行构建镜像,请参阅 [scripts/README.md](scripts/README.md#build-docker-image) 中的「Build Docker image」小节,构建后推送到你的镜像仓库。
### 使用魔搭创空间
**不想本地安装?** 使用 [魔搭创空间](https://modelscope.cn/studios/fork?target=AgentScope/CoPaw) 一键云端配置。请将创空间设为 **非公开**,否则他人可能操纵你的 CoPaw。
### 部署到阿里云 ECS
若希望将 CoPaw 部署在阿里云上,可使用阿里云 ECS 一键部署:打开 [CoPaw 阿里云 ECS 部署链接](https://computenest.console.aliyun.com/service/instance/create/cn-hangzhou?type=user&ServiceId=service-1ed84201799f40879884) 按页面提示操作即可。详细步骤见 [阿里云开发者社区:CoPaw 3 分钟部署你的 AI 助理](https://developer.aliyun.com/article/1713682)。
---
## API Key
若使用**云端大模型**(如 DashScope、ModelScope),在开始对话前必须配置 API Key。未配置有效 Key 前,CoPaw 无法正常工作。
**配置方式:**
1. **`copaw init`** — 运行 `copaw init` 时,会引导你配置 LLM 提供商与 API Key。按提示选择提供商并填写 Key 即可。
2. **控制台** — 运行 `copaw app` 后,打开 **http://127.0.0.1:8088/** → **设置** → **模型**。选择提供商、填写 **API Key**,并启用该提供商与模型。
3. **环境变量** — 使用 DashScope 时,可在终端或工作目录下的 `.env` 文件中设置 `DASHSCOPE_API_KEY`。
其他工具所需密钥(如网页搜索的 `TAVILY_API_KEY`)可在控制台 **设置 → 环境变量** 中配置,详见 [配置](https://copaw.agentscope.io/docs/config)。
> **仅用本地模型?** 若使用 [本地模型](#本地模型)(llama.cpp 或 MLX),则**无需**任何 API Key。
---
## 本地模型
CoPaw 可在本机完全本地运行大模型,无需 API Key 或云端服务。
| 后端 | 适用场景 | 安装 |
| ------------- | --------------------------------- | ------------------------------- |
| **llama.cpp** | 跨平台(macOS / Linux / Windows) | `pip install 'copaw[llamacpp]'` |
| **MLX** | Apple Silicon(M1/M2/M3/M4) | `pip install 'copaw[mlx]'` |
安装后下载模型并开始对话:
```bash
copaw models download Qwen/Qwen3-4B-GGUF
copaw models # 选择已下载的模型
copaw app # 启动服务
```
也可在控制台界面中下载与管理本地模型。
---
## 文档
| 主题 | 说明 |
| --------------------------------------------------------- | ------------------------------------ |
| [项目介绍](https://copaw.agentscope.io/docs/intro) | CoPaw 是什么、怎么用 |
| [快速开始](https://copaw.agentscope.io/docs/quickstart) | 安装与运行(本地或魔搭创空间) |
| [控制台](https://copaw.agentscope.io/docs/console) | Web 界面:对话与 Agent 配置 |
| [频道配置](https://copaw.agentscope.io/docs/channels) | 钉钉、飞书、QQ、Discord、iMessage 等 |
| [心跳](https://copaw.agentscope.io/docs/heartbeat) | 定时自检与摘要 |
| [本地模型](https://copaw.agentscope.io/docs/local-models) | 使用 llama.cpp 或 MLX 本地运行模型 |
| [CLI](https://copaw.agentscope.io/docs/cli) | 初始化、定时任务、Skills、清理 |
| [Skills](https://copaw.agentscope.io/docs/skills) | 扩展与自定义能力 |
| [FAQ](https://copaw.agentscope.io/docs/faq) | 常见问题与报错排查 |
| [记忆](https://copaw.agentscope.io/docs/memory) | 上下文管理与长期记忆 |
| [配置与工作目录](https://copaw.agentscope.io/docs/config) | 工作目录与配置文件 |
完整文档见本仓库 [website/public/docs/](website/public/docs/)。
---
## 从源码安装
```bash
git clone https://github.com/agentscope-ai/CoPaw.git
cd CoPaw
pip install -e .
```
- **开发**(测试、格式化):`pip install -e ".[dev]"`
- **控制台**(构建前端):在项目根目录执行 `cd console && npm ci && npm run build`,再运行 `copaw app`。
---
## 为什么叫 CoPaw?
CoPaw 既是「你的搭档小爪子」(co-paw),也寓意 **Co Personal Agent Workstation**(协同个人智能体工作台)。我们希望它不是冰冷的工具,而是一只随时准备帮忙的温暖「小爪子」,是你数字生活中最默契的伙伴。
---
## 由谁构建
[AgentScope 团队](https://github.com/agentscope-ai) · [AgentScope](https://github.com/agentscope-ai/agentscope) · [AgentScope Runtime](https://github.com/agentscope-ai/agentscope-runtime) · [ReMe](https://github.com/agentscope-ai/ReMe)
---
## 联系我们
| [Discord](https://discord.gg/eYMpfnkG8h) | [钉钉](https://qr.dingtalk.com/action/joingroup?code=v1,k1,OmDlBXpjW+I2vWjKDsjvI9dhcXjGZi3bQiojOq3dlDw=&_dt_no_comment=1&origin=11) |
| ------------------------------------------------------------ | ------------------------------------------------------------ |
| [
](https://discord.gg/eYMpfnkG8h) | [
](https://qr.dingtalk.com/action/joingroup?code=v1,k1,OmDlBXpjW+I2vWjKDsjvI9dhcXjGZi3bQiojOq3dlDw=&_dt_no_comment=1&origin=11) |
---
## 许可证
CoPaw 采用 [Apache License 2.0](LICENSE) 开源协议。