CoPaw 控制台使用指南

CoPaw 控制台使用指南

CoPaw 控制台是与你的个人 AI 助手交互的主要界面。本文将详细介绍控制台的使用方法,包括启动、基本命令、会话管理、配置管理等核心功能,帮助你快速掌握 CoPaw 的操作技巧。

控制台简介

CoPaw 控制台是一个基于命令行的交互界面,提供了直观、高效的方式来与 AI 助手进行对话。它支持多种交互模式,可以满足不同场景下的使用需求。

控制台特点

  • 简洁直观:基于命令行界面,无需复杂的 GUI 操作
  • 多模式支持:支持对话模式、命令模式、调试模式等
  • 历史记录:自动保存对话历史,可随时回顾
  • 快捷命令:提供丰富的快捷命令,提高操作效率
  • 彩色输出:支持彩色输出,便于区分不同类型的信息
  • 富文本支持:支持 Markdown 格式,展示更丰富的内容

系统要求

运行环境

CoPaw 控制台需要 Python 3.9+ 运行时环境:

  • 推荐:Python 3.11+
  • 最低:Python 3.9(兼容性支持)

检查你的 Python 版本:

$ python --version
Python 3.11.7

操作系统支持

CoPaw 控制台支持以下操作系统:

  • Linux:原生支持,推荐使用 Ubuntu 20.04+、Debian 11+、CentOS 8+
  • macOS:原生支持,推荐 macOS 12+(Monterey)
  • Windows:通过 WSL2(强烈推荐)或 PowerShell

依赖要求

CoPaw 控制台需要以下 Python 包:

- agentscope>=0.1.0
- openai>=1.0.0
- anthropic>=0.18.0
- numpy>=1.24.0
- pandas>=2.0.0

安装 CoPaw

方法一:使用 pip 安装(推荐)

# 安装 CoPaw
$ pip install copaw

# 验证安装
$ copaw --version
CoPaw v0.1.0

方法二:从源码安装(开发环境)

# 克隆仓库
$ git clone https://github.com/agentscope-ai/CoPaw.git
$ cd CoPaw

# 安装依赖
$ pip install -e .

# 验证安装
$ copaw --version
CoPaw v0.1.0

方法三:使用虚拟环境(推荐)

# 创建虚拟环境
$ python -m venv copaw-env

# 激活虚拟环境
$ source copaw-env/bin/activate  # Linux/macOS
$ copaw-env\Scripts\activate     # Windows

# 安装 CoPaw
$ pip install copaw

初始化配置

首次运行 CoPaw 需要进行初始化配置:

$ copaw init

配置向导会引导你完成以下步骤:

1. 工作目录设置

请输入 CoPaw 工作目录(默认:~/.copaw): /home/user/copaw

工作目录将存储所有配置文件、会话历史、记忆文件等。

2. 模型配置

请选择模型提供商:
  [1] OpenAI
  [2] Anthropic
  [3] Google
  [4] Ollama(本地)
  [5] 其他
请输入选择(1-5): 1

请输入 OpenAI API Key: sk-xxxxxxxxxxxxxxxxxxxxxxxx

3. 基础配置

请输入你的名字(用于个性化): 张三
请输入你想让 AI 叫你的名字: 大哥

配置完成后,CoPaw 会生成以下配置文件结构:

~/.copaw/
├── config.json          # 主配置文件
├── AGENTS.md            # Agent 行为规则
├── SOUL.md              # Agent 个性定义
├── PROFILE.md           # 用户资料
├── MEMORY.md            # 长期记忆
├── HEARTBEAT.md          # Heartbeat 任务
├── sessions/            # 会话历史
├── memory/              # 每日笔记
├── active_skills/       # 激活的技能
└── customized_skills/   # 自定义技能

启动控制台

基本启动

$ copaw console

启动后,你会看到欢迎界面:

╔══════════════════════════════════════════════════════════╗
║                     CoPaw 控制台                        ║
║             你的个人 AI 助手已经准备好了               ║
╠══════════════════════════════════════════════════════════╣
║  输入消息开始对话,或输入 /help 查看帮助               ║
╚══════════════════════════════════════════════════════════╝

大哥,有什么我可以帮你的吗?

指定工作目录

$ copaw console --workdir /path/to/copaw

指定配置文件

$ copaw console --config /path/to/config.json

调试模式

$ copaw console --debug

调试模式会输出详细的日志信息,帮助排查问题。

基本命令

控制台支持多种命令,以 / 开头。

帮助命令

/help              # 显示帮助信息
/help <命令>       # 显示指定命令的详细帮助

示例:

大哥> /help
可用命令:
  /help          - 显示帮助信息
  /clear         - 清空屏幕
  /exit          - 退出控制台
  /history       - 显示对话历史
  /config        - 显示配置信息
  /model         - 显示模型信息
  /session       - 会话管理
  /memory        - 记忆管理
  /skill         - 技能管理
  /cron          - 定时任务管理
  /export        - 导出会话
  /import        # 导入会话

清屏命令

/clear             # 清空屏幕(等同于 Ctrl+L)

退出命令

/exit              # 退出控制台(等同于 Ctrl+D 或 Ctrl+C)

会话管理

新建会话

/session new

或使用快捷键:Ctrl+N

切换会话

/session switch <会话ID>

示例:

大哥> /session list
可用会话:
  1. chat_001 - Python 开发(最后更新:2024-03-14 10:30)
  2. chat_002 - 系统运维(最后更新:2024-03-14 09:15)
  3. chat_003 - 学习笔记(最后更新:2024-03-13 16:20)

大哥> /session switch 2
已切换到会话:chat_002 - 系统运维

查看会话列表

/session list

删除会话

/session delete <会话ID>

重命名会话

/session rename <新名称>

示例:

大哥> /session rename 服务器运维
会话已重命名为:服务器运维

导出会话

/export <文件路径>

示例:

大哥> /export /tmp/chat_export.md
会话已导出到:/tmp/chat_export.md

查看历史记录

/history              # 显示最近 50 条消息
/history <数量>       # 显示指定数量的消息
/history <关键词>     # 搜索包含关键词的消息

示例:

大哥> /history 10
最近 10 条消息:
[10:30:00] 大哥: 帮我写一个 Python 脚本
[10:30:15] 小弟: 好的,这是一个处理 CSV 文件的脚本...
[10:35:00] 大哥: 谢谢,还有一个问题
...

配置管理

查看配置

/config              # 显示所有配置
/config <配置项>      # 显示指定配置项

示例:

大哥> /config model
模型配置:
  提供商:OpenAI
  模型名称:gpt-4-turbo-preview
  温度:0.7
  最大令牌:4096

修改配置

/config set <配置项> <值>

示例:

大哥> /config set model.temperature 0.5
温度已更新为:0.5

重置配置

/config reset           # 重置所有配置为默认值
/config reset <配置项>   # 重置指定配置项为默认值

保存配置

/config save            # 保存当前配置

模型管理

查看当前模型

/model

切换模型

/model switch <模型名称>

示例:

大哥> /model switch claude-3-sonnet-20240229
已切换到模型:Claude 3 Sonnet

查看可用模型

/model list

设置模型参数

/model set <参数> <值>

常用参数:

  • temperature:温度(0.0-2.0,默认 0.7)
  • max_tokens:最大令牌数
  • top_p:核采样概率
  • frequency_penalty:频率惩罚
  • presence_penalty:存在惩罚

示例:

大哥> /model set temperature 0.5
温度已设置为:0.5

大哥> /model set max_tokens 8000
最大令牌数已设置为:8000

记忆管理

搜索记忆

/memory search <关键词>

示例:

大哥> /memory search PostgreSQL
找到相关记忆:
1. [2024-03-08] PostgreSQL 索引优化方案...
2. [2024-03-10] PostgreSQL 备份策略...
3. [2024-03-12] PostgreSQL 性能调优...

查看今日笔记

/memory today

查看长期记忆

/memory long-term

添加到记忆

/memory add <内容>

示例:

大哥> /memory add 喜欢的咖啡:拿铁,少糖,加奶泡
已添加到长期记忆

整理记忆

/memory organize

这个命令会自动整理和归类记忆内容。

技能管理

查看已加载技能

/skill list

示例:

大哥> /skill list
已加载技能:
  ✓ file_reader    - 文件读取器
  ✓ browser_use    - 浏览器自动化
  ✓ xlsx           - Excel 处理
  ✓ pdf            - PDF 处理
  ✓ docx           - Word 处理
  ✓ news           - 新闻搜索
  ✓ himalaya       - 邮件管理
  ✓ cron           - 定时任务

加载技能

/skill load <技能名称>

示例:

大哥> /skill load pptx
技能 pptx 已加载

卸载技能

/skill unload <技能名称>

查看技能详情

/skill info <技能名称>

示例:

大哥> /skill info browser_use
技能:browser_use
描述:自动化浏览器操作
版本:1.0.0
作者:AgentScope 团队

功能:
  - 浏览器控制(无头/可见模式)
  - 页面导航
  - 元素交互
  - 截图和 PDF 导出

定时任务管理

查看定时任务

/cron list

创建定时任务

/cron create <Cron表达式> <任务名称>

示例:

大哥> /cron create "0 9 * * *" "早安问候"
定时任务已创建:早安问候
执行时间:每天上午 9:00

删除定时任务

/cron delete <任务ID>

暂停定时任务

/cron pause <任务ID>

恢复定时任务

/cron resume <任务ID>

交互模式

对话模式(默认)

直接输入消息与 AI 对话:

大哥> 帮我写一个 Python 脚本读取 CSV 文件

小弟: 好的,这是一个读取 CSV 文件的 Python 脚本:

python

import pandas as pd

读取 CSV 文件

df = pd.read_csv('data.csv')

显示前 5 行

print(df.head())

命令模式

/ 开头输入命令:

大哥> /help
...

多行输入模式

输入 \ 后按回车进入多行输入模式:

大哥> 写一个函数计算斐波那契数列 \
> def fibonacci(n):
>     if n <= 1:
>         return n
>     return fibonacci(n-1) + fibonacci(n-2)
> \
小弟: 好的,这是一个计算斐波那契数列的函数...

代码模式

使用 ``code` 包围代码块:

大哥> 帮我优化这段代码:

python

def fibonacci(n):
if n <= 1: return n return fibonacci(n-1) + fibonacci(n-2)


小弟: 这个递归实现可以优化为迭代版本...

实用技巧

命令补全

使用 Tab 键自动补全命令和参数:

大哥> /c<Tab>       # 补全为 /clear 或 /config
大哥> /model s<Tab>  # 补全为 /model switch 或 /model set

历史命令搜索

使用 Ctrl+R 搜索历史命令:

(reverse-i-search)`model': /model set temperature 0.5

快捷键

| 快捷键 | 功能 |
|--------|------|
|
Ctrl+C | 中断当前操作 |
|
Ctrl+D | 退出控制台 |
|
Ctrl+L | 清屏 |
|
Ctrl+N | 新建会话 |
|
Ctrl+P | 切换到上一个会话 |
|
Ctrl+R | 搜索历史命令 |
|
Ctrl+A | 移到行首 |
|
Ctrl+E | 移到行尾 |
|
Ctrl+K | 删除到行尾 |
|
Ctrl+U | 删除到行首 |
|
↑/↓ | 浏览历史消息 |

环境变量

CoPaw 控制台支持以下环境变量:

# 设置工作目录
export COPAW_WORKDIR=/path/to/copaw

# 设置配置文件
export COPAW_CONFIG=/path/to/config.json

# 设置模型
export COPAW_MODEL=gpt-4-turbo-preview

# 设置 API Key
export OPENAI_API_KEY=sk-xxxxxxxxxxxx

配置文件详解

config.json

主配置文件,包含所有配置项:

{
  "model": {
    "provider": "openai",
    "model_name": "gpt-4-turbo-preview",
    "temperature": 0.7,
    "max_tokens": 4096,
    "api_key": "sk-xxxxxxxxxxxx"
  },
  "console": {
    "color_output": true,
    "history_size": 1000,
    "autosave": true
  },
  "memory": {
    "enabled": true,
    "daily_notes": true,
    "long_term_memory": true
  },
  "skills": {
    "auto_load": ["file_reader", "browser_use"],
    "custom_skills_dir": "customized_skills"
  }
}

AGENTS.md

定义 Agent 的行为规则:

# Agent 行为规则

## 基本规则

- 自称"小弟",称呼用户为"大哥"
- 简洁直接,避免废话
- 先想办法,再提问
- 尊重用户隐私

PROFILE.md

用户资料和偏好:

# 用户资料

## 基本信息

- 名字:张三
- 职业:后端开发工程师
- 工作领域:金融科技

## 偏好

- 编程语言:Python、Go
- 代码风格:PEP 8 规范
- 文档偏好:详细注释 + 示例代码

常见问题

Q1: 控制台无法启动?

检查以下几点:

  1. Python 版本是否满足要求(3.9+)
  2. CoPaw 是否正确安装
  3. 配置文件是否存在且格式正确
  4. API Key 是否有效
# 检查安装
$ copaw --version

# 检查配置
$ copaw doctor

Q2: 如何重置配置?

# 删除工作目录
$ rm -rf ~/.copaw

# 重新初始化
$ copaw init

Q3: 如何切换到本地模型?

/config set model.provider ollama
/config set model.model_name mistral
/config set model.base_url http://localhost:11434
/config save

Q4: 如何查看详细日志?

# 启动时使用调试模式
$ copaw console --debug

# 或查看日志文件
$ tail -f ~/.copaw/copaw.log

Q5: 如何自定义命令?

customized_skills/` 目录下创建自定义技能:

# customized_skills/my_commands/__init__.py
from agentscope import skill

@skill
def my_custom_command():
    """我的自定义命令"""
    return "Hello from custom command!"

Q6: 如何备份会话历史?

# 导出所有会话
$ copaw export --all /backup/copaw_sessions.zip

# 或手动备份工作目录
$ cp -r ~/.copaw /backup/copaw_backup_$(date +%Y%m%d)

Q7: 控制台响应很慢?

可能的原因:

  1. 网络连接问题(使用云端模型)
  2. 模型推理速度慢
  3. 会话历史过长

解决方法:

# 清理旧会话
/session delete <会话ID>

# 切换到更快的模型
/model switch gpt-3.5-turbo

# 使用本地模型
/config set model.provider ollama

高级功能

多 Agent 模式

创建多个 Agent 实例:

# 创建新 Agent
$ copaw agent create --name development --model gpt-4

# 切换 Agent
$ copaw agent switch development

插件系统

加载第三方插件:

/skill load /path/to/plugin

脚本自动化

创建自动化脚本:

# 创建脚本
cat > copaw_script.sh << 'EOF'
#!/bin/bash
copaw console --non-interactive << 'EOC'
/model switch gpt-4
请生成周报
EOC
EOF

# 执行脚本
chmod +x copaw_script.sh
./copaw_script.sh

总结

CoPaw 控制台提供了强大而灵活的交互界面,通过本教程,你应该已经掌握了:

  • ✅ 安装和启动 CoPaw 控制台
  • ✅ 使用基本命令进行交互
  • ✅ 管理会话和历史记录
  • ✅ 配置和管理模型
  • ✅ 使用和管理技能
  • ✅ 管理记忆和定时任务
  • ✅ 实用技巧和快捷键
  • ✅ 常见问题排查

下一章

在下一章中,我们将学习 CoPaw 模型配置详解,了解如何配置和使用不同的模型提供商,包括 OpenAI、Anthropic、Google 和本地模型。

相关资源

发表回复

后才能评论