# CoPaw **Repository Path**: lance521/CoPaw ## Basic Information - **Project Name**: CoPaw - **Description**: 你的AI个人助理；安装极简、本地与云上均可部署；支持多端接入、能力轻松扩展。 核心能力： 全域触达 — 钉钉、飞书、QQ、Discord、iMessage 等频道，一个 CoPaw 按需连接。 由你掌控 — 记忆与个性化由你掌控，本地或云端均可；定时与协作发往指定频道。 Skills 扩展 — 内置定时任务，自定义技能目录，CoPaw 自动加载，无绑定。 你可以用 CoPaw 做什么 - **Primary Language**: Unknown - **License**: Apache-2.0 - **Default Branch**: main - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 2 - **Forks**: 1 - **Created**: 2026-03-01 - **Last Updated**: 2026-03-03 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README
# CoPaw [![GitHub Repo](https://img.shields.io/badge/GitHub-Repo-black.svg?logo=github)](https://github.com/agentscope-ai/CoPaw) [![PyPI](https://img.shields.io/pypi/v/copaw?color=3775A9&label=PyPI&logo=pypi)](https://pypi.org/project/copaw/) [![Documentation](https://img.shields.io/badge/Docs-Website-green.svg?logo=readthedocs&label=Docs)](https://copaw.agentscope.io/) [![Python Version](https://img.shields.io/badge/python-3.10%20~%20%3C3.14-blue.svg?logo=python&label=Python)](https://www.python.org/downloads/) [![Last Commit](https://img.shields.io/github/last-commit/agentscope-ai/CoPaw)](https://github.com/agentscope-ai/CoPaw) [![License](https://img.shields.io/badge/license-Apache%202.0-red.svg?logo=apache&label=License)](LICENSE) [![Code Style](https://img.shields.io/badge/code%20style-black-black.svg?logo=python&label=CodeStyle)](https://github.com/psf/black) [![GitHub Stars](https://img.shields.io/github/stars/agentscope-ai/CoPaw?style=flat&logo=github&color=yellow&label=Stars)](https://github.com/agentscope-ai/CoPaw/stargazers) [![GitHub Forks](https://img.shields.io/github/forks/agentscope-ai/CoPaw?style=flat&logo=github&color=purple&label=Forks)](https://github.com/agentscope-ai/CoPaw/network) [![DeepWiki](https://img.shields.io/badge/DeepWiki-Ask_Devin-navy.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACwAAAAyCAYAAAAnWDnqAAAAAXNSR0IArs4c6QAAA05JREFUaEPtmUtyEzEQhtWTQyQLHNak2AB7ZnyXZMEjXMGeK/AIi+QuHrMnbChYY7MIh8g01fJoopFb0uhhEqqcbWTp06/uv1saEDv4O3n3dV60RfP947Mm9/SQc0ICFQgzfc4CYZoTPAswgSJCCUJUnAAoRHOAUOcATwbmVLWdGoH//PB8mnKqScAhsD0kYP3j/Yt5LPQe2KvcXmGvRHcDnpxfL2zOYJ1mFwrryWTz0advv1Ut4CJgf5uhDuDj5eUcAUoahrdY/56ebRWeraTjMt/00Sh3UDtjgHtQNHwcRGOC98BJEAEymycmYcWwOprTgcB6VZ5JK5TAJ+fXGLBm3FDAmn6oPPjR4rKCAoJCal2eAiQp2x0vxTPB3ALO2CRkwmDy5WohzBDwSEFKRwPbknEggCPB/imwrycgxX2NzoMCHhPkDwqYMr9tRcP5qNrMZHkVnOjRMWwLCcr8ohBVb1OMjxLwGCvjTikrsBOiA6fNyCrm8V1rP93iVPpwaE+gO0SsWmPiXB+jikdf6SizrT5qKasx5j8ABbHpFTx+vFXp9EnYQmLx02h1QTTrl6eDqxLnGjporxl3NL3agEvXdT0WmEost648sQOYAeJS9Q7bfUVoMGnjo4AZdUMQku50McDcMWcBPvr0SzbTAFDfvJqwLzgxwATnCgnp4wDl6Aa+Ax283gghmj+vj7feE2KBBRMW3FzOpLOADl0Isb5587h/U4gGvkt5v60Z1VLG8BhYjbzRwyQZemwAd6cCR5/XFWLYZRIMpX39AR0tjaGGiGzLVyhse5C9RKC6ai42ppWPKiBagOvaYk8lO7DajerabOZP46Lby5wKjw1HCRx7p9sVMOWGzb/vA1hwiWc6jm3MvQDTogQkiqIhJV0nBQBTU+3okKCFDy9WwferkHjtxib7t3xIUQtHxnIwtx4mpg26/HfwVNVDb4oI9RHmx5WGelRVlrtiw43zboCLaxv46AZeB3IlTkwouebTr1y2NjSpHz68WNFjHvupy3q8TFn3Hos2IAk4Ju5dCo8B3wP7VPr/FGaKiG+T+v+TQqIrOqMTL1VdWV1DdmcbO8KXBz6esmYWYKPwDL5b5FA1a0hwapHiom0r/cKaoqr+27/XcrS5UwSMbQAAAABJRU5ErkJggg==)](https://deepwiki.com/agentscope-ai/CoPaw) [![Discord](https://img.shields.io/badge/Discord-Join_Us-blueviolet.svg?logo=discord)](https://discord.gg/eYMpfnkG8h) [![DingTalk](https://img.shields.io/badge/DingTalk-Join_Us-orange.svg)](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)]

CoPaw Logo

Works for you, grows with you.

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. > >
> What you can do > >
> > - **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. > >
--- ## 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). ![Console](https://img.alicdn.com/imgextra/i4/O1CN01iuGyNc1mNwsUU5NQI_!!6000000004943-2-tps-3822-2070.png) ### 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 ```
Install options **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 ```
### 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) | | ------------------------------------------------------------ | ------------------------------------------------------------ | | [Discord](https://discord.gg/eYMpfnkG8h) | [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).