write-flow

What problem does it solve?

Designing and deploying Windmill flows can be error-prone and manual. This guide gives a structured approach to authoring flow definitions, validating structure against the OpenFlow schema, and deploying changes with deterministic tooling.

Core Features & Use Cases

• Flow creation: Create a folder ending with .flow and add a YAML file with the flow definition.
• Inline scripting: For rawscript modules, use !inline path/to/script.ts to embed code.
• Deployment workflow: After writing, generate lock files with wmill flow generate-locks --yes and deploy with wmill sync push.
• OpenFlow as source of truth: Use openflow.openapi.yaml as the authoritative schema; understand module IDs, input transforms, and resource references.

Quick Start

Create a new folder named my_flow.flow, add flow.yaml with your flow definition, then run wmill flow generate-locks --yes followed by wmill sync push to deploy.