write-flow

Create Windmill OpenFlow workflows with structured templates and schema guidance.

17.5k|1.1k|Updated May 5, 2022
One-click install
npx skills add https://github.com/windmill-labs/windmill --skill write-flow
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: write-flow
Source: https://github.com/windmill-labs/windmill/tree/main/system_prompts/auto-generated/skills/write-flow
Command: npx skills add https://github.com/windmill-labs/windmill --skill write-flow

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill provides structured guidance and ready-to-use templates to build Windmill OpenFlow workflows, reducing manual drafting errors and setup time.

Core Features & Use Cases

  • Provides guidelines for creating flow definitions, ensuring unique module IDs, and aligning with the OpenFlow schema.
  • Documents common pitfalls and best practices for flow design and deployment.
  • Use Case: A developer wants to create a new flow to process user events and route them through a sequence of steps, tests, and deployments.

Quick Start

Create a new flow folder, define a YAML file with the flow, and reference scripts or subflows as needed. Then run the Windmill CLI to generate locks and deploy.

Frequently Asked Questions about write-flow

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I create a Windmill flow using YAML?

Creating a Windmill flow involves defining a YAML file that adheres to the OpenFlow schema, specifying module IDs, script references, and subflows. Structure your flow with unique module identifiers, reference inline rawscript or path-based scripts, then deploy using the Windmill CLI to generate locks and push to your environment.

What is the OpenFlow schema and why does it matter for flow design?

The OpenFlow schema is the structured specification that Windmill flows must follow to execute correctly. Adhering to it ensures your flow definitions are valid, prevents module ID conflicts, and enables proper routing of data through sequences of steps, tests, and deployments.

How do I avoid common errors when building Windmill workflows?

Common pitfalls include duplicate module IDs, incorrect script path references, and schema violations. This Skill documents best practices for flow design, module naming, and error handling to reduce manual drafting errors and deployment issues before they reach production.

Can I use subflows and inline scripts together in the same Windmill flow?

Yes. Windmill flows support both inline rawscript and path-based script references, as well as subflows. You can mix these approaches within a single flow definition to compose modular workflows that process events, apply tests, and route to deployments.

What steps do I follow to deploy a Windmill flow across environments?

Create a flow folder with a YAML file conforming to OpenFlow schema, reference your scripts or subflows, run the Windmill CLI to generate locks, then deploy. This ensures consistent configuration and error handling rules are applied as your flow moves across dev, test, and production environments.

Do I need templates to build Windmill flows, or can I write them manually?

While manual authoring is possible, using ready-to-use templates reduces setup time and drafting errors. Templates provide scaffolding aligned with OpenFlow schema conventions, module ID patterns, and best practices for defining multi-step workflows and error handlers.