综合介绍
PeterCat 是一个专为GitHub社区维护者和开发者打造的智能答疑机器人解决方案。它提供对话式答疑 Agent 配置系统、自托管部署方案和便捷的一体化应用 SDK,让用户能够为自己的 GitHub 仓库一键创建智能答疑机器人,并快速集成到各类官网或项目中。PeterCat 的核心功能包括自动知识入库、多平台集成和高效的技术支持生态,旨在提升社区的技术支持效率。
功能列表
- 对话式答疑 Agent 配置系统:自动完成机器人配置,包括 Prompt、名字、头像、开场白等。
- 自托管部署方案:支持 AWS 和本地部署,确保数据安全和私密性。
- 一体化应用 SDK:便捷集成至官网或项目中,支持多种集成方式。
- 自动知识入库:将 GitHub 文档和 issue 自动入库,作为机器人的知识依据。
- 多平台集成:支持对话应用 SDK 集成至官网,GitHub APP 一键安装至 GitHub 仓库。
- 项目管理支持:支持项目查询、回复 Discussion、PR Summary、Code Review、Issue 管理等功能。
使用帮助
安装流程
- 自托管部署:
- 本地启动服务:
- 克隆 PeterCat 仓库到本地。
- 配置环境变量,确保所有必需的变量都已设置。
- 运行
docker-compose up
启动服务。
- 部署到 AWS:
- 配置 AWS 相关环境变量。
- 使用 AWS CLI 部署服务,确保所有资源正确配置。
- GitHub APP 安装:
- 在 GitHub 仓库中安装 PeterCat APP,授权访问相关仓库。
- 配置 APP 设置,确保正确连接到 PeterCat 服务。
使用指南
- 创建智能答疑机器人:
- 在 PeterCat 控制台中输入 GitHub 仓库地址或名称。
- 系统将自动生成机器人的配置,包括 Prompt、名字、头像等。
- 完成配置后,机器人将自动开始工作,处理相关的技术支持请求。
- 知识入库:
- 机器人创建后,所有相关的 GitHub 文档和 issue 将自动入库。
- 用户可以在控制台中查看和管理知识库内容,确保机器人回复的准确性和及时性。
- 多平台集成:
- 使用对话应用 SDK 将机器人集成至官网或项目中。
- 在 GitHub 仓库中安装 PeterCat APP,实现一键集成。
- 项目管理支持:
- 通过 PeterCat 控制台,用户可以查询项目状态、回复 Discussion、查看 PR Summary 和进行 Code Review。
- 支持 Issue 管理,包括查 Issue、提 Issue 和回 Issue。
详细操作流程
- 配置环境变量:
- 在
.env.local
文件中设置客户端环境变量,如NEXT_PUBLIC_API_DOMAIN
。 - 在
.env
文件中设置服务器环境变量,如API_URL
、WEB_URL
等。
- 在
- 启动服务:
- 运行
docker-compose up
启动本地服务。 - 确保所有服务正常运行,访问
http://localhost:3000
查看控制台。
- 运行
- 管理知识库:
- 在控制台中查看已入库的文档和 issue。
- 手动添加或更新知识库内容,确保机器人回复的准确性。
- 集成至官网:
- 使用对话应用 SDK,将机器人集成至官网或项目中。
- 配置 SDK 设置,确保正确连接到 PeterCat 服务。