Skip to content

Commit 4929335

Browse files
claude[bot]windmill-internal-app[bot]centdix
authored
docs: update VSCode extension documentation with new features (#1060)
* docs: update VSCode extension documentation with new features - Add CLI workspace settings integration info - Document wmill init command''s AI file creation features (cursor rules, CLAUDE.md) - Add flow.yaml validation syntax feature Co-authored-by: windmill-internal-app[bot] <windmill-internal-app[bot]@users.noreply.github.com> * better * cleaning --------- Co-authored-by: claude[bot] <209825114+claude[bot]@users.noreply.github.com> Co-authored-by: windmill-internal-app[bot] <windmill-internal-app[bot]@users.noreply.github.com> Co-authored-by: centdix <[email protected]>
1 parent 4a0d36c commit 4929335

File tree

3 files changed

+27
-5
lines changed
  • changelog/2025-08-12-vscode-syntax-and-config
  • docs

3 files changed

+27
-5
lines changed
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
slug: vscode-syntax-and-config
3+
version: v1.523.0
4+
title: VS Code improvements
5+
tags: ['VS Code']
6+
description: Two new improvements on the VS Code extension. It will now automatically sync its workspaces configuration with the windmill CLI ones, and has yaml syntax validation for flow.yaml files.
7+
features:
8+
[
9+
'Flow.yaml syntax validation',
10+
'Workspace configuration sync with CLI',
11+
]
12+
docs: /docs/cli_local_dev/vscode-extension
13+
---

docs/advanced/4_local_development/index.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -302,6 +302,10 @@ Syncing directly from the CLI is great, but instead of using the CLI directly, y
302302
/>
303303
</div>
304304

305+
## LLMs rules for local development
306+
307+
The `wmill init` command will create cursor rules and CLAUDE.md files to enhance your AI experience when working with scripts and flows. These files provide context and guidelines for AI assistants to better assist you in creating scripts and flows that match Windmill's guidelines. You can safely delete them if you do not use LLMs on your local development.
308+
305309
## Run locally
306310

307311
Windmill has its [own integrated development environment](../../code_editor/index.mdx). But for iteration, integration with CI/CD and testing purposes you may need to run a script locally that also interacts with Windmill (for example, to retrieve resources). It will allow you to integrate Windmill with any testing framework.

docs/cli_local_dev/1_vscode-extension/index.mdx

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -58,13 +58,11 @@ First of all, have your workspace synced locally with [Windmill CLI](../../advan
5858

5959
With [wmill sync pull](../../advanced/3_cli/sync.mdx#pulling) and [wmill sync push](../../advanced/3_cli/sync.mdx) you can synchronize your remote workspace to a local directory which you would version with GitHub / GitLab.
6060

61-
In the settings menu, set the remote url, workspace name and [token](../../core_concepts/4_webhooks/index.mdx#user-token).
61+
Then you can:
6262

6363
1. Install the [extension](https://marketplace.visualstudio.com/items?itemName=windmill-labs.windmill).
6464

65-
2. Enter your Windmill remote URL and [token](../../core_concepts/4_webhooks/index.mdx#user-token), so the extension can execute scripts and flows on your workspace.
66-
67-
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](../../core_concepts/13_json_schema_and_parsing/index.mdx#json-schema-in-windmill) required by Windmill).
65+
2. 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](../../core_concepts/13_json_schema_and_parsing/index.mdx#json-schema-in-windmill) required by Windmill).
6866

6967
All details to set up the workspace folder:
7068

@@ -120,6 +118,10 @@ Editing the flow from the UI immediately modifies the YAML definition
120118
src="/videos/yaml_to_ui.mp4"
121119
/>
122120

121+
### Flow YAML validation
122+
123+
The VS Code extension includes syntax validation for flow.yaml files, making it easier to spot mistakes and ensure your flows are properly formatted before testing or deployment.
124+
123125
### Infer lockfile or use current lockfile
124126

125127
With this toggle, you can choose to use the metadata lockfile ([derived from](../../advanced/3_cli/script.md#packagejson--requirementstxt) package.json or requirements.txt after [`wmill script generate-metadata`](../../advanced/3_cli/script.md#re-generating-a-script-metadata-file)) instead of inferring them directly from the script.
@@ -142,15 +144,18 @@ Access these commands through the Command Palette (Ctrl/Cmd+Shift+P):
142144

143145
## Settings
144146

147+
The extension automatically uses workspace settings from your Windmill CLI configuration if available. This provides seamless integration between the CLI and VS Code extension without needing to configure settings separately.
148+
145149
The extension provides the following settings:
146150

147151
| Setting | Description |
148152
| ------------------------------- | ------------------------------------------------------------------------------------------------------------ |
149153
| `windmill.remote` | The full remote URL including http and trailing slash. By default, it's "https://app.windmill.dev/". |
150154
| `windmill.workspaceId` | The workspace id to use. |
151-
| `windmill.token` | The token to use to authenticate with the remote and workspace. |
155+
| `windmill.token` | The [token](../../core_concepts/4_webhooks/index.mdx#user-token) to use to authenticate with the remote and workspace. |
152156
| `windmill.additionalWorkspaces` | The list of additional remotes to use. This allows you to set up multiple workspaces for different projects. |
153157
| `windmill.currentWorkspace` | The workspace name currently used (if multiple). main or empty is the default one. |
158+
| `windmill.configFolder` | Override the CLI config folder path to fetch the workspace settings from. |
154159

155160
![demo](./wm-settings.png.webp)
156161

0 commit comments

Comments
 (0)