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
+89
View File
@@ -0,0 +1,89 @@
# VisionL 快速开始
## 安装
```bash
# 1. 克隆仓库
git clone ssh://git@git.yeij.top:2222/AskaEth/VisionL.git
cd VisionL
# 2. 安装依赖
npm install
# 3. 安装 Chromium 浏览器
npx playwright install chromium
# 4. 构建
npm run build
# 5. 全局安装 CLI(可选)
cd packages/cli && npm link
```
## 基本使用
### 启动 daemon
```bash
visionl daemon start
# ✓ Daemon 已启动 (端口 9527, PID 12345)
```
### 打开一个页面
```bash
visionl page open https://www.baidu.com --alias baidu
# {"ok":true,"data":{"id":"p_a1b2c3d4","url":"https://www.baidu.com","alias":"baidu","title":"百度一下,你就知道","status":"active"}}
```
### 获取页面文本
```bash
visionl text baidu
# {"ok":true,"data":{"text":"百度一下,你就知道\n..."}}
```
### 搜索
```bash
visionl type baidu "#kw" "VisionL"
visionl click baidu "#su"
```
### 截图
```bash
visionl screenshot baidu -o result.png
```
### 关闭页面
```bash
visionl page kill baidu
# {"ok":true,"data":null}
```
### 停止 daemon
```bash
visionl daemon stop
```
## 无需手动启动 daemon
CLI 会自动检测 daemon 是否运行,未运行则自动启动:
```bash
# 直接使用,CLI 自动拉起 daemon
visionl page open https://example.com
# 关闭所有页面(daemon 继续运行)
visionl page kill-all
```
## 查看所有页面
```bash
visionl page list
# {"ok":true,"data":[{"id":"p_xxx","url":"...","alias":"...","title":"...","status":"active"}]}
```