跳转到主要内容

Documentation Index

Fetch the complete documentation index at: https://openyida.ai/docs/llms.txt

Use this file to discover all available pages before exploring further.

OpenYida 内置强大的诊断工具 doctor,帮助开发者检查环境、诊断问题、自动修复、持续监控应用健康度。

功能概述

环境检查

检查 Node.js、Playwright、登录态等环境依赖。

应用诊断

检查 PRD、页面源码、Schema 缓存、React Hooks 规范。

智能修复

自动修复可修复的问题,提供手动修复指导。

健康监控

持续监控应用健康度,生成趋势报告。

基本用法

运行诊断

openyida doctor

自动修复

openyida doctor --fix

生成报告

# Markdown 格式
openyida doctor --report markdown

# JSON 格式
openyida doctor --report json

# HTML 格式
openyida doctor --report html

环境检查项

检查项说明自动修复
CLI 版本检查 openyida 版本是否与 SKILL.md 一致
project/ 初始化检查 project/ 工作目录是否存在
Node.js 版本检查是否 ≥ 18
Playwright检查是否安装
config.json检查配置文件
宜搭登录检查登录态
网络连通检查 aliwork.com 连通性

应用诊断项

检查项说明
PRD 文件检查是否存在需求文档
页面源码检查源码文件、console.log、空文件
Schema 缓存检查缓存文件格式
React Hooks检查 Hooks 使用规范

健康监控模式

启动持续监控,每分钟检查一次:
openyida doctor --monitor
健康监控功能目前处于 Beta 测试阶段。API 和输出格式在后续版本中可能会发生变化。
输出示例:
[14:32:01] 健康度: 95/100 📈
  通过: 18/19 | 错误: 0 | 警告: 1

[14:33:01] 健康度: 100/100 ➡️
  通过: 19/19 | 错误: 0 | 警告: 0
Ctrl+C 停止监控。

线上诊断

针对已发布应用的线上诊断:
openyida doctor --production --app <appId>
检查内容:
  • 应用 ID 有效性
  • 线上错误日志
  • 性能指标

工单与 VOC

创建工单(Bug)

openyida doctor --create-ticket
交互式输入标题和描述,自动提交到 GitHub Issues。

创建 VOC(需求)

openyida doctor --create-voc

智能提交

系统自动判断是 Bug 还是需求:
openyida doctor --auto-submit

诊断报告示例

控制台输出

🔍 检查 OpenYida 环境依赖...

✅ openyida 版本:2026.04.02(SKILL 期望:2026.04.02)
✅ project/ 工作目录已初始化
✅ Node.js v18.19.0(要求 ≥ 18)
✅ Playwright 已安装
✅ config.json 存在且格式正确
✅ 宜搭登录态:已登录
✅ 网络连通性(aliwork.com)
✅ PRD 文件(2 个)
✅ 页面源码(3 个文件)
✅ Schema 缓存(5 个)
✅ React Hooks 规范

通过 11 项检查,未发现问题
使用自定义输出格式生成报告是实验性功能。HTML 和 JSON 输出模式在后续更新中可能会进行优化。

Markdown 报告

openyida doctor --report markdown
报告保存到 .cache/reports/doctor-2024-01-15T10-30-00-000Z.md

预检查

在关键操作前自动执行检查:

发布前检查

# 自动执行
openyida publish 前会自动运行预检查

创建前检查

# 自动执行
openyida create-app 前会自动运行预检查

修复类型

类型说明示例
AUTO自动修复创建 config.json、删除损坏缓存
COMMAND命令修复运行 pip install playwright
MANUAL手动修复安装 gh CLI、编写 PRD

健康度计算

健康度分数(0-100)计算公式:
健康度 = 通过率 × 100 - 错误数 × 10 - 警告数 × 3
分数状态
90-100优秀 🟢
70-89良好 🟡
50-69一般 🟠
< 50需改进 🔴