# iBot

**Repository Path**: aurora-engine/i-bot

## Basic Information

- **Project Name**: iBot
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2026-03-21
- **Last Updated**: 2026-03-31

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# i-bot

i-bot 是一个围绕 AI Agent 场景构建的多模块仓库，当前包含 Go 服务端、Electron 桌面客户端，以及独立维护的运维面板前端。根目录 README 主要用于做统一入口，帮助开发、测试和运维同学快速理解项目组成、启动方式，以及运维面板的使用方式。

## 仓库组成

| 目录 | 说明 |
| --- | --- |
| `bot-agent/` | Go 后端，负责 Agent 服务、MCP 集成、会话能力、监控探针，以及 `/dashboard` 面板 API 与静态资源嵌入。 |
| `bot-agent-desktop/app/` | Electron + Vue 桌面客户端，负责桌面端交互、主进程能力、预加载桥接与本地数据。 |
| `ibot-dashboard/` | 独立的 Vue 3 + TypeScript + Vite 运维面板项目，用于运行时监控、依赖巡检、会话管理和策略管理。 |
| `ibot-site/` | 独立的 Vue 3 + TypeScript + Vite 官网项目，用于对外展示 iBot 的产品定位、能力矩阵和方案说明。 |
| `scripts/`、`output/`、`snapshots/` | 根目录辅助脚本、构建输出与快照/临时产物目录。 |

## 适合从这里开始的场景

- 想快速了解项目由哪些模块组成。
- 想本地启动后端、桌面端、运维面板或官网项目。
- 想知道运维面板当前能做什么、该怎么访问。
- 想快速预览 iBot 对外产品页的当前表达方式。
- 想找到更细的子项目文档入口。

## 快速开始

### 依赖准备

建议本地具备以下基础环境：

- Go
- Node.js
- `pnpm`
- `make`

### 1. 启动 Go 服务端

首次或重新构建时：

```bash
cd bot-agent
make sandbox
```

构建完成后启动：

```bash
cd bot-agent
./scripts/run-server.sh sandbox
```

常用模式：

- `dev`：默认端口 `2080`
- `sandbox`：默认端口 `2081`
- `online`：默认端口 `2083`

也可以直接运行包产物：

```bash
cd bot-agent/output/server/bin
./server --active=sandbox
```

### 2. 启动桌面客户端

```bash
cd bot-agent-desktop/app
pnpm install
pnpm dev
```

常用校验命令：

```bash
cd bot-agent-desktop/app
pnpm lint
pnpm typecheck
pnpm test:run
```

### 3. 独立启动运维面板前端

```bash
cd ibot-dashboard
pnpm install
pnpm dev
```

默认情况下，Vite 会把 `/api/*` 代理到 `http://127.0.0.1:2080`。如果你的后端跑在其他地址，可以这样切换：

```bash
cd ibot-dashboard
IBOT_DASHBOARD_PROXY_TARGET=http://127.0.0.1:2081 pnpm dev
```

常用校验命令：

```bash
cd ibot-dashboard
pnpm typecheck
pnpm build
```

### 4. 独立启动官网项目

```bash
cd ibot-site
pnpm install
pnpm dev
```

常用校验命令：

```bash
cd ibot-site
pnpm typecheck
pnpm build
pnpm test:unit
```

## 运维面板使用说明

### 访问方式

运维面板有两种常见使用方式：

#### 方式一：通过后端内嵌访问

`bot-agent/scripts/build-server.sh` 会在构建后端时自动构建 `ibot-dashboard`，并把产物嵌入到后端的 `/dashboard/` 路由中。因此，只要服务端已经完成构建并启动，就可以直接访问：

- `http://127.0.0.1:2080/dashboard/`
- `http://127.0.0.1:2081/dashboard/`
- `http://127.0.0.1:2083/dashboard/`

实际访问哪个地址，取决于你启动的是 `dev`、`sandbox` 还是 `online`。

#### 方式二：以前端工程独立开发

如果你在做面板页面开发，直接运行 `ibot-dashboard` 即可。这样改动更快，接口仍然走本地后端代理，不需要每次都重新打包服务端。

### 当前已接入的能力

当前运维面板已经接入的真实能力主要包括：

- 首页与运行时监控：展示运行模式、环境、运行时指标、快照更新时间和巡检结论。
- 依赖巡检：查看 Redis、Qdrant 等依赖服务的状态、响应耗时和最近检查时间。
- 会话管理：只读展示客户端会话投影，支持按标题、会话 ID、工作空间、模式和绑定状态筛选。
- 终端命令策略：查看、创建、编辑、删除和批量删除命令策略规则，用于管理命令放行/拦截策略。
- 系统总览：汇总当前快照结论和面板定位说明，作为系统说明入口。

### 当前仍为占位页的内容

以下页面目前主要用于验证路由、菜单和面包屑链路，仍属于 mock/占位内容：

- GC 策略页
- 调度策略页
- 依赖详情页
- 操作日志
- 平台说明
- 事件回放

如果后续这些页面接入真实接口，建议优先更新本 README 和 `ibot-dashboard/README.md`。

### 使用注意事项

- 当前默认配置里，后端 `runtime.mode` 为 `client`，因此本地运行时通常可以直接访问 `/api/dashboard/*` 接口。
- 如果后续部署改成 `server` 运行形态，`/dashboard` 路由仍会保留，但交互式面板 API 不会开放，页面会显示不可用提示。
- 面板更适合本地开发、联调和轻量运维，不建议把它当作完整权限平台来理解；当前也没有接入登录、角色和按钮级权限控制。

## 官网项目使用说明

### 当前定位

`ibot-site/` 是独立维护的静态官网项目，用于对外说明 iBot 的产品价值、能力结构、典型场景与方案路径。当前版本特征：

- 首页 + 方案与能力页的双页结构。
- 中文内容，面向潜在客户或内部方案沟通。
- 主转化动作为“预约演示”，当前仅做前端交互占位，不接真实接口。
- 不嵌入后端构建链，也不依赖任何 API。

### 适用场景

- 需要快速补一个可展示的产品官网初版。
- 需要在客户沟通或内部汇报时统一描述 iBot 的产品定位。
- 需要为后续接入真实线索、案例和统一部署做前端基线。

## 常用开发命令

### 后端

```bash
cd bot-agent
make sandbox
./scripts/run-server.sh sandbox
./scripts/test.sh
```

或直接跑 Go 测试：

```bash
cd bot-agent/server
go test ./...
```

### 桌面端

```bash
cd bot-agent-desktop/app
pnpm dev
pnpm lint
pnpm typecheck
pnpm test:run
```

### 运维面板

```bash
cd ibot-dashboard
pnpm dev
pnpm typecheck
pnpm build
```

### 官网

```bash
cd ibot-site
pnpm dev
pnpm typecheck
pnpm build
pnpm test:unit
```

## 文档入口

如果你需要更细的模块说明，建议继续看这些文档：

- `bot-agent/README.md`
- `ibot-dashboard/README.md`
- `ibot-site/README.md`
- `bot-agent/AGENTS.md`
- `bot-agent-desktop/AGENTS.md`

## 配置与安全

- 不要把新的真实密钥、令牌或线上凭证直接提交到 `config-*.yaml`。
- `output/`、`.cache/`、运行时数据目录一般视为构建或运行产物，不建议手工维护。
- 如果你只修改某个子项目，优先遵循该目录下更近一级的 `AGENTS.md` 与 README 说明。