Files
windmill/cli
Guilhem Lemouel f9e2370478 fix: translate folder principals when the compare page copies a folder
`CompareWorkspaces.svelte` deploys folders through the shared `deployItem`, whose
folder branch built both the create and the update body from `owners`,
`extra_perms` and `summary` alone. Two consequences, both of which #10354 had
already fixed on the one path it touched:

`default_permissioned_as` and `labels` never crossed. A copied folder applies no
create-time identity rules, so an item deployed into it carrying no `on_behalf_of`
of its own runs as whoever deployed it rather than as the principal the source
folder would have chosen.

`u/<username>` principals crossed verbatim, and a username is per-(workspace,
email). The same username in the target can be a different account, which then
receives folder ownership or ACL access and can be selected by an identity rule.

Principals are now resolved source username -> email -> target username, since
email is the only identifier stable across workspaces; groups match by name,
read from `listGroups` (the workspace's own `group_` rows) rather than
`listGroupNames`, which unions in instance groups that folder rule resolution
does not accept. The two kinds of unresolvable principal are separated because
they fail differently: an owner or ACL entry is dropped and reported, which can
only narrow the folder and leaves the creator owning it; an identity rule refuses
the copy, because dropping it runs items as the deployer and carrying it creates
a folder the server then rejects every deploy into.

The fix lands twice on purpose. The shared package is the real home and fixes
`wmill workspace merge`, but the frontend consumes the published
`windmill-utils-internal`, so the compare page needs the mirror in
`utils_workspace_deploy.ts` until that version ships and the dependency is
bumped — the same arrangement #10354 used for `makeProvider`.

`perPage` was documented as "default 30, max 100" while `paginate()` uses
1000/10000; that wrong comment is what made the merged PR read groups a page at a
time and miss them. Corrected, and the two generated artifacts derived from the
spec regenerated.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-08-05 16:11:52 +02:00
..
2022-11-01 15:53:28 +01:00
2023-02-03 19:49:46 +01:00
2026-02-23 09:09:16 +00:00
2025-12-26 20:32:42 +00:00

Windmill CLI

A simple CLI allowing interactions with windmill from the command line.

You can find more information in Windmill Docs

Installation

Install the wmill CLI tool using npm install -g windmill-cli.

Update to the latest version using wmill upgrade.

Workspaces

To get started run wmill workspace add or use the instructions from the workspace settings.

Running Flows & Scripts

Run a script or flow using wmill flow/script run u/username/path/to/script and pass any inputs using --data + Inputs specified as a JSON string or a file using @ <filename> or stdin using @-.

Curl-style syntax using -d @- for stdin or -d @<filename> is also supported.

Flow Steps and Logs will be streamed during execution automatically.

CLI input example

Pushing Resources, Scripts & More

The CLI can push specifications to a windmill instance. See the examples/ folder for formats.

Switch to a different workspace

wmill workspace switch <workspace_name>

Sync a workspace

Pull

wmill sync pull

Push

wmill sync push

We recommend using the --yaml option to use yaml instead of json as the encoding format. Yaml will be made the default soon.

Pushing individual files

You can push individual resources using wmill <type> push <file_name> \<remote_name\>. This does not require a special folder layout or file name, as this is given at runtime.

Listing

All commands support listing by just not providing a subcommand, ie wmill script will result in a list of scripts. Some allow additional options, learn about this by specifying --help.

User Management

You can add & remove users via wmill user add/remove, and list them using wmill user

Pulling

You can pull the entire workspace using wmill pull

Completion

The CLI comes with completions out of the box via wmill completions <shell>. (Via cliffy)

Bash

To enable bash completions add the following line to your ~/.bashrc:

source <(wmill completions bash)

Fish

To enable fish completions add the following line to your ~/.config/fish/config.fish:

source (wmill completions fish | psub)

Zsh

To enable zsh completions add the following line to your ~/.zshrc:

source <(wmill completions zsh)

Development

AI Guidance Variants

wmill init can now materialize alternate AI guidance bundles without changing the generated defaults in the repo, but this is exposed as internal env-var overrides rather than public CLI flags.

Examples:

WMILL_INIT_AI_SKILLS_SOURCE=/path/to/custom/skills wmill init --use-default
WMILL_INIT_AI_SKILLS_SOURCE=/path/to/custom/skills WMILL_INIT_AI_AGENTS_SOURCE=/path/to/AGENTS.md wmill init --use-default
WMILL_INIT_AI_SKILLS_SOURCE=/path/to/custom/skills WMILL_INIT_AI_CLAUDE_SOURCE=/path/to/CLAUDE.md wmill init --use-default

This is the same guidance-writing path used by the benchmark CLI under ai_evals/, so the benchmark harness and wmill init now generate the same project guidance shape:

  • AGENTS.md
  • CLAUDE.md
  • .agents/skills/*
  • .claude/skills/*

windmill-yaml-validator

wmill lint imports the sibling windmill-yaml-validator package from source rather than from npm, so its schemas always match the OpenAPI specs of the current checkout. bun install regenerates them through this package's preinstall script; run it again after editing openflow.openapi.yaml or backend/windmill-api/openapi.yaml:

npm --prefix ../windmill-yaml-validator run gen

Running Tests

Prerequisites:

  • PostgreSQL running locally (default: postgres://postgres:changeme@localhost:5432)
  • Rust toolchain installed

Run tests locally (full features):

bun test test/

Run tests in CI mode (minimal features, skips EE tests):

CI_MINIMAL_FEATURES=true bun test test/
Variable Description
CI_MINIMAL_FEATURES Set to true to skip EE-dependent tests
DATABASE_URL PostgreSQL connection string
EE_LICENSE_KEY Enterprise license key for EE features