cat-fact-agent
Version:
Cat Fact Agent - 专业的猫知识 AI 代理
168 lines (120 loc) • 3.5 kB
Markdown
# 猫咪知识代理 (Cat Fact Agent)
一个基于 Mastra 框架的智能猫咪知识问答代理,使用智谱AI的GLM-4-Flash模型。
## 功能特性
- 🐱 专业的猫咪知识问答
- 🔍 自动获取真实猫咪知识
- 🌏 完全中文交互
- 🚀 支持命令行界面(CLI)
## 安装
### 本地开发安装
```bash
git clone <repository-url>
cd cat-fact-agent
npm install
```
### 全局安装 (推荐)
```bash
npm install -g cat-fact-agent
```
## CLI 使用说明
### 🚀 快速开始
安装完成后,你可以通过以下方式使用CLI:
```bash
# 随机获取一个猫咪知识
cat-agent
# 询问特定问题
cat-agent 猫咪为什么喜欢睡觉?
cat-agent 告诉我一个关于猫咪的有趣知识
cat-agent 猫咪的寿命有多长?
```
### 📋 使用示例
```bash
# 示例1: 随机猫咪知识
$ cat-agent
🐱 猫咪知识代理 CLI
⏳ 正在为你获取一个有趣的猫咪知识...
🔍 正在获取猫咪知识...
🐱 回答:
猫咪的胡须不仅仅是装饰,它们是非常敏感的触觉器官...
# 示例2: 特定问题
$ cat-agent 猫咪为什么喜欢睡觉?
🤔 问题: 猫咪为什么喜欢睡觉?
⏳ 正在思考中...
🐱 回答:
猫咪喜欢睡觉的原因有很多。首先,猫咪是夜行性动物...
```
### 🔧 本地开发使用方法
如果你在本地开发环境中:
```bash
# 方法1: 使用npm脚本
npm run cli # 随机获取猫咪知识
npm run cli -- 猫咪为什么喜欢睡觉? # 询问特定问题
# 方法2: 直接运行TypeScript文件
npx tsx src/cli.ts 告诉我一个关于猫咪的有趣知识
# 方法3: 构建后运行
npm run build
node dist/cli.js 猫咪的寿命有多长?
# 方法4: 本地全局安装测试
npm install -g . # 在本地项目目录安装
cat-agent # 测试CLI命令
```
### 💡 使用技巧
1. **无参数调用**: 直接运行 `cat-agent` 会随机返回一个有趣的猫咪知识
2. **带参数调用**: 添加问题作为参数,AI会针对性地回答
3. **中文交互**: 完全支持中文问题和回答
4. **实时知识**: 每次调用都会从权威API获取最新的猫咪知识
### 🎯 支持的问题类型
- 猫咪行为解释
- 猫咪健康知识
- 猫咪品种介绍
- 猫咪历史趣闻
- 猫咪科学知识
- 随机猫咪事实
## 开发
### 环境要求
- Node.js >= 18
- npm >= 8
### 开发命令
```bash
# 安装依赖
npm install
# 开发模式运行
npm run dev
# 构建项目
npm run build
# 运行CLI测试
npm run cli
npm run cli -- 测试问题
# 本地全局安装测试
npm install -g .
cat-agent 测试问题
# 发布到npm (需要npm登录)
npm publish
```
### 项目结构
```
cat-fact-agent/
├── src/
│ ├── cli.ts # CLI入口文件
│ └── mastra/
│ └── agents/
│ └── catAgent.ts # 猫咪代理核心逻辑
├── dist/ # 构建输出目录
├── package.json
└── README.md
```
## 📦 NPM 包信息
- **包名**: `cat-fact-agent`
- **版本**: `1.0.0`
- **作者**: vance
- **许可证**: MIT
- **NPM页面**: [https://www.npmjs.com/package/cat-fact-agent](https://www.npmjs.com/package/cat-fact-agent)
## 技术栈
- **Mastra**: AI代理框架
- **智谱AI GLM-4-Flash**: 大语言模型
- **TypeScript**: 开发语言
- **catfact.ninja API**: 猫咪知识数据源
## 🤝 贡献
欢迎提交 Issue 和 Pull Request!
## 📄 许可证
MIT