1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273<div align="center">
# 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)
[[Documentation](https://copaw.agentscope.io/)] [[δΈζ README](README_zh.md)]
<p align="center">
<img src="https://img.alicdn.com/imgextra/i1/O1CN01tvT5rg1JHQNRP8tXR_!!6000000001003-2-tps-1632-384.png" alt="CoPaw Logo" width="120">
</p>
<p align="center"><b>Works for you, grows with you.</b></p>
</div>
Your Personal AI Assistant; easy to install, deploy on your own machine or on the cloud; supports multiple chat apps with easily extensible capabilities.
> **Core capabilities:**
>
> **Every channel** β DingTalk, Feishu, QQ, Discord, iMessage, and more. One assistant, connect as you need.
>
> **Under your control** β Memory and personalization under your control. Deploy locally or in the cloud; scheduled reminders to any channel.
>
> **Skills** β Built-in cron; custom skills in your workspace, auto-loaded. No lock-in.
>
> <details>
> <summary><b>What you can do</b></summary>
>
> <br>
>
> - **Social**: daily digest of hot posts (Xiaohongshu, Zhihu, Reddit), Bilibili/YouTube summaries.
> - **Productivity**: newsletter digests to DingTalk/Feishu/QQ, contacts from email/calendar.
> - **Creative**: describe your goal, run overnight, get a draft next day.
> - **Research**: track tech/AI news, personal knowledge base.
> - **Desktop**: organize files, read/summarize docs, request files in chat.
> - **Explore**: combine Skills and cron into your own agentic app.
>
> </details>
---
## Table of Contents
> **Recommended reading:**
>
> - **I want to run CoPaw in 3 commands**: [Quick Start](#quick-start) β open Console in browser.
> - **I want to chat in DingTalk / Feishu / QQ**: [Quick Start](#quick-start) β [Channels](https://copaw.agentscope.io/docs/channels).
> - **I donβt want to install Python**: [One-line install](#one-line-install-beta-continuously-improving) handles Python automatically, or use [ModelScope one-click](https://modelscope.cn/studios/fork?target=AgentScope/CoPaw) for cloud.
- [Quick Start](#quick-start)
- [API Key](#api-key)
- [Local Models](#local-models)
- [Documentation](#documentation)
- [Install from source](#install-from-source)
- [Why CoPaw?](#why-copaw)
- [Built by](#built-by)
- [License](#license)
---
## Quick Start
### pip install (recommended)
If you prefer managing Python yourself:
```bash
pip install copaw
copaw init --defaults
copaw app
```
Then open **http://127.0.0.1:8088/** in your browser for the Console (chat with CoPaw, configure the agent). To talk in DingTalk, Feishu, QQ, etc., add a channel in the [docs](https://copaw.agentscope.io/docs/channels).
### One-line install (beta, continuously improving)
No Python required β the installer handles everything:
**macOS / Linux:**
```bash
curl -fsSL https://copaw.agentscope.io/install.sh | bash
```
**Windows (PowerShell):**
```powershell
irm https://copaw.agentscope.io/install.ps1 | iex
```
Then open a new terminal and run:
```bash
copaw init --defaults # or: copaw init (interactive)
copaw app
```
<details>
<summary><b>Install options</b></summary>
**macOS / Linux:**
```bash
# Install a specific version
curl -fsSL ... | bash -s -- --version 0.0.2
# Install from source (dev/testing)
curl -fsSL ... | bash -s -- --from-source
# With local model support
bash install.sh --extras llamacpp # llama.cpp (cross-platform)
bash install.sh --extras mlx # MLX (Apple Silicon)
bash install.sh --extras llamacpp,mlx
# Upgrade β just re-run the installer
curl -fsSL ... | bash
# Uninstall
copaw uninstall # keeps config and data
copaw uninstall --purge # removes everything
```
**Windows (PowerShell):**
```powershell
# Install a specific version
irm ... | iex; .\install.ps1 -Version 0.0.2
# Install from source (dev/testing)
.\install.ps1 -FromSource
# With local model support
.\install.ps1 -Extras llamacpp # llama.cpp (cross-platform)
.\install.ps1 -Extras mlx # MLX
.\install.ps1 -Extras llamacpp,mlx
# Upgrade β just re-run the installer
irm ... | iex
# Uninstall
copaw uninstall # keeps config and data
copaw uninstall --purge # removes everything
```
</details>
### Using Docker
```bash
docker pull agentscope/copaw:latest
docker run -p 8088:8088 -v copaw-data:/app/working agentscope/copaw:latest
```
Then open **http://127.0.0.1:8088/** for the Console. Config, memory, and skills are stored in the `copaw-data` volume. To pass API keys (e.g. `DASHSCOPE_API_KEY`), add `-e VAR=value` or `--env-file .env` to `docker run`.
The image is built from scratch. To build the image yourself, please refer to the [Build Docker image](scripts/README.md#build-docker-image) section in `scripts/README.md`, and then push to your registry.
### Using ModelScope
**No local install?** [ModelScope Studio](https://modelscope.cn/studios/fork?target=AgentScope/CoPaw) one-click cloud setup. Set your Studio to **non-public** so others cannot control your CoPaw.
### Deploy on Alibaba Cloud ECS
To run CoPaw on Alibaba Cloud (ECS), use the one-click deployment: open the [CoPaw on Alibaba Cloud (ECS) deployment link](https://computenest.console.aliyun.com/service/instance/create/cn-hangzhou?type=user&ServiceId=service-1ed84201799f40879884) and follow the prompts. For step-by-step instructions, see [Alibaba Cloud Developer: Deploy your AI assistant in 3 minutes](https://developer.aliyun.com/article/1713682).
---
## API Key
If you use a **cloud LLM** (e.g. DashScope, ModelScope), you must set an API key before chatting. CoPaw will not work until a valid key is configured.
**Where to set it:**
1. **`copaw init`** β When you run `copaw init`, the command has a step to configure the LLM provider and API key. Follow the prompts to choose a provider and enter your key.
2. **Console** β After `copaw app`, open **http://127.0.0.1:8088/** β **Settings** β **Models**. Select a provider, fill in the **API Key** field, then activate that provider and model.
3. **Environment variable** β For DashScope you can set `DASHSCOPE_API_KEY` in your shell or in a `.env` file in the working directory.
Tools that need extra keys (e.g. `TAVILY_API_KEY` for web search) can be set in Console **Settings β Environment variables**, or see [Config](https://copaw.agentscope.io/docs/config) for details.
> **Using local models only?** If you use [Local Models](#local-models) (llama.cpp or MLX), you do **not** need any API key.
## Local Models
CoPaw can run LLMs entirely on your machine β no API keys or cloud services required.
| Backend | Best for | Install |
| ------------- | ---------------------------------------- | ------------------------------- |
| **llama.cpp** | Cross-platform (macOS / Linux / Windows) | `pip install 'copaw[llamacpp]'` |
| **MLX** | Apple Silicon Macs (M1/M2/M3/M4) | `pip install 'copaw[mlx]'` |
After installing, download a model and start chatting:
```bash
copaw models download Qwen/Qwen3-4B-GGUF
copaw models # select the downloaded model
copaw app # start the server
```
You can also download and manage local models from the Console UI.
---
## Documentation
| Topic | Description |
| ------------------------------------------------------------- | ------------------------------------------------- |
| [Introduction](https://copaw.agentscope.io/docs/intro) | What CoPaw is and how you use it |
| [Quick start](https://copaw.agentscope.io/docs/quickstart) | Install and run (local or ModelScope Studio) |
| [Console](https://copaw.agentscope.io/docs/console) | Web UI for chat and agent config |
| [Channels](https://copaw.agentscope.io/docs/channels) | DingTalk, Feishu, QQ, Discord, iMessage, and more |
| [Heartbeat](https://copaw.agentscope.io/docs/heartbeat) | Scheduled check-in or digest |
| [Local Models](https://copaw.agentscope.io/docs/local-models) | Run models locally with llama.cpp or MLX |
| [CLI](https://copaw.agentscope.io/docs/cli) | Init, cron jobs, skills, clean |
| [Skills](https://copaw.agentscope.io/docs/skills) | Extend and customize capabilities |
| [FAQ](https://copaw.agentscope.io/docs/faq) | Common questions and troubleshooting tips |
| [Memory](https://copaw.agentscope.io/docs/memory) | Context management and long-term memory |
| [Config](https://copaw.agentscope.io/docs/config) | Working directory and config file |
Full docs in this repo: [website/public/docs/](website/public/docs/).
---
## Install from source
```bash
git clone https://github.com/agentscope-ai/CoPaw.git
cd CoPaw
pip install -e .
```
- **Dev** (tests, formatting): `pip install -e ".[dev]"`
- **Console** (build frontend): `cd console && npm ci && npm run build`, then `copaw app` from project root.
---
## Why CoPaw?
CoPaw represents both a **Co Personal Agent Workstation** and a "co-paw"βa partner always by your side. More than just a cold tool, CoPaw is a warm "little paw" always ready to lend a hand (or a paw!). It is the ultimate teammate for your digital life.
---
## Built by
[AgentScope team](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)
---
## Contact us
| [Discord](https://discord.gg/eYMpfnkG8h) | [DingTalk](https://qr.dingtalk.com/action/joingroup?code=v1,k1,OmDlBXpjW+I2vWjKDsjvI9dhcXjGZi3bQiojOq3dlDw=&_dt_no_comment=1&origin=11) |
| ------------------------------------------------------------ | ------------------------------------------------------------ |
| [<img src="https://gw.alicdn.com/imgextra/i1/O1CN01hhD1mu1Dd3BWVUvxN_!!6000000000238-2-tps-400-400.png" width="80" height="80" alt="Discord">](https://discord.gg/eYMpfnkG8h) | [<img src="https://img.alicdn.com/imgextra/i4/O1CN014mhqFq1ZlgNuYjxrz_!!6000000003235-2-tps-400-400.png" width="80" height="80" alt="DingTalk">](https://qr.dingtalk.com/action/joingroup?code=v1,k1,OmDlBXpjW+I2vWjKDsjvI9dhcXjGZi3bQiojOq3dlDw=&_dt_no_comment=1&origin=11) |
---
## License
CoPaw is released under the [Apache License 2.0](LICENSE).