cli-commands

Windmill CLI Commands

The Windmill CLI (wmill) provides commands for managing scripts, flows, apps, and other resources.

Current version: 1.651.1

Global Options

• --workspace <workspace:string> - Specify the target workspace. This overrides the default workspace.
• --debug --verbose - Show debug/verbose logs
• --show-diffs - Show diff informations when syncing (may show sensitive informations)
• --token <token:string> - Specify an API token. This will override any stored token.
• --base-url <baseUrl:string> - Specify the base URL of the API. If used, --token and --workspace are required and no local remote/workspace already set will be used.
• --config-dir <configDir:string> - Specify a custom config directory. Overrides WMILL_CONFIG_DIR environment variable and default ~/.config location.

Commands

app

app related commands

Options:

• --json - Output as JSON (for piping to jq)

Subcommands:

• app list - list all apps
  • --json - Output as JSON (for piping to jq)
• app get <path:string> - get an app's details
  • --json - Output as JSON (for piping to jq)
• app push <file_path:string> <remote_path:string> - push a local app
• app dev [app_folder:string] - Start a development server for building apps with live reload and hot module replacement
  • --port <port:number> - Port to run the dev server on (will find next available port if occupied)
  • --host <host:string> - Host to bind the dev server to
  • --entry <entry:string> - Entry point file (default: index.ts for Svelte/Vue, index.tsx otherwise)
  • --no-open - Don't automatically open the browser
• app lint [app_folder:string] - Lint a raw app folder to validate structure and buildability
  • --fix - Attempt to fix common issues (not implemented yet)
• app new - create a new raw app from a template
• app generate-agents [app_folder:string] - regenerate AGENTS.md and DATATABLES.md from remote workspace
• app generate-locks [app_folder:string] - re-generate the lockfiles for app runnables inline scripts that have changed
  • --yes - Skip confirmation prompt
  • --dry-run - Perform a dry run without making changes
  • --default-ts <runtime:string> - Default TypeScript runtime (bun or deno)

dependencies

workspace dependencies related commands

Alias: deps

Subcommands:

• dependencies push <file_path:string> - Push workspace dependencies from a local file

dev

Launch a dev server that will spawn a webserver with HMR

Options:

• --includes <pattern...:string> - Filter paths givena glob pattern or path

docs

Search Windmill documentation. Requires Enterprise Edition.

Arguments: <query:string>

Options:

• --json - Output results as JSON.

flow

flow related commands

Options:

• --show-archived - Enable archived flows in output
• --json - Output as JSON (for piping to jq)

Subcommands:

• flow list - list all flows
  • --show-archived - Enable archived flows in output
  • --json - Output as JSON (for piping to jq)
• flow get <path:string> - get a flow's details
  • --json - Output as JSON (for piping to jq)
• flow push <file_path:string> <remote_path:string> - push a local flow spec. This overrides any remote versions.
• flow run <path:string> - run a flow by path.
  • -d --data <data:string> - Inputs specified as a JSON string or a file using @<filename> or stdin using @-.
  • -s --silent - Do not ouput anything other then the final output. Useful for scripting.
• flow preview <flow_path:string> - preview a local flow without deploying it. Runs the flow definition from local files.
  • -d --data <data:string> - Inputs specified as a JSON string or a file using @<filename> or stdin using @-.
  • -s --silent - Do not output anything other then the final output. Useful for scripting.
• flow generate-locks [flow:file] - re-generate the lock files of all inline scripts of all updated flows
  • --yes - Skip confirmation prompt
  • -i --includes <patterns:file[]> - Comma separated patterns to specify which file to take into account (among files that are compatible with windmill). Patterns can include * (any string until '/') and ** (any string)
  • -e --excludes <patterns:file[]> - Comma separated patterns to specify which file to NOT take into account.
• flow new <flow_path:string> - create a new empty flow
  • --summary <summary:string> - flow summary
  • --description <description:string> - flow description
• flow bootstrap <flow_path:string> - create a new empty flow (alias for new
  • --summary <summary:string> - flow summary
  • --description <description:string> - flow description

folder

folder related commands

Options:

• --json - Output as JSON (for piping to jq)

Subcommands:

• folder list - list all folders
  • --json - Output as JSON (for piping to jq)
• folder get <name:string> - get a folder's details
  • --json - Output as JSON (for piping to jq)
• folder new <name:string> - create a new folder locally
  • --summary <summary:string> - folder summary
• folder push <name:string> - push a local folder to the remote by name. This overrides any remote versions.
• folder add-missing - create default folder.meta.yaml for all subdirectories of f/ that are missing one
  • -y, --yes - skip confirmation prompt

gitsync-settings

Manage git-sync settings between local wmill.yaml and Windmill backend

Subcommands:

• gitsync-settings pull - Pull git-sync settings from Windmill backend to local wmill.yaml
  • --repository <repo:string> - Specify repository path (e.g., u/user/repo)
  • --default - Write settings to top-level defaults instead of overrides
  • --replace - Replace existing settings (non-interactive mode)
  • --override - Add branch-specific override (non-interactive mode)
  • --diff - Show differences without applying changes
  • --json-output - Output in JSON format
  • --with-backend-settings <json:string> - Use provided JSON settings instead of querying backend (for testing)
  • --yes - Skip interactive prompts and use default behavior
  • --promotion <branch:string> - Use promotionOverrides from the specified branch instead of regular overrides
• gitsync-settings push - Push git-sync settings from local wmill.yaml to Windmill backend
  • --repository <repo:string> - Specify repository path (e.g., u/user/repo)
  • --diff - Show what would be pushed without applying changes
  • --json-output - Output in JSON format
  • --with-backend-settings <json:string> - Use provided JSON settings instead of querying backend (for testing)
  • --yes - Skip interactive prompts and use default behavior
  • --promotion <branch:string> - Use promotionOverrides from the specified branch instead of regular overrides

hub

Hub related commands. EXPERIMENTAL. INTERNAL USE ONLY.

Subcommands:

• hub pull - pull any supported definitions. EXPERIMENTAL.

init

Bootstrap a windmill project with a wmill.yaml file

Options:

• --use-default - Use default settings without checking backend
• --use-backend - Use backend git-sync settings if available
• --repository <repo:string> - Specify repository path (e.g., u/user/repo) when using backend settings
• --bind-profile - Automatically bind active workspace profile to current Git branch
• --no-bind-profile - Skip workspace profile binding prompt

instance

sync local with a remote instance or the opposite (push or pull)

Subcommands:

• instance add [instance_name:string] [remote:string] [token:string] - Add a new instance
• instance remove <instance:string:instance> - Remove an instance
• instance switch <instance:string:instance> - Switch the current instance
• instance pull - Pull instance settings, users, configs, instance groups and overwrite local
  • --yes - Pull without needing confirmation
  • --dry-run - Perform a dry run without making changes
  • --skip-users - Skip pulling users
  • --skip-settings - Skip pulling settings
  • --skip-configs - Skip pulling configs (worker groups and SMTP)
  • --skip-groups - Skip pulling instance groups
  • --include-workspaces - Also pull workspaces
  • --folder-per-instance - Create a folder per instance
  • --instance <instance:string> - Name of the instance to pull from, override the active instance
  • --prefix <prefix:string> - Prefix of the local workspaces to pull, used to create the folders when using --include-workspaces
  • --prefix-settings - Store instance yamls inside prefixed folders when using --prefix and --folder-per-instance
• instance push - Push instance settings, users, configs, group and overwrite remote
  • --yes - Push without needing confirmation
  • --dry-run - Perform a dry run without making changes
  • --skip-users - Skip pushing users
  • --skip-settings - Skip pushing settings
  • --skip-configs - Skip pushing configs (worker groups and SMTP)
  • --skip-groups - Skip pushing instance groups
  • --include-workspaces - Also push workspaces
  • --folder-per-instance - Create a folder per instance
  • --instance <instance:string> - Name of the instance to push to, override the active instance
  • --prefix <prefix:string> - Prefix of the local workspaces folders to push
  • --prefix-settings - Store instance yamls inside prefixed folders when using --prefix and --folder-per-instance
• instance whoami - Display information about the currently logged-in user
• instance get-config - Dump the current instance config (global settings + worker configs) as YAML
  • -o, --output-file <file:string> - Write YAML to a file instead of stdout
  • --instance <instance:string> - Name of the instance, override the active instance

jobs

Pull completed and queued jobs from workspace

Arguments: [workspace:string]

Options:

• -c, --completed-output <file:string> - Completed jobs output file (default: completed_

---

Content truncated.