Skip to main content

VS Code Extension

The Windmill VS Code extension allows you to build scripts and flows in the comfort of your VS Code Editor, while leveraging Windmill UIs for test & flows edition.

VS Code Extension

The extension can be used in particular from a repository synchronized to a Windmill instance to develop scripts & flows locally while keeping them synced to your workspace.


Windmill has its own IDE for creating scripts and flows from the Windmill application (cloud or self-hosted).

The Windmill UI allows you to edit directly the deployed scripts & flows, which is great for maintenance and quick prototyping.

However in many production settings it is more common to version everything from Git and to that end we have a CLI to sync a workspace to a local directory and the inverse operation (deploy local directory to a workspace). With this extension, you can efficiently edit scripts & flows directly from there.

To run scripts locally, see Run Locally.

Installation

First of all, have your workspace synced locally with Windmill CLI.

Local workspace

Example repo opened in VS Code. We see 2 flows and 1 script, the flows are their own folders, each step in a flow is a seperate file in their respective language. Scripts have their metadata in a seperate file.


With wmill sync pull and wmill sync push you can synchronize your remote workspace to a local directory which you would version with GitHub / GitLab.

In the settings menu, set the remote url, workspace name and token.

  1. Install the extension.

  2. Enter your Windmill remote URL and token, so the extension can execute scripts and flows on your workspace.

  3. From any script file, use > Windmill: Run preview in the current editor or Ctrl+Enter and Shift+Enter to generate the UI preview (provided that the script meets the few rules required by Windmill).

All details to set up the workspace folder:

Actions

The preview & run will work for any script meeting the specific language requirements (main function, imports) and being named with the dedicated file extension (.py, .go etc.). For scripts in Bun, name the file [name].bun.ts, ".ts" being by default Deno.

The extension will split your screen and display a panel. That panel will update automatically based on the edited document on the left.

In particular:

Test scripts, flows and flows steps

Once you have your scripts and flows locally (either pulled from a remote workspace or created from scratch), you can test them directly from VS Code.

Update UI from YAML

Editing the YAML definition of a flow instantly updates the rendered graph

Update YAML from UI

Editing the flow from the UI immediately modifies the YAML definition

Infer lockfile or Use current lockfile

With this toggle, you can choose to use the metadata lockfile instead of inferring them directly from the script.

Toggle Lockfile

To learn more about lockfile, see Local Development.

Commands

Access these commands through the Command Palette (Ctrl/Cmd+Shift+P):

CommandDescription
Windmill: Show PreviewThis command launches a preview of your script in a new tab.
Windmill: Run previewRuns the current script and provides a preview within the VS Code environment. This feature lets you preview your work without leaving your code editor.
Windmill: Configure remote, workspace, and tokenOpens a setup wizard to configure your environment. This includes settings for the remote URL, workspace, and user token. You only need to do this once or when changing your environment settings.
Windmill: Switch windmill workspaceAllows you to switch between different workspaces.
Windmill: add a windmill workspaceAdds a new workspace to your configuration.

Settings

The extension provides the following settings:

SettingDescription
windmill.remoteThe full remote URL including http and trailing slash. By default, it's "https://app.windmill.dev/".
windmill.workspaceIdThe workspace id to use.
windmill.tokenThe token to use to authenticate with the remote and workspace.
windmill.additionalWorkspacesThe list of additional remotes to use. This allows you to set up multiple workspaces for different projects.
windmill.currentWorkspaceThe workspace name currently used (if multiple). main or empty is the default one.

demo

You can create a user token in the Windmill app. Follow the instructions in the Windmill docs.