Webnovel Dashboard

Webnovel Dashboard

目标

在本地启动 Web 面板，查看创作进度、设定词典、关系图谱、章节内容与追读力数据，并可编辑文风约束。

功能概览

主题

支持亮色/暗色模式切换（侧边栏右上角 🌙/☀️ 按钮），偏好持久化到 localStorage。

文风约束编辑器（/style）

6 个 Tab：自定义文风（设定集/prompts/*.md，读写）、全局文风（MASTER_SETTING.json，读写）、禁止模式（anti_patterns.json，读写）、写作技法（CSV，只读）、章级合同（只读）、审查维度（只读）。

API 参考

写入 API（8 个）、只读 API（6 个）、配置说明见 references/dashboard-api.md。

环境设置

# 以下命令假设当前目录为 webnovel-writer 仓库根目录
export SCRIPTS_DIR="${PWD}/.opencode/scripts"
export DASHBOARD_DIR="${PWD}/.opencode/dashboard"
test -d "${DASHBOARD_DIR}" || { echo "错误: 未找到 ${DASHBOARD_DIR}，请确保当前目录是 webnovel-writer 仓库根目录"; exit 1; }

执行流程

Step 1：安装依赖

python -m pip install -r "${DASHBOARD_DIR}/requirements.txt" --quiet

Step 2：解析项目路径 + 校验前端

export PROJECT_ROOT="$(python -X utf8 "${SCRIPTS_DIR}/webnovel.py" --project-root "${PWD}" where)"
test -n "$PROJECT_ROOT" && test -f "${PROJECT_ROOT}/.webnovel/state.json" || { echo "错误: PROJECT_ROOT 解析失败，请用 --project-root 显式指定"; exit 1; }
echo "项目路径: ${PROJECT_ROOT}"

test -f "${DASHBOARD_DIR}/frontend/dist/index.html" || { echo "错误: 缺少前端构建产物 ${DASHBOARD_DIR}/frontend/dist/index.html"; exit 1; }

Step 3：启动 Dashboard（后台运行）

Dashboard 是长运行服务（uvicorn），必须用后台模式启动。命令中设置 run_in_background: true。

PYTHONPATH="${PWD}/.opencode" python -X utf8 -m dashboard.server --project-root "${PROJECT_ROOT}"

默认端口 8765，访问 http://127.0.0.1:8765。

自定义端口：

PYTHONPATH="${PWD}/.opencode" python -X utf8 -m dashboard.server --project-root "${PROJECT_ROOT}" --port 9000 --no-browser

自动关闭旧进程并启动：

PYTHONPATH="${PWD}/.opencode" python -X utf8 -m dashboard.server --project-root "${PROJECT_ROOT}" --kill-existing --no-browser

Step 4：验证服务

curl -s http://127.0.0.1:8765/api/story-runtime/health || echo "服务未启动"
curl -s http://127.0.0.1:8765/api/style/master-setting || echo "文风编辑器不可用"

项目根目录解析

server.py 按以下优先级解析项目根目录：

1. --project-root 参数
2. WEBNOVEL_PROJECT_ROOT 环境变量
3. CWD 向上搜索（找到包含 .webnovel/state.json 的目录）
4. .opencode/.webnovel-current-project 指针文件
5. 智能搜索同级目录（支持嵌套结构如 E:\workspace\webnovel\书名\）

注意事项

• Dashboard 提供只读查询 + 文风约束编辑（写入操作限于 master_constraints 和 anti_patterns）
• uvicorn 默认监听 127.0.0.1:8765
• 首次启动可能需安装依赖（pip install -r requirements.txt）
• Windows 中文输出乱码：运行 chcp 65001 后重试
• 端口被占用时自动检测并提示，可用 --kill-existing 自动关闭旧进程

失败恢复