Files
windmill/cli
a4ae82fd69 feat: optionally run trigger messages the filters cannot read (#12226)
* fix: route trigger messages the filters cannot parse to the error handler

A Kafka or websocket trigger with filters silently skipped a message that
was not UTF-8 or not JSON, and Kafka committed its offset, so the message
was lost without a trace. Such a message now goes to the trigger's error
handler (script targets) or the workspace error handler, with the raw
payload and its topic/partition/offset.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* fix: take the unfilterable-message handler as a RunnableRef after merging main

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* fix: keep none_of semantics for non-object JSON, honour workspace handler mutes, throttle the no-handler alert

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* docs: state the caller contract of push_error_handler_with_parent

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* chore: point ee-repo-ref at the kafka companion branch

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* fix: hold unparseable-message handlers of a suspended trigger, throttle them on websocket

A suspended trigger now holds the handler run like its other runs, tagged
with the trigger so resuming releases it. Websocket text keepalives would
start a handler run per frame, so websocket caps it at one per trigger per
minute; Kafka keeps one per message. A parentless handler run carries no
token prefix.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* fix: release a held error handler run in place when resuming an edited trigger

Resuming re-pushes runs held before the trigger's last edit against its
target. A held error handler run would then run the target with the
handler's args, so it is released in place.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* feat: add run_on_filter_error to kafka and websocket triggers

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* fix: treat a truncated array as unreadable, not as a filter mismatch

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* chore: update ee-repo-ref to 695eddf214f6a0e6cf1249ee2c20e716788f0766

This commit updates the EE repository reference after PR #954 was merged in windmill-ee-private.

Previous ee-repo-ref: c8a26463f72ed76423b14e6a1aaf6376e58f2c4c

New ee-repo-ref: 695eddf214f6a0e6cf1249ee2c20e716788f0766

Automated by sync-ee-ref workflow.

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
Co-authored-by: windmill-internal-app[bot] <windmill-internal-app[bot]@users.noreply.github.com>
Co-authored-by: Ruben Fiszel <ruben@windmill.dev>
2026-11-05 23:33:47 +01: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