从零到 typecheck 通过:工具链版本、hooks、仓库目录结构的官方口径。
package.json 里钉死 pnpm@11.7.0)pnpm install # 根目录执行
pnpm run typecheck # 通过即环境就绪
pnpm install 会顺带配置两件容易忽略的事:worktree 本地的 Lefthook hooks(注意:是 worktree 级而非全局 git 级,官方为此写了专门的安全契约笔记)和 dsh-translation-pairing Git merge driver(中英文档配对合并)。从缓存恢复依赖后如果缺了这两样,手动跑 node scripts/install-lefthook.mjs。
| 目录 | 内容 |
|---|---|
packages/ | 40+ 插件包(core/llm/tools/session/boot/bundle…),产品主体 |
apps/ | 独立应用(如 Electron 桌面端) |
docs/ | 架构与子系统文档(52 篇 subsystems + 教程 + 复盘) |
.agents/ | Agent Notes(907 篇设计决策)与 agent skills |
scripts/ | 校验与生成脚本(大量 CI 门禁的载体) |
vendor/ | vendored Cordis 框架及同步流程 |
python/ | Python SDK |
native/ | 原生组件 |
benchmarks/ | 基准测试 |
website/ | 官方文档站 |
从开发指南就能读出整个项目的治理风格:凡是重要约定,背后都有一篇 Agent Note 拥有其 rationale,且由一个 scripts/ 下的校验脚本机械执行。hooks 路径安全、翻译配对、应用入口防绕过(verify-application-entrypoints)、笔记格式……规则不是写在 wiki 里的君子协定,而是 CI 里的硬门禁。
下一步:跑起来之后从 docs/architecture.md 进入源码;遇到看不懂的约定,先去设计笔记搜。