SoulBrowser Docs

Appearance

快速开始 ​

先理解这是什么 ​

SoulBrowser 是一个智能浏览器自动化系统，核心能力包括：

  • 自然语言驱动的浏览器任务
  • 结构、视觉、语义多模态感知
  • 云端、本地、混合执行模式

如果你只是要开始开发，先不需要掌握所有模块，先把本地联调跑起来。

本地联调 ​

后端：

bash
SOUL_EXECUTION_MODE=local SOULBROWSER_AUTH_DISABLED=1 cargo run --bin soulbrowser -- serve --disable-auth

新前端：

bash
cd /mnt/e/projects/soulbrowser/web-console-dx
trunk serve

文档站：

bash
cd /mnt/e/projects/soulbrowser/docs-site
npm install
npm run dev

另一种最简单的服务启动方式 ​

如果你只是想先看到服务起来，而不是完整本地浏览器联调，也可以直接：

bash
cargo run --bin soulbrowser -- serve --port 8808

然后访问：

text
http://localhost:8808

当前前端 ​

仓库里目前有两套前端：

  • web-console/ 旧 React 控制台
  • web-console-dx/ 新 Dioxus 控制台

开发文档默认以 web-console-dx/ 为主。

常用命令 ​

命令说明
cargo run --bin soulbrowser -- serve启动后端服务
cargo run --bin soulbrowser -- chat --prompt "任务"通过 CLI 执行任务
cargo run --bin soulbrowser -- perceive --url URL感知指定网页
cd web-console-dx && trunk serve启动新前端
cd docs-site && npm run dev启动文档站

常见问题 ​

找不到 Chrome ​

可以显式设置：

bash
export SOULBROWSER_CHROME=/path/to/chrome

端口被占用 ​

换端口启动：

bash
cargo run --bin soulbrowser -- serve --port 9999

文档站第一次起不来 ​

先安装依赖：

bash
cd docs-site
npm install

文档维护原则 ​

  • 文档站只放“可直接使用”的文档
  • 历史资料、审计记录、设计草稿先留在仓库 docs/
  • 新写的开发规则优先进入 docs 站，而不是散落到各子目录

SoulBrowser Documentation

Docs in monorepo