# QuickBot

**Repository Path**: wangyanhai/QuickBot

## Basic Information

- **Project Name**: QuickBot
- **Description**: 开源的自进化智能体，可以写设计文档，写代码，写测试用例，执行测试用例，写测试报告。
- **Primary Language**: Unknown
- **License**: AGPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-02-03
- **Last Updated**: 2026-02-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Quick Bot - 通用自进化智能体

一个基于 TypeScript 的通用自进化智能体，具备自主思考、自我进化和智能执行的能力，支持智谱 GLM、通义千问、DeepSeek 等多种大模型。

## 功能特性

- 🤖 **通用智能体**：自主思考、自我进化、多模态交互
- 🧠 **自学习能力**：通过交互不断优化，适应新场景
- 🧩 **技能系统**：可扩展的插件式技能架构
- 📁 **文件操作**：支持读写、创建、删除文件
- 📝 **文档撰写**：自动生成 Markdown 格式文档
- 🔍 **代码分析**：理解、重构、优化代码
- 🐛 **代码调试**：定位和修复 bug
- 💬 **多轮对话**：支持上下文记忆
- 🎨 **彩色界面**：美观的命令行交互
- 📊 **日志记录**：所有交互记录到 `log/c.log`，超过 100MB 自动归档
- 🔧 **插件式技能**：通过斜杠命令执行自定义技能（Skills 系统）

## 安装

```bash
npm install
```

## 使用

### 首次运行（配置 API Key）

```bash
npm run dev
```

首次运行时，程序会引导你输入以下信息：
- **模型提供商**: 选择智谱 GLM、通义千问或 DeepSeek
- **API Key**: 你的 API Token
- **模型名称**: 根据提供商选择可用模型
- **API URL**: 默认使用官方接口地址

### 智能体使用示例

作为通用自进化智能体，你可以让它完成各种复杂任务：

```bash
# 分析代码
> 分析 src/index.ts 的代码结构

# 编写代码
> 用 Python 写一个快速排序算法

# 创建文件
> 创建一个 utils.ts 文件，包含一个格式化日期的函数

# 生成文档
> 为当前项目生成一个 README.md 文档

# 重构代码
> 重构 index.js，使其更符合最佳实践

# 调试代码
> 帮我找出这段代码的问题

# 多文件操作
> 创建一个 src 目录，在里面添加 app.js 和 utils.js 两个文件
```

AI 会自动理解你的意图，读取现有文件（如果需要），然后创建或修改文件。

### 命令

- `/exit` 或 `/quit` - 退出程序
- `/clear` - 清除聊天历史
- `/config` - 重新配置 API Key
- `/skills` - 查看所有可用技能
- `/skills <skill-name>` - 查看特定技能的详细帮助
- `/help` - 显示帮助信息

### 技能系统（Skills）

Quick Bot 支持插件式技能系统，通过斜杠命令执行各种功能：

#### 基础命令（Basic）
- `/ls [path]` - 列出目录文件
- `/cat <file-path>` - 查看文件内容

#### AI 增强（AI）
- `/explain <file-path>` - 使用 AI 解释代码

#### 工具类（Tools）
- `/json format <json-string>` - 格式化 JSON
- `/json validate <json-string>` - 验证 JSON
- `/json query <json-string> <path>` - 查询 JSON 数据

#### 示例

```bash
# 列出当前目录
> /ls

# 查看文件
> /cat package.json

# 解释代码
> /explain src/index.ts

# 格式化 JSON
> /json format '{"key":"value"}'

# 查询 JSON
> /json query '{"user":{"name":"John"}}' user.name
```

#### 自定义技能

你可以创建自己的技能来扩展 Quick Bot 的功能。详见 [技能开发指南](./skills/README.md)。

### 命令行参数

```bash
# 直接进入配置模式
npm run dev -- --config

# 或使用编译后的版本
npm run build
node dist/index.js --config
```

## 配置文件

配置保存在 `~/.quick-bot.json` 文件中，内容格式：

```json
{
  "apiKey": "your-api-key-here",
  "model": "glm-4",
  " apiUrl": "https://open.bigmodel.cn/api/paas/v4/chat/completions",
  "temperature": 0.7,
  "maxTokens": 2000
}
```

## 开发

```bash
# 开发模式（使用 tsx）
npm run dev

# 编译 TypeScript
npm run build

# 运行编译后的代码
node dist/index.js
```

## 项目结构

```
quick-bot/
├── src/
│   ├── index.ts         # 主入口
│   ├── config.ts        # 配置管理
│   ├── glm-client.ts    # GLM API 客户端
│   ├── chat-ui.ts       # 命令行界面
│   ├── file-manager.ts  # 文件操作管理
│   ├── log-manager.ts   # 日志管理
│   ├── skill-types.ts   # 技能类型定义
│   └── skill-manager.ts # 技能管理器
├── skills/             # 技能目录
│   ├── basic/          # 基础命令
│   │   ├── ls/
│   │   └── cat/
│   ├── ai/             # AI 增强
│   │   └── explain/
│   ├── tools/          # 工具类
│   │   └── json/
│   └── README.md       # 技能开发指南
├── log/                # 日志目录（自动创建）
│   ├── c.log           # 当前日志文件
│   └── c.*.log.gz      # 归档日志
├── package.json
├── tsconfig.json
└── README.md
```

## 日志功能

所有与大语言模型的交互都会记录到 `log/c.log` 文件中，包括：

- 用户发送的消息
- 助手的回复
- 系统提示

当日志文件超过 100MB 时，会自动压缩归档为 `.gz` 格式，文件名格式为 `c.YYYY-MM-DDTHH-mm-ss.log.gz`。

日志格式（每行一条 JSON）：
```json
{"timestamp":"2024-01-01T12:00:00.000Z","role":"user","content":"你好"}
{"timestamp":"2024-01-01T12:00:01.000Z","role":"assistant","content":"你好！有什么我可以帮助你的？"}
```

## 打包成独立可执行程序

### 安装打包工具

```bash
npm install
```

### 打包所有平台

```bash
npm run package
```

这会生成以下可执行文件到 `build/` 目录：
- `quick-bot-linux` - Linux 可执行文件
- `quick-bot.exe` - Windows 可执行文件
- `quick-bot-mac` - macOS 可执行文件

### 打包单个平台

```bash
# Linux
npm run package:linux

# Windows
npm run package:windows

# macOS
npm run package:mac
```

### 运行打包后的程序

打包后的程序不需要安装 Node.js，直接运行：

```bash
# Linux/macOS
./build/quick-bot

# Windows
build\quick-bot.exe
```

配置文件仍然保存在用户主目录的 `.quick-bot.json` 中。

> 💡 **打包遇到问题？** 参考 [PACKAGE.md](./PACKAGE.md) 获取详细的打包说明和故障排除指南。

## 获取 API Key

### 智谱 GLM
1. 访问 [智谱开放平台](https://open.bigmodel.cn/)
2. 注册/登录账号
3. 在控制台创建 API Key
4. 复制 API Key 到本程序配置

### 通义千问
1. 访问 [阿里云百炼平台](https://bailian.console.aliyun.com/)
2. 注册/登录账号
3. 在控制台创建 API Key
4. 复制 API Key 到本程序配置

### DeepSeek
1. 访问 [DeepSeek 开放平台](https://platform.deepseek.com/)
2. 注册/登录账号
3. 在控制台创建 API Key
4. 复制 API Key 到本程序配置