用途:在 Windmill 工作区中编写 Rust 脚本,并选择正确的命令进行本地预览、运行、生成元数据与部署。
主要能力与结构:脚本必须包含 main 函数,参数使用 owned 类型,返回类型需可序列化(#[derive(Serialize)])且为 anyhow::Result<T>。依赖以脚本开头的部分 cargo.toml 声明,例如注释块中写 [dependencies]。Serde 已内置无需重复添加。异步场景保持 main 同步,在内部创建 tokio runtime 并用 rt.block_on 执行异步逻辑。
常用命令:wmill script preview <script_path> 迭代本地脚本时默认使用,运行本地文件但不部署;wmill script run <path> 运行工作区已部署版本,仅当用户明确要求测试已部署版本时使用;wmill generate-metadata 重新生成本地 .script.yaml 输入 schema 与 .lock 依赖,并刷新 wmill-lock.yaml 中的内容哈希,仅写本地文件。可用 --dry-run 列出过期的项及原因,或用路径参数缩小范围;wmill generate-metadata rehash 仅从磁盘重新记录哈希。部署通过 git push 或 wmill sync push,仅在用户明确要求部署时执行。可用 wmill resource-type list --schema 发现资源类型;需要打开开发页预览时使用 preview 技能。
元数据同步:编辑脚本内容(尤其增删 import 或改动 main 参数)会使哈希失效,需运行 generate-metadata 保持 .lock、.script.yaml 与 wmill-lock.yaml 一致,否则 git-sync 与 CI 会产生多余差异。重新解析依赖可能提升未固定版本,运行后应比对并告知用户版本变化,可在代码中固定版本。
限制与注意事项:preview 不部署但会执行代码,可能产生副作用,需在用户要求或确认后运行;生成元数据只写本地文件,但默认先征询用户,除非项目 AGENTS.md 声明自动运行。若用户已要求测试,直接执行 wmill script preview <path> -d '<args>',无需再提供多选项菜单。