Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 47 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ The rapid growth of biomedical data, tools, and literature has created a fragmen
- **Structural Biology** — Fetch and render 3D protein structures from PDB with PyMOL
- **Data Visualization** — Create volcano plots, heatmaps, and expression figures from CSV data
- **Literature Search** — Query PubMed for recent papers with structured summaries
- **Image-based Wet-Lab Interpretation** — Analyze gel/blot photos captured from camera or uploaded in chat (e.g., SDS-PAGE lane quality and target-band checks)
- **Workspace Management** — Triage files, recommend analysis steps, and manage shared group workspaces

Results — including images, plots, and structured reports — are delivered directly back to the chat.
Expand Down Expand Up @@ -159,7 +160,44 @@ In any connected chat, simply message:

## Messaging channels

Supported platforms include **WhatsApp** (default), **QQ Official Bot**, **Feishu (Lark)**, **WeCom**, **Discord**, **Slack** (Socket Mode), **WeChat Personal** (experimental), and optional **local web** (browser) chat. Full setup steps, env vars, and disabling channels are in **[docs/CHANNELS.md](docs/CHANNELS.md)** (简体中文:[docs/CHANNELS.zh-CN.md](docs/CHANNELS.zh-CN.md)).
Supported platforms include **WhatsApp** (default), **Feishu (Lark)**, **WeCom**, **Discord**, **Slack** (Socket Mode), **WeChat** (fully supported), **QQ** and optional **local web** (browser) chat. Full setup steps, env vars, and disabling channels are in **[docs/CHANNELS.md](docs/CHANNELS.md)** (简体中文:[docs/CHANNELS.zh-CN.md](docs/CHANNELS.zh-CN.md)).


### WhatsApp Integration Example
> BioClaw supports WhatsApp group workflows for conversational task requests and in-chat delivery of analysis results.

<img src="ExampleTask/1.jpg" width="300" />

### Feishu (Lark) Integration Example
> BioClaw also supports Feishu/Lark conversations for interactive task requests and result delivery in chat.

<img src="docs/images/feishu/feishu-bioclaw.jpg" width="300" />

### WeCom Integration Example
> BioClaw also supports WeCom conversations for team collaboration and in-chat analysis result delivery.

<img src="docs/images/wecom/wecom-bioclaw.jpg" width="300" />

### Discord Integration Example
> BioClaw supports Discord channel workflows. Screenshot example will be added in a future update.

### Slack (Socket Mode) Integration Example
> BioClaw supports Slack (Socket Mode) workflows. Screenshot example will be added in a future update.

### WeChat Integration Example
> BioClaw supports one-click WeChat onboarding and in-chat file handoff workflows (send docs/images, then continue analysis in the same thread).

<img src="docs/images/weixin/weixin-bioclaw.jpg" width="300" />

### QQ Integration Example
> BioClaw also supports QQ-based conversations for task requests and chat-native result delivery.

<img src="docs/images/qq/qq-deepseek-1.jpg" width="300" />

### Local Web UI (Dashboard) Example
> The local web channel includes both chat and the built-in dashboard (Lab trace) for timeline observability.

<img src="docs/images/dashboard/UI-bioclaw.jpg" width="1000" />

**Lab trace** (SSE timeline, workspace tree) is built into the local web UI — no extra config needed. See **[docs/DASHBOARD.md](docs/DASHBOARD.md)**.

Expand All @@ -175,7 +213,7 @@ See the [ExampleTask](ExampleTask/ExampleTask.md) document for 6 ready-to-use de

## Demo Examples

Below are live demonstrations of BioClaw handling real bioinformatics tasks via WhatsApp.
Below are live demonstrations of BioClaw handling real bioinformatics tasks across mainstream channels (WhatsApp, QQ, WeCom, WeChat, Feishu/Lark, and local web UI).

### 1. Workspace Triage & Next Steps
> Analyze files in a shared workspace and recommend the best next analysis steps.
Expand Down Expand Up @@ -245,6 +283,13 @@ Below are live demonstrations of BioClaw handling real bioinformatics tasks via

---

### 9. SDS-PAGE Gel Photo Review (WhatsApp Camera/Upload)
> Capture or upload a gel image in WhatsApp, then ask BioClaw to assess lane quality and whether major bands match expected targets.

<img src="docs/images/whatsapp-凝胶.jpg" width="420" />

---

## System Architecture

BioClaw is built on the [NanoClaw](https://github.com/qwibitai/nanoclaw) container-based agent architecture, extended with biomedical tools and domain knowledge from the [STELLA](https://github.com/zaixizhang/STELLA) framework.
Expand Down
60 changes: 58 additions & 2 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,9 @@ BioClaw 将常见的生物信息学任务带到聊天界面中。研究者可以
- 测序数据质控(FastQC / MultiQC)
- 差异分析可视化(火山图等)
- 文献检索与摘要
- 基于图片的湿实验结果解读(支持 WhatsApp 拍照或上传图片,如 SDS-PAGE 条带质量与目标条带匹配判断)

默认通道为 WhatsApp;QQ 官方 Bot、飞书、企业微信、Discord、Slack、本地网页等配置见 **[docs/CHANNELS.zh-CN.md](docs/CHANNELS.zh-CN.md)**。飞书的完整配置、OpenRouter 设置、群聊限制与排障见 **[docs/FEISHU_SETUP.zh-CN.md](docs/FEISHU_SETUP.zh-CN.md)**QQ 的完整步骤与排障见 **[docs/QQ_SETUP.zh-CN.md](docs/QQ_SETUP.zh-CN.md)**
默认通道为 WhatsApp;飞书、企业微信、Discord、Slack、微信(已全面支持)、本地网页等配置见 **[docs/CHANNELS.zh-CN.md](docs/CHANNELS.zh-CN.md)**。飞书的完整配置、OpenRouter 设置、群聊限制与排障见 **[docs/FEISHU_SETUP.zh-CN.md](docs/FEISHU_SETUP.zh-CN.md)**QQ 相关截图仍为路线图示意,详见该文档

## 快速开始

Expand Down Expand Up @@ -129,6 +130,53 @@ npm run dev

各平台逐步配置、环境变量、本地网页与 **Windows(WSL2)** 说明见 **[docs/CHANNELS.zh-CN.md](docs/CHANNELS.zh-CN.md)**;其中 Windows 细节补充在 **[docs/WINDOWS.zh-CN.md](docs/WINDOWS.zh-CN.md)**。需要**本地浏览器(对话与实验追踪同一页)**时,在项目根目录执行 **`npm run web`** 即可(仍会读取 `.env`)。

目前已支持 WhatsApp、飞书、企业微信、Discord、Slack、微信(已全面支持)、QQ、本地网页通道 等渠道。


### WhatsApp 接入示例

BioClaw 支持在 WhatsApp 群聊中进行对话式任务请求,并在群内返回分析结果。

<img src="ExampleTask/1.jpg" width="300" />

### 飞书接入示例

BioClaw 同样支持在飞书/Lark 中对话式发起任务,并在会话内接收分析结果与反馈。

<img src="docs/images/feishu/feishu-bioclaw.jpg" width="300" />

### 企业微信接入示例

BioClaw 也支持在企业微信中进行团队对话式任务请求,并在聊天内返回分析结果。

<img src="docs/images/wecom/wecom-bioclaw.jpg" width="300" />

### Discord 接入示例

BioClaw 支持 Discord 渠道对话流程。截图示例将在后续版本补充。

### Slack(Socket Mode)接入示例

BioClaw 支持 Slack(Socket Mode)渠道流程。截图示例将在后续版本补充。

### 微信接入示例

BioClaw 支持微信一键接入,并可在会话内进行文件传递与后续分析联动(发送文档/图片后继续在同一线程分析)。

<img src="docs/images/weixin/weixin-bioclaw.jpg" width="300" />

### QQ 接入示例

BioClaw 也支持在 QQ 中进行对话式任务请求,并在聊天内返回分析结果。

<img src="docs/images/qq/qq-deepseek-1.jpg" width="300" />

### 本地 Web UI(Dashboard)示例

本地网页通道同时包含聊天界面与内置的 dashboard(Lab trace)运行观测视图。

<img src="docs/images/dashboard/UI-bioclaw.jpg" width="1000" />

英文版通道文档:[docs/CHANNELS.md](docs/CHANNELS.md)。

**Lab trace 观测**(SSE 时间线、工作区树)已内置于本地网页界面,无需额外配置。说明见 [docs/DASHBOARD.md](docs/DASHBOARD.md)。
Expand All @@ -143,7 +191,15 @@ install https://github.com/Runchuan-BU/BioClaw

## 示例演示

QQ / 飞书路线图示意截图已移至 [docs/CHANNELS.zh-CN.md](docs/CHANNELS.zh-CN.md)。任务类演示见 [ExampleTask/ExampleTask.md](ExampleTask/ExampleTask.md)。
以下演示展示了 BioClaw 在主流渠道中的任务能力(WhatsApp、QQ、企业微信、微信、飞书以及本地 Web UI)。

QQ / 飞书路线图示意截图已移至 [docs/CHANNELS.zh-CN.md](docs/CHANNELS.zh-CN.md)。更多任务类演示见 [ExampleTask/ExampleTask.md](ExampleTask/ExampleTask.md)。

### 9. SDS-PAGE 凝胶图审阅(WhatsApp 拍照/上传)

在 WhatsApp 中直接拍照或上传凝胶图片,请 BioClaw 判断泳道质量、条带是否清晰,以及主条带是否与目标分子量大致匹配。

<img src="docs/images/whatsapp-凝胶.jpg" width="420" />

## 系统架构

Expand Down
Binary file added docs/images/dashboard/UI-bioclaw.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/feishu/feishu-bioclaw.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/wecom/wecom-bioclaw.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/weixin/weixin-bioclaw.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/whatsapp-凝胶.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading