How to Use Windmill

Getting started with Windmill

In this guide, you'll learn how to quickly set up Windmill and create your first automated workflow. By the end, you’ll be able to transform your scripts into functional applications and tools with ease.

Step 1: Sign up and set up

1. Go to Windmill's website.
2. Click on the Get Started button at the top right.
3. Choose the Cloud option if you want to use the free tier, or select Self-hosted for the open-source version.
4. For the Cloud version, fill in your details to create an account, and verify your email.
5. Log in to your new Windmill account.

Step 2: Your first workflow

1. Once logged in, click on the New Workflow button on your dashboard.
2. In the workflow editor, start by adding a script. Click on Add Step and select Script.
3. Write your script in the provided code editor. For example, create a simple function that fetches data from an API.
4. Next, click on Add Step again and choose API to create an endpoint for your workflow.
5. Configure the API settings by specifying the method (GET, POST, etc.) and linking it to the script you just created.
6. Click Save to save your workflow, then click Run to execute it.

Step 3: Get better results

• Use Variables to store data between steps. Click on Add Variable to define reusable data points.
• Explore the AI Suggestions feature by clicking on the AI button in the editor. This can help optimise your scripts.
• Set up Triggers to automate your workflows. Go to the Triggers tab and select the events that will start your workflow automatically.

Pro tip

Use the Import feature to bring in existing scripts from your local machine. This can save time instead of rewriting them from scratch.

Common mistake to avoid

Avoid skipping the Testing phase. Always run your workflow after making changes to ensure everything functions correctly. This can prevent issues later when you deploy your tool.