Repolode
truecourse-ai

truecourse-ai/truecourse

从 PRD、ADR 和 README 生成端到端测试,文档与产品不一致时直接报错。

Star
538
Fork
44
未关闭 Issue
52
最近提交
24天前

这是什么?

TrueCourse 读取团队已有的文档,包括 PRD、ADR、README 和文档站点,将其整理为一组可验证的断言。随后它梳理用户在产品中的操作流程,并针对运行中的界面为每条流程编写测试。

测试失败即表示产品行为与文档描述不一致,失败信息会指出具体涉及的断言。测试以 Playwright 脚本形式编写,每个测试带有独立的种子数据,互不共享状态。工具依赖 Claude Code 登录运行,提供无需登录的本地模式,并可通过 GitHub App 在拉取请求中执行检查。

项目基于 TypeScript、pnpm monorepo 和 PostgreSQL 构建,并提供 MCP 接口,供 Claude Code 读取工作区中的文档、流程、运行结果和失败记录。

核心功能

  • 01将 PRD、ADR、README 和文档站点整理为可测试的断言集合。
  • 02针对运行中的产品,为每条用户流程编写 Playwright 端到端测试。
  • 03测试失败时指出与之矛盾的具体文档断言。
  • 04通过 GitHub App 在拉取请求中检查文档冲突和测试失败。
  • 05提供 MCP 接口,让 Claude Code 查询工作区的文档、流程和运行结果。

适用场景

  • 验证产品行为是否仍与 PRD 和用户文档保持一致。
  • 发现架构决策记录与实际运行系统之间的偏差。
  • 在合并前对拉取请求执行基于文档的检查。

快速上手

  1. 1

    复制示例环境变量文件

    cp .env.example .env
  2. 2

    用 Docker Compose 启动 Postgres

    docker compose up -d
  3. 3

    安装依赖

    pnpm install
  4. 4

    启动开发服务器并打开 http://localhost:3000

    pnpm dev

使用前须知

  • 需要登录 Claude Code,并且 claude 命令必须在 PATH 中。
  • truecourse npm 命令行工具已弃用,不再维护。
  • 生产环境使用 ee/ 代码需要企业版订阅。

收录于专题

标签

常见问题

truecourse 是什么?
从 PRD、ADR 和 README 生成端到端测试,文档与产品不一致时直接报错。 TrueCourse 读取团队已有的文档,包括 PRD、ADR、README 和文档站点,将其整理为一组可验证的断言。随后它梳理用户在产品中的操作流程,并针对运行中的界面为每条流程编写测试。
truecourse 可以免费使用吗?用的什么许可证?
truecourse 以 MIT 许可证开源。用于商业产品前,请先确认许可证条款。
truecourse 还在维护吗?
活跃维护中。truecourse 最近一次提交是在 2026年10月14日。
truecourse 适合用来做什么?
验证产品行为是否仍与 PRD 和用户文档保持一致。 发现架构决策记录与实际运行系统之间的偏差。 在合并前对拉取请求执行基于文档的检查。
truecourse 怎么安装和运行?
复制示例环境变量文件: cp .env.example .env 用 Docker Compose 启动 Postgres: docker compose up -d 安装依赖: pnpm install 启动开发服务器并打开 http://localhost:3000: pnpm dev
在哪里获取 truecourse?
源代码和安装说明在 GitHub 上:https://github.com/truecourse-ai/truecourse

概要由 AI 根据项目 README 生成;GitHub 数据每日更新。

相关项目