Files
windmill/cli
6f4124e9a0 feat: reference existing HashiCorp Vault secrets from secret variables (#12078)
* feat: reference existing HashiCorp Vault secrets from secret variables

A secret variable can hold `$external:vault://<path>#<key>` instead of a
value. The reference is resolved from Vault each time the variable is
read, so the value is never stored in Windmill. An instance-level
allow-list of path prefixes, optionally per workspace, is checked when a
reference is saved and again when it is resolved. Other schemes are
parsed and refused as unsupported backends.

Adds AppRole as a Vault auth method, an "External reference" toggle in
the variable editor and an instance settings section for the connection
and the allow-list.

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

* chore: point ee-repo-ref at the external secret references branch

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

* fix: keep external secret references intact on delete, deploy and export

- Deleting a reference no longer runs the managed backend cleanup, which
  could delete the secret it points at.
- Deploying a variable to another workspace copies the reference, which
  the target's allow-list then checks, instead of its resolved value.
- A plain-secrets workspace export writes references verbatim.
- Reference paths reject backslashes, `#` and control characters, which
  the URL parser would otherwise normalize past the allow-list.

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

* fix: skip external secret references in key rotation and the read cache

- Workspace key rotation no longer tries to decrypt references.
- `get_value?allow_cache=true` does not cache a resolved reference, so
  Vault rotation and allow-list changes apply on the next read.
- `VaultSettings.mount_path` is optional in the OpenAPI spec, matching
  its serde default.

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

* chore: keep the OSS Vault reader stub public and regenerate workspace tool schemas

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

* fix: restrict external secret references to workspace admins and keep them out of the managed Vault storage

Creating, repointing or removing a reference now takes a workspace admin, on
create and update including already-encrypted pushes and cross-workspace
deploys; the variable form disables the toggle and fields for anyone else.

A reference into the storage of Windmill's own Vault secret backend (same
address, namespace folded into the path) is refused on save and on resolve,
whatever the allow-list says.

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

* fix: compare external secret references as written in workspace comparison

Two references that currently resolve to the same value still point at
different secrets, so comparing their resolved values hid a repoint from the
diff and from deployment.

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

* feat: let external secret references reuse the Vault backend connection

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

* feat: hide the external reference toggle from non-admins unless already set

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

* feat: read whole Vault secrets, show allowed paths, and pick the variable type in one control

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

* fix: mask JSON fields only for whole Vault secrets, and skip PEM armor and JSON lines

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

* fix: align the reference editor and settings warning with the form and alert guidelines

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

* feat: let a saved reference become non-secret directly, and warn when no prefix is allowed

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

* fix: save an empty value when a reference is switched to another type

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

* fix: keep a saved reference's baseline through type round trips

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

* fix: drop an unused binding in the reference parser

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

* fix: offer vault reference only when a vault path is allowed

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

* chore: update ee-repo-ref to c0fd22ba77e6618cea7611d72fe2e75c8855c595

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

Previous ee-repo-ref: 56cba4e7771e7a87e56a67eb115549a31dd12b1a

New ee-repo-ref: c0fd22ba77e6618cea7611d72fe2e75c8855c595

Automated by sync-ee-ref workflow.

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
Co-authored-by: Ruben Fiszel <ruben@windmill.dev>
Co-authored-by: windmill-internal-app[bot] <windmill-internal-app[bot]@users.noreply.github.com>
2026-10-30 20:23:27 +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