docs: 项目架构设计文档(中文)及使用指南

- architecture.md: 完整架构设计(技术栈、API、CLI、生命周期、测试策略)
- api.md: REST + WebSocket 接口文档
- cli.md: CLI 命令参考
- contributing.md: 开发规范与 JSON 转义要求
- quickstart.md: 快速开始指南
- llm-integration.md: 智能体集成指南
- examples.md: 8 个典型使用场景
This commit is contained in:
2026-08-12 20:14:54 +08:00
parent 4f7854ab6e
commit 0c437a96f1
9 changed files with 1548 additions and 0 deletions
+32
View File
@@ -1,2 +1,34 @@
# VisionL
面向 AI 智能体的开源可持久化浏览器。
LLM 通过 `VisionL-cli` 工具调用操控网页——打开页面、点击、输入、截图、提取内容。
页面独立持久化,关闭任何窗口都不会杀死后台页面。
## 特性
- **智能体优先**:CLI 子命令专为 LLM 工具调用设计,输出结构化 JSON
- **页面持久化**:页面存活不受客户端断连影响,只有显式 `kill` 才终止
- **全功能自动化**:点击、输入、滚动、截图、JS 执行、网络拦截
- **多页面并行**:同时管理多个页面,ID + 别名双轨引用
- **自动拉起**:CLI 自动检测并启动后台 daemon
## 文档
| 文档 | 说明 |
|------|------|
| [快速开始](docs/usage/quickstart.md) | 安装和基本使用 |
| [LLM 集成](docs/usage/llm-integration.md) | 在智能体中集成 VisionL |
| [使用示例](docs/usage/examples.md) | 典型场景 |
| [架构设计](docs/development/architecture.md) | 整体架构 |
| [API 文档](docs/development/api.md) | REST + WebSocket 接口 |
| [CLI 命令](docs/development/cli.md) | 命令参考 |
| [开发规范](docs/development/contributing.md) | 贡献指南 |
## 技术栈
TypeScript + Node.js + Playwright + Chromium
## License
待定