Yoda
参考

.yoda.json

项目级配置文件完整参考

.yoda.json 放在仓库根目录,建议提交到 git,让团队所有成员的 worktree 行为一致。

完整示例

{
  "preservePatterns": [
    ".env",
    ".env.keys",
    ".env.local",
    ".env.*.local",
    ".envrc",
    "docker-compose.override.yml"
  ],
  "scripts": {
    "setup": "pnpm install",
    "run": "pnpm dev",
    "teardown": ""
  },
  "shellSetup": "",
  "scriptSetupTimeout": 5000
}

字段说明

字段类型说明
preservePatternsstring[]创建 worktree 时从主工作目录复制过来的文件(glob 模式)。典型用途:不在 git 里的环境变量文件
scripts.setupstringworktree 创建后、任务执行前运行。典型用途:安装依赖
scripts.runstring项目的启动命令
scripts.teardownstring任务完成后运行。典型用途:清理资源
shellSetupstring交互式终端(PTY)启动前 source 的脚本
scriptSetupTimeoutnumbersetup 脚本超时(毫秒)

注意事项

preservePatterns 复制的常常是密钥文件。它们只在本机 worktree 之间复制、不会上传到任何地方,但请确认这些文件本身在 .gitignore 里。

  • SSH 远程项目同样读取仓库里的 .yoda.json,setup 在远程主机上执行
  • setup 失败或超时不会阻止任务创建,但 agent 可能在缺依赖的环境里工作——保持 setup 快而可靠

On this page