Skip to content

开发指南 ​

文档导航 · 架构设计

本页面向维护 @wenext/pi 源码的人;安装和使用 CLI 不需要执行这些步骤。

构建与验证 ​

本包位于 wenext-h5-common-libs 仓库的 packages/wenext-pi。在包目录运行:

bash
cd packages/wenext-pi
npm install
npm run typecheck
npm test
node ./bin/wenext-pi.mjs --version

npm install 的 prepare 会构建;npm test 也先构建,再运行 test/*.test.mjs。单独构建使用 npm run build,本地启动使用 npm start。输出为 ESM dist/,保留声明文件,不发布 source map。

源码目录职责
src/cli/参数、启动、doctor 与项目列表
src/workflows/default/默认路由、节点、角色、验收与完成要求
src/application/任务操作和运行能力编排
src/runtime/执行、范围、证据、质量、审查、会话、智能体与插件服务
src/adapters/pi/Pi SDK、TUI 工具、认证、会话生命周期接入
src/adapters/filesystem/项目布局、任务与配置持久化
src/plugins/内置插件及构建生成的注册表
src/telemetry/v2 事件契约与事实采集;队列持久化和传输位于对应 adapter
test/单元、宿主、恢复、进程与集成验证

发布时保持 Pi 依赖家族版本一致。升级 SDK 必须验证真实会话切换、恢复和 CLI 集成,不能只检查类型。指标 wire 契约需与服务端副本同步并先部署兼容接收端。

测试默认隔离上报,避免测试事件进入团队 collector。部分真实 SDK/装包集成验证使用独立 *.integration.mjs 入口,应按对应契约运行;确定性本地模型通过不等于真实账号、人工 TUI 或线上领域流程已验收。

包与文档边界 ​

发布内容由 package.json.files 指定:bin、dist、docs、README 和 LICENSE。所有使用文档均使用包内相对链接;内部源码路径用于开发定位,不代表安装包导入 API。

变更命令、配置或行为时,同步 README 对应入口和主题参考。设计文档描述当前责任、状态和约束;尚未实现的功能放在明确标记的提案中。测试执行记录、事故排查过程和阶段验收结果留在开发任务记录,不追加到使用文档。