Agent Skills › lingfengQAQ/webnovel-writer › webnovel-dashboard

webnovel-dashboard

GitHub

启动只读Web面板，用于查看小说创作进度、实体图谱及章节数据。通过校验环境并运行Python服务暴露API状态，支持自定义端口与无头模式，确保纯只读访问项目文件。

webnovel-writer/skills/webnovel-dashboard/SKILL.md lingfengQAQ/webnovel-writer

触发场景

用户希望查看小说项目的整体状态或创作进度需要可视化展示角色关系图谱或章节内容检查Story Runtime主链的健康状态或最新提交

安装

npx skills add lingfengQAQ/webnovel-writer --skill webnovel-dashboard -g -y

更多选项

非标准路径

npx skills add https://github.com/lingfengQAQ/webnovel-writer/tree/master/webnovel-writer/skills/webnovel-dashboard -g -y

不安装直接使用

npx skills use lingfengQAQ/webnovel-writer@webnovel-dashboard

指定 Agent (Claude Code)

npx skills add lingfengQAQ/webnovel-writer --skill webnovel-dashboard -a claude-code -g -y

安装 repo 全部 skill

npx skills add lingfengQAQ/webnovel-writer --all -g -y

预览 repo 内 skill

npx skills add lingfengQAQ/webnovel-writer --list

SKILL.md

Frontmatter

{
    "name": "webnovel-dashboard",
    "description": "启动只读小说管理面板，查看项目状态、实体图谱与章节内容。",
    "allowed-tools": "Bash Read"
}

Webnovel Dashboard

目标

在本地启动只读 Web 面板，查看创作进度、设定词典、关系图谱、章节内容与追读力数据。
暴露 Story Runtime 主链状态：/api/story-runtime/health、latest commit、fallback 情况。
可监听 .webnovel/ 变化，但不修改任何项目文件。

执行流程

Step 1：确认环境与模块目录

export WORKSPACE_ROOT="${CLAUDE_PROJECT_DIR:-$PWD}"

if [ -z "${CLAUDE_PLUGIN_ROOT}" ] || [ ! -d "${CLAUDE_PLUGIN_ROOT}/dashboard" ]; then
  echo "ERROR: 未找到 dashboard 模块: ${CLAUDE_PLUGIN_ROOT}/dashboard" >&2
  exit 1
fi

export DASHBOARD_DIR="${CLAUDE_PLUGIN_ROOT}/dashboard"
export SCRIPTS_DIR="${CLAUDE_PLUGIN_ROOT}/scripts"

Step 2：解析项目根目录

export PROJECT_ROOT="$(python "${SCRIPTS_DIR}/webnovel.py" --project-root "${WORKSPACE_ROOT}" where)"
echo "项目路径: ${PROJECT_ROOT}"

PROJECT_ROOT 必须解析成功。

Step 3：校验前端产物与依赖

if [ -n "${PYTHONPATH:-}" ]; then
  export PYTHONPATH="${CLAUDE_PLUGIN_ROOT}:${PYTHONPATH}"
else
  export PYTHONPATH="${CLAUDE_PLUGIN_ROOT}"
fi

if [ ! -f "${DASHBOARD_DIR}/frontend/dist/index.html" ]; then
  echo "ERROR: 缺少前端构建产物 ${DASHBOARD_DIR}/frontend/dist/index.html（dist 应随插件打包，确认插件完整安装）" >&2
  exit 1
fi

不默认安装依赖。仅当 Step 4 因缺依赖启动失败时，提示用户手动执行：

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

Step 4：启动 Dashboard

python -m dashboard.server --project-root "${PROJECT_ROOT}"

不自动打开浏览器时加 --no-browser；自定义端口加 --port 9000。

启动后优先确认接口可用：/api/story-runtime/health、/api/preflight。

成功标准

Dashboard 进程已启动并输出可访问 URL；页面显示项目数据（章节列表、实体图谱等）。

失败恢复

故障	恢复方式
启动报缺依赖	手动 `pip install -r "${DASHBOARD_DIR}/requirements.txt"`，检查 Python 版本与网络
前端 `dist/` 缺失	确认插件完整安装，dist 应随插件打包
项目根解析失败	检查 `.webnovel/state.json` 是否存在，确认 `WORKSPACE_ROOT` 正确
端口占用	用 `--port <其他端口>` 或关闭占用进程
页面空白/数据缺失	确认 `.webnovel/` 下有 state.json、index.db 等数据文件