StudyFlow

本地优先的个人学习工作台：学习者使用桌面界面，任意外部 Agent 使用同一套 CLI。

学习计划 → 顺序课程 → 多知识点 → 作答 → 批改 → 修正/复测 → 下一步。软件不内置在线 AI API，不绑定特定模型供应商；外部 Agent 或人工通过 CLI 编写课程和反馈。

源码 1.3.0，Engine 协议 1.2，仓库 Skill 1.6.0（已安装副本需单独同步）。当前是持续迭代的验收候选，内部工程测试不等于用户体验验收或生产就绪承诺。

主要能力

• 按学习计划聚合课程，兼容当天安排和顺序推进。
• 一门课程包含多个知识点，左右导航保留阅读进度；整课保存和提交作答。
• 批改逐题追溯，保留原答案、修正版、复测、反馈和下一动作。
• 中立 CLI 提供能力发现、课程导入、待批改队列、反馈及上下文操作。
• Tauri 桌面自动管理 Python Engine 和 SQLite，不要求学习者手动开服务。
• Markdown 内容和数据工作区可受控备份、校验和迁移。

项目结构

StudyFlow/
├─ apps/desktop/                 唯一 Vue UI + Tauri 桌面薄壳
│  ├─ src/app/                   应用装配、导航与窗口布局
│  ├─ src/features/              console / plans / courses / learning / reviews / workspace
│  ├─ src/shared/                API 契约、Engine 传输、反馈与公共样式
│  ├─ src-tauri/src/             Engine 进程、工作区发现、命令注册
│  └─ scripts/                   桌面构建与冻结 Engine 烟测
├─ packages/core/
│  ├─ src/studyflow/application/ Facade 装配、聚合查询与演示初始化
│  ├─ src/studyflow/modules/     planning / courses / learning / reviews / documents / workspace
│  ├─ src/studyflow/interfaces/  CLI / Engine / 兼容 Web 适配器
│  ├─ src/studyflow/infrastructure/ 事务、配置、持久化、资源与诊断
│  ├─ src/studyflow/shared/      共用领域约束与工具
│  ├─ src/studyflow/resources/   历史迁移、兼容 Web 资源、合成示例
│  └─ tests/                    业务与架构契约回归
├─ skills/studyflow-agent/       外部 Agent 操作 Skill
├─ docs/                        软件工程生命周期文档
├─ scripts/                     发布边界检查
└─ .github/                     CI、CODEOWNERS、PR 模板

仓库不包含个人课程记录、真实答案、数据库、旧学习主控、安装包或原私人 Git 历史。公开示例与测试素材是合成的产品验证内容。

开发快速开始（Windows / PowerShell）

需要 Python 3.12+、Node.js 22、Rust 与 Tauri Windows 构建依赖，完整说明见 构建与开发。

# 仓库根目录
py -3 -m venv packages/core/.venv
$python = Join-Path $PWD 'packages/core/.venv/Scripts/python.exe'
& $python -m pip install -e './packages/core[dev]' 'pyinstaller>=6.10,<7'
& $python -m pytest packages/core/tests
& $python scripts/check_publish_boundary.py --worktree
npm --prefix apps/desktop ci
npm --prefix apps/desktop run build
& ./apps/desktop/scripts/build-engine.ps1
npm --prefix apps/desktop run tauri -- dev

CLI 和外部 Agent

# 明确选择数据工作区；安装目录不等于数据工作区
$env:STUDYFLOW_WORKSPACE = Join-Path $env:LOCALAPPDATA 'StudyFlow-demo'
& $python -X utf8 -m studyflow version --format json
& $python -X utf8 -m studyflow capabilities --format json
& $python -X utf8 -m studyflow doctor --format json
& $python -X utf8 -m studyflow assignment queue --format json

只对新建的演示工作区使用 init，不能拿初始化修复已有数据。课程生成不表示学习者完成或掌握。

模块职责、事务边界与兼容入口见 模块化结构设计。源码迁移不迁移安装目录或学习数据；旧本地开发环境不应直接移动复用。

安装 Skill：把 skills/studyflow-agent 完整复制到你的 Agent 支持的 Skill 目录。不限 Codex；MSI 当前不安装独立 CLI，也不修改系统 PATH，CLI 从开发环境使用。

文档

工程总控 · 定义 · 需求 · 架构 · 数据模型 · CLI · 发布范围

贡献与合并由仓库所有者决定，见 CONTRIBUTING 和 SECURITY。目前未指定项目级开源许可证；公开不等于已授权所有使用方式，不要替所有者添加许可证。第三方依赖仍遵守各自许可证。