Skip to main content

Getting Started

Windmill is an open-source platform to build all your internal tools (endpoints, workflows, UIs) through the combination of code (in Typescript, Python, Go, Bash, SQL or any docker image) and low code builders.

Windmill can be self-hosted or used on a cloud version.

Self-Host Windmill

You can choose to self-host Windmill on your own infra.

Run it at scale on kubernetes using our helm charts or use a docker-compose for smaller setups.

Use Windmill Cloud

Windmill provides a Cloud App.

You can sign-up using your GitHub, GitLab, Google, Microsoft Single Sign-On. No Credit Cards required and we will spare your inbox.

Any user will be provided with 1,000 monthly executions from our Community Plan and added to the Demo workspace. From there, users can create workspaces for free and create scripts, workflows and UIs.

And if you feel like it, upgrade for unlimited executions.

Local Development

Windmill has its own integrated development environment, but you can also develop and run scripts locally, both with self-hosted and cloud instances.

From a VS Code extension to a solid setup for deploying to production using Git sync, Windmill offers several ways to interact locally with the platform.

Where to Start?

Windmill is a feature-rich developer platform to build endpoints, cron jobs, workflows & UIs. Each of these features can be used standalone.

However the 3 core layers of Windmill, namely Scripts, Flows and Apps are complementary. Scripts are the smallest "unit" of abstraction and workflows and UIs rely on them.

  • Have a look at our quickstarts (on Scripts, Flows or Apps) that give an introduction on how to build your first ones.
  • Check how to trigger scripts and trigger flows to get an idea of what you could do with Windmill.
  • Play with Windmill: Cloud App or Self-Hosting. Our cloud Demo workspace showcases some speaking examples.
  • Browse Windmill Hub and explore templates shared by the community.