windmill-cli

library1.688.0jsnpmunverified

The Windmill CLI (`wmill`) is a command-line interface tool designed for direct interaction with Windmill instances, an open-source platform for building and running workflows and internal tools. It provides comprehensive capabilities for managing Windmill workspaces, including adding and switching between them, and syncing resources like scripts and flows. Developers can use `wmill` to run scripts and flows, passing inputs via JSON or files, and stream execution logs directly in the terminal. The CLI supports pushing and pulling entire workspaces or individual resources, with an upcoming default shift to YAML for synchronization. As of version 1.688.0, the package demonstrates a rapid release cadence, with frequent updates incorporating new features and bug fixes, often multiple times per week, indicating active development and continuous improvement. It also offers user management features and shell autocompletion for various shells like Bash, Fish, and Zsh.

devops workflow

npm install windmill-cli

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · WINDMILL-CLI

windmill-cli

devopsjavascriptv1.688.0

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

wmill

✓ wmill <command>

✗ import { wmill } from 'windmill-cli'

The `windmill-cli` package provides a command-line executable named `wmill`. Its functionalities are accessed via shell commands in your terminal, not direct JavaScript/TypeScript `import` or CommonJS `require` statements into your code.

wmill workspace add

✓ wmill workspace add

✗ import { workspace } from 'windmill-cli'; workspace.add();

Workspace management is a core CLI function. To add a workspace, execute `wmill workspace add` in your terminal and follow the interactive prompts. This command is not available as a programmatic import.

wmill script run

✓ wmill script run u/username/path/to/script --data '{"input": "value"}'

✗ import { runScript } from 'windmill-cli'; runScript('u/username/path/to/script', { input: 'value' });

Executing Windmill scripts or flows is performed via the CLI. Inputs are passed as a JSON string or from a file using the `--data` flag. The output and logs are streamed directly to the console.

Demonstrates how to install the Windmill CLI globally, configure a workspace, execute a Windmill script with data inputs, and pull workspace resources locally.

npm install -g windmill-cli # Add a new workspace configuration (follow interactive prompts) wmill workspace add # Example: Running a simple script (replace 'u/your_user/hello_world' with an actual script path) # Ensure 'hello_world' exists in your Windmill instance. wmill script run u/your_user/hello_world --data '{"name": "Registry Expert"}' # Alternatively, pass data from a file: echo '{"greeting": "Hello from Registry!"}' > script-inputs.json wmill script run u/your_user/another_script --data @script-inputs.json # Synchronize and pull all workspace resources to your local directory in YAML format wmill sync pull --yaml

wmill --version

Debug

Known issues

gotchaThe `wmill sync push` and `wmill sync pull` commands will soon default to YAML format for resource synchronization, instead of JSON. Users currently relying on JSON output or input should be aware of this impending change.

fix

To ensure future compatibility, begin using the `--yaml` flag explicitly with `wmill sync` commands. If you require JSON, use the `--json` flag, but be aware that YAML will become the default behavior.

affects: >=1.686.0

gotchaCustomizing AI guidance bundles (e.g., for `wmill init`) currently relies on setting specific internal environment variables like `WMILL_INIT_AI_SKILLS_SOURCE`. This approach might be considered an internal interface and is subject to change without public API warnings.

fix

When using `wmill init` for custom AI guidance, set the relevant `WMILL_INIT_AI_*_SOURCE` environment variables prior to executing the command. Consult the latest documentation or codebase for the most current variable names and usage.

affects: >=1.686.0

gotchaThe Windmill CLI maintains a very rapid release cadence, often deploying multiple new versions (features and bug fixes) within days. This frequent update cycle, while beneficial for new features, can introduce minor behavioral changes not explicitly highlighted as 'breaking' in release notes.

fix

Regularly update the CLI using `wmill upgrade` to stay current. If unexpected behavior occurs after an upgrade, consult the GitHub release notes for the specific version for any undocumented changes or adjustments.

affects: >=1.0.0

Errors

Common errors & fixes

wmill: command not found

The `windmill-cli` package was not installed globally, or the global npm bin directory is not included in your system's PATH environment variable.

fix

Ensure `windmill-cli` is installed globally using `npm install -g windmill-cli` (or `pnpm add -g windmill-cli`, `yarn global add windmill-cli`). Verify your system's PATH configuration to include npm's global executable directory.

Error: Failed to connect to Windmill instance. Check your API token and endpoint.

The CLI was unable to establish a connection or authenticate with the configured Windmill instance, typically due to incorrect endpoint URL, an expired API token, or network issues.

fix

Run `wmill workspace add` to create a new workspace configuration, providing the correct Windmill API endpoint and a valid API token. If a workspace is already configured, use `wmill workspace switch <name>` to ensure the active workspace settings are correct.

Error: Invalid JSON input for --data. Expected valid JSON string or @<filename>.

The `--data` argument provided to a `wmill flow run` or `wmill script run` command contained malformed JSON, or the specified file (`@<filename>`) does not exist or contain valid JSON.

fix

Verify that the JSON string passed directly is syntactically correct and properly escaped. If using a file, ensure the file path is correct and its content is valid JSON. For reading from stdin, use `-d @-`.

Error: PostgreSQL connection failed

When attempting to run local tests for `windmill-cli`, a PostgreSQL database instance is either not running or the `DATABASE_URL` environment variable is not correctly configured.

fix

Ensure a local PostgreSQL database is running (default connection string `postgres://postgres:changeme@localhost:5432`). Alternatively, set the `DATABASE_URL` environment variable to point to your PostgreSQL instance before executing test commands like `bun test test/`.

Upgrade

Version history

1.688.0latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

50 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/windmill-labs/windmill ↗

packagehttps://www.npmjs.com/package/windmill-cli ↗

homepagehttps://www.windmill.dev ↗