# localBot

**Repository Path**: ereddate2017/local-bot

## Basic Information

- **Project Name**: localBot
- **Description**: LocalBot 是一个开源的功能完整的AI智能助手系统，提供Web界面、多模型支持、会话管理、工具调用、长记忆、联网搜索等核心功能。
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 1
- **Created**: 2026-02-17
- **Last Updated**: 2026-03-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# LocalBot

一个强大的本地 AI 助手，支持多语言工具扩展和 Web 界面。

## 快速开始

### 前置要求

- Node.js 18+ 
- Python 3.7+
- npm

### 安装方式

#### 方式一：自动安装（推荐）

**Windows 用户：**
```bash
# 1. 双击运行安装脚本
install-python-deps.bat

# 2. 启动服务
npm start
```

**Linux/Mac 用户：**
```bash
# 1. 运行安装脚本
chmod +x install.sh
./install.sh

# 2. 启动服务
./start.sh
```

#### 方式二：Docker 部署（推荐用于生产环境）

```bash
# 1. 使用 Docker Compose
docker-compose up -d

# 2. 查看日志
docker-compose logs -f

# 3. 停止服务
docker-compose down
```

#### 方式三：手动安装

**1. 安装 Node.js 依赖**
```bash
npm install
```

**2. 安装 Python 工具依赖**

**Windows 用户：**
双击运行 `install-python-deps.bat` 脚本

**手动安装：**
```bash
pip install -r tools/requirements.txt
```

**使用国内镜像源（推荐）：**
```bash
pip install -r tools/requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple
```

**3. 配置环境变量**

复制 `.env.example` 为 `.env` 并配置必要的参数：

```bash
cp .env.example .env
```

**4. 启动服务**

```bash
npm start
```

服务将在 http://localhost:18789 启动

## Docker 部署

### 使用 Docker Compose（推荐）

```bash
# 构建并启动
docker-compose up -d

# 查看日志
docker-compose logs -f localbot

# 停止服务
docker-compose down

# 重新构建
docker-compose up -d --build
```

### 使用 Docker 命令

```bash
# 构建镜像
docker build -t localbot .

# 运行容器
docker run -d \
  --name localbot \
  -p 18789:18789 \
  -v $(pwd)/data:/app/data \
  -v $(pwd)/uploads:/app/uploads \
  localbot

# 查看日志
docker logs -f localbot

# 停止容器
docker stop localbot
```

### 数据持久化

Docker Compose 默认配置了以下卷：
- `localbot-data` - 应用数据
- `localbot-uploads` - 上传文件
- `localbot-memory` - 记忆数据
- `localbot-logs` - 日志文件

### 健康检查

容器包含健康检查，每 30 秒检查一次：
```bash
# 查看健康状态
docker inspect --format='{{.State.Health.Status}}' localbot
```

## 可用工具

### 文档处理
- **markdown-generator**: Markdown 文档生成工具
- **summarize**: 文本摘要工具

### 数据管理
- **database**: 数据库操作工具，支持 SQLite
- **archive**: 压缩包操作工具，支持多种格式

### 通信
- **email**: 邮件操作工具，支持发送和接收邮件

### 其他
- **calculator**: 计算器工具

## Web 界面

启动服务后，在浏览器中打开：
- Web 界面: http://localhost:18789
- WebSocket: ws://localhost:18789

## 开发

### 添加新工具

1. 在 `tools/external/` 目录下创建工具文件
2. 创建对应的 `.json` 配置文件
3. 重启服务自动加载

### 工具开发规范

工具必须实现以下接口：

```python
def execute(operation, params):
    """
    执行工具操作
    - operation: 操作类型
    - params: 参数字典
    返回: {"success": bool, "data": any, "error": str}
    """
```

## 故障排除

### Python 依赖安装失败

1. 检查 Python 版本：`python --version`
2. 检查 pip 是否可用：`python -m pip --version`
3. 使用国内镜像源安装
4. 手动安装：`pip install Pillow numpy requests`

### 工具执行失败

1. 检查 Python 环境是否正确配置
2. 查看终端日志获取详细错误信息
3. 确认工具文件路径正确

## 许可证

MIT License