加载Vibes框架
此工作区包含以下所需的一切 _作者_ Loaded Vibes框架,同时保持 开发环境 与 已装运包裹 客户通过安装 npx create-loaded-vibes 或复古 loaded-vibes CLI。
1.加载Vibes开发环境
Loaded Vibes的活动开发环境位于: D:\LoadedVibes
在改进框架本身时使用这些文件夹:
.github/–为开发环境堆叠特定的Copilot指令和治理。.vscode/–编辑器设置和扩展建议仅适用于框架创作工作区。docs/–架构参考、PRD、技术要求和开发人员指南。templates/-用于开发框架的参考文件和模板(不直接发货)。
1.1规范驱动的工作流工件
docs/PRD.md–整合的产品要求,包括CLI经验和分发规则。docs/TECH_REQUIREMENTS.md–整合了技术、自动化、清单和CLI实施指南。TODO.md&CHANGELOG.md-滚动执行证据,每个DevCycle都必须更新。SUPPORT.md,SECURITY.md,CONTRIBUTING.md,CODE_OF_CONDUCT.md,CODEOWNERS,LICENSE–PRD和技术要求引用的治理工件。
2.装载式Vibes框架(已发货产品)
Loaded Vibes项目附带的资产位于以下目录中: D:\LoadedVibes\dist\**
此目录镜像了复制到用户开发环境中的文件(发布于 .loaded-vibes/** 通过CLI)。它包括:
dist/.github/–面向最终用户的代理、说明、提示和工具集。dist/.vscode/–最终用户的设置、扩展和MCP配置。dist/docs/–最终用户文档。dist/genaiscript/–在最终用户环境中运行的核心框架引擎(编排器和工具)。dist/scripts/–引导程序脚本。dist/src/–生成的用户项目的输出目录。
注: dist 应被视为“装运产品”。不要使用这些文件来配置 _框架_ 开发环境--使用 .github/ 和 .vscode/ 在这个工作区中。
3.最终用户项目文件
Loaded Vibes为最终用户生成内部的所有资产: D:\LoadedVibes\dist\src
- 这些文件是框架的输出。
- 它们属于最终用户的应用程序。
- 他们必须 不 影响Loaded Vibes开发环境。
- IDE应忽略
dist/src用于梳理和配置目的。
离职总结
| 范围 | 目录 | 目的 |
|---|---|---|
| 开发环境 | D:\LoadedVibes | 我们在哪里构建框架。由root配置 .vscode, .github, docs, templates. |
| 已发货产品 | dist/ | 交付给用户的工件。包含自己的 .github, .vscode, genaiscript等等。 |
| 用户项目 | dist/src/ | 生成的应用程序代码。被框架工具忽略。 |
4.快速入门:安装和初始化
每 docs/PRD.md §5.1和 docs/TECH_REQUIREMENTS.md §5.1,每次安装都遵循相同的保护流程,无论您是新启动还是附加到现有的仓库。
4.1新安装
- 创建项目:
npx create-loaded-vibes my-app下载最新的签名版本,验证SHA256签名,并镜像dist/**进入.loaded-vibes/. - 运行初始化: 允许向导调用
loaded-vibes init;它配置MCP端点、VS代码配置文件、Git钩子,并使用JSON输出重放引导程序检查。 - 验证准备状态: 跑
loaded-vibes doctor确认先决条件(Node≥20、git、pnpm、GenAIScript扩展),并在出现任何偏差时捕获补救提示。 - 打开仪表板: 发射
loaded-vibes dashboard用于镜像编排器状态、日志和TODO/CHANGELOG队列的synthwave UI。 - 执行DevCycles: 使用
loaded-vibes devcycle(或--list)运行具有检查点批准和Bad Vibes防火墙提示的规范18 DevCycles。
4.2附加现有存储库
- 从目标仓库根目录运行
npx create-loaded-vibes --attach ./. - 根据ADR-001(自定义版本控制)选择镜像、合并或沙盒策略以保留
.github,.vscode和现有dist/**资产。 - 查看登录的差异提示+批准
.loaded-vibes/logs/install-YYYYMMDD.md在接受文件写入之前。 - 跑步结束
loaded-vibes doctor --auto-remediate以协调MCP端点和清单引用。
4.3安装人员的规定
.loaded-vibes/镜像已发送的有效负载(代理、提示、工具集、编排器、文档),是 仅 CLI自动写入的目录。.loaded-vibes/logs/*.ndjson存储可追溯的事件日志requirementId字段(PRD§5.4,TECH§4.5)。.loaded-vibes/summaries/根据ADR-0001捕获JSON+Markdown执行摘要。
返回参考 docs/PRD.md §5和 docs/TECH_REQUIREMENTS.md §§5–10每当您更改CLI流时。
5.DevCycle治理概述
加载的Vibes使DevCycle编排保持确定性(PRD§5.3,TECH§4-7):
- 清单奇偶性:
dist/genaiscript/devcycles.config.json是18个DevCycles的真相来源,必须与TECH§6保持同步,并且dist/.github/global.instructions.md. - 说明+工具集: 每个DevCycle引用一个指令文件和一个工具集,强制执行中定义的分层规则堆栈
dist/.github/instructions/**和dist/.github/toolsets/**. - TODO/CHANGELOG证据: 每次DevCycle运行后,编排器都会将引用需求的条目写入
TODO.md和CHANGELOG.md使用降价摘要挂钩(TECH§7,SPEC-OBS§3)。 - 坏Vibes防火墙: 破坏性操作(文件删除、升级、迁移)会暂停执行,直到操作员用记录的签名批准该操作(PRD§5.5,SPEC-SECURITY§1)。
- 状态快照: 执行元数据保存在
dist/genaiscript/state/state.json因此,仪表板、医生命令和重播共享相同的上下文(TECH§4.5)。
6.复古仪表板命令
启动synthwave仪表板以实时监控DevCycles:
loaded-vibes dashboard仪表板使用(PRD§5.2)
- 启动命令,等待ASCII刊头+渐变画布渲染(图+渐变字符串)。
- 观看 DevCycle队列 窗格显示所有18个阶段的当前状态(○待定,▶ 跑步,✓ done, ✗ 失败)。
- 切换 实时日志 窗格(
l)将NDJSON条目与来自的严重性图标进行流式传输.loaded-vibes/logs/*.ndjson. - 注意 系统度量 (CPU/内存每2秒更新一次),然后再运行繁重的DevCycles。
- 使用 TODO/CHANGELOG订阅源 确认编排正在更新治理工件。
- 触发 命令面板 随着
Ctrl+P在不离开UI的情况下重新运行DevCycles、打开文档或尾日志。
键盘控制
| 关键 | 行动 |
|---|---|
Ctrl+P | 打开命令面板(模糊搜索) |
r | 刷新仪表板数据 |
l | 切换实时日志流 |
h / ? | 显示键盘快捷键帮助 |
q / Ctrl+C | 退出仪表板 |
仪表板刷新被限制在\ --mode plan-first --task "ticket-123" (支持 --dry-run, --skip-bootstrap, --auto-approve, --verbose, --list`).
- 确认
dist/genaiscript/devcycles.config.json加上执行前的提示/指令/工具集参考(TECH§4.1)。 - 流分析→ 用需求ID、检查点批准和Bad Vibes防火墙通知内联反映NDJSON事件(SPEC-CLI§1、PRD§5.2、§5.5)。
- 当名称拼写错误时,建议最近的清单条目,并显示所选DevCycle的默认模式/工具。
8.日志命令
检查存储在中的NDJSON跟踪 .loaded-vibes/logs/*.ndjson 根据技术要求§5.3(使用 ts-node 或打包版本中的编译CLI二进制文件):
- 显示最新条目:
node dist/cli/commands/logs.ts - 按开发周期/时间/严重性筛选:
node dist/cli/commands/logs.ts --devcycle --since --severity warn,error - 流更新:添加
--follow在编写新的NDJSON行时对其进行尾部处理。 - 导出引用需求ID的Markdown快照:
node dist/cli/commands/logs.ts --export .loaded-vibes/logs/export.md
9.遥测输出命令
将NDJSON遥测日志转换为经过净化的JSON或Markdown快照,用于审计和PR附件。
- 用途:
loaded-vibes telemetry export --format json|markdown [--devcycle ] [--since ] - 默认为阅读
.loaded-vibes/logs/*.ndjson并写信给.loaded-vibes/telemetry/exports/telemetry-.json|md. - JSON导出电源CI集成和仪表板;Markdown反映了ADR-0001的双模指导,以方便审阅者进行差异分析。
- 所有出口都通过秘密编辑管道(SPEC-SECURITY§2),并引用相关的PRD/TECH要求ID。
10.变更日志和待办事项工作流
规范驱动工作流需要每个开发周期或手动干预来记录结果(PRD§2,TECH§7,Spec-OBS§3):
- TODO.md 捕获带有需求引用的即将到来或正在进行的项目,以便仪表板和CLI提供相同的状态。
- 更改日志.md 以压缩格式记录操作日志:
[Type][ISO8601] Goal → Action → Result → Next有需求参考和后续任务。 - 自动化挂钩 (
dist/genaiscript/shared/todoUpdater.js和changelogUpdater.js)防止重复条目,并确保NDJSON摘要使两个文件保持同步。
CHANGELOG条目示例:
[Documentation][2025-11-27T23:30Z] Goal: Publish end-user guides (Issue #29, PRD §§2–4) -> Action: Updated README quickstart/governance sections plus SUPPORT/SECURITY guidance referencing SPEC-SECURITY §2 and TECH §5.2; documented CHANGELOG format and troubleshooting runbook; logged TODO entry -> Result: Builders have a single quickstart + support playbook tied to requirements -> Next: Mirror README sections into dist/docs for the next release.11.故障排除备忘单
在升级之前使用这些CLI帮助程序(PRD§5.4,TECH§5.3):
loaded-vibes doctor --auto-remediate–修复了频繁的环境漂移(节点、pnpm、MCP端点)和表面修复JSON。loaded-vibes logs --devcycle --since–提取特定DevCycle的NDJSON证据;添加--follow观看实时输出。loaded-vibes devcycle --dry-run–回放分析/设计阶段,而不写入文件以验证清单对齐。loaded-vibes dashboard–查看DevCycle队列、TODO/CHANGELOG提要和系统指标。loaded-vibes telemetry export --format markdown–在不泄露秘密的情况下,为PR或支持票打包跟踪证据。
升级到维护团队(参见 SUPPORT.md)仅在捕获医生输出和NDJSON片段后;附上相关的需求ID以加快分流。
12.CI工作流程
该存储库包括自动CI检查,以验证框架治理:
清单验证
这 manifest-validation.yml 工作流验证中的所有DevCycle条目 dist/genaiscript/devcycles.config.json 解析为有效文件:
- 触发: 对清单文件或任何提示/指令/工具集文件进行推送/PR更改
- 验证: 对于18个DevCycles中的每一个,检查
instructions,toolset,以及prompt文件引用存在 - 输出: 列出所有已验证的DevCycles,其中包含任何丢失文件的详细错误消息
- 参考文献 技术要求§7,规范法案§3
设置保护
这 settings-guard.yml 工作流确保VS代码设置仅引用开发层资产:
- 触发: 推送/PR更改到
.vscode/settings.json - 验证: 阻止指令引用
dist/**已装运资产 - 参考文献 PRD§4.3,SPEC-ARCH§3,技术要求§11
