--- name: cli-commands description: MUST use when using the CLI. --- # Windmill CLI Commands The Windmill CLI (`wmill`) provides commands for managing scripts, flows, apps, and other resources. Current version: 1.624.0 ## Global Options - `--workspace ` - 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 ` - Specify an API token. This will override any stored token. - `--base-url ` - 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 ` - Specify a custom config directory. Overrides WMILL_CONFIG_DIR environment variable and default ~\/.config location. ## Commands ### app app related commands **Subcommands:** - `app push ` - 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 to run the dev server on (will find next available port if occupied) - `--host ` - Host to bind the dev server to - `--entry ` - 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 ` - Default TypeScript runtime (bun or deno) ### dependencies workspace dependencies related commands **Alias:** `deps` **Subcommands:** - `dependencies push ` - Push workspace dependencies from a local file ### dev Launch a dev server that will spawn a webserver with HMR **Options:** - `--includes ` - Filter paths givena glob pattern or path ### flow flow related commands **Options:** - `--show-archived` - Enable archived scripts in output **Subcommands:** - `flow push ` - push a local flow spec. This overrides any remote versions. - `flow run ` - run a flow by path. - `-d --data ` - Inputs specified as a JSON string or a file using @ or stdin using @-. - `-s --silent` - Do not ouput anything other then the final output. Useful for scripting. - `flow preview ` - preview a local flow without deploying it. Runs the flow definition from local files. - `-d --data ` - Inputs specified as a JSON string or a file using @ 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 ` - 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 ` - Comma separated patterns to specify which file to NOT take into account. - `flow bootstrap ` - create a new empty flow - `--summary ` - script summary - `--description ` - script description ### folder folder related commands **Subcommands:** - `folder push ` - push a local folder spec. This overrides any remote versions. ### 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 ` - 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 ` - Use provided JSON settings instead of querying backend (for testing) - `--yes` - Skip interactive prompts and use default behavior - `--promotion ` - 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 ` - 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 ` - Use provided JSON settings instead of querying backend (for testing) - `--yes` - Skip interactive prompts and use default behavior - `--promotion ` - 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 ` - 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 ` - Remove an instance - `instance switch ` - 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 ` - Name of the instance to pull from, override the active instance - `--prefix ` - 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 ` - Name of the instance to push to, override the active instance - `--prefix ` - 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 ### jobs Pull completed and queued jobs from workspace **Arguments:** `[workspace:string]` **Options:** - `-c, --completed-output ` - Completed jobs output file (default: completed_jobs.json) - `-q, --queued-output ` - Queued jobs output file (default: queued_jobs.json) - `--skip-worker-check` - Skip checking for active workers before export **Subcommands:** - `jobs pull` - `jobs push` ### queues List all queues with their metrics **Arguments:** `[workspace:string] the optional workspace to filter by (default to all workspaces)` **Options:** - `--instance [instance]` - Name of the instance to push to, override the active instance - `--base-url [baseUrl]` - If used with --token, will be used as the base url for the instance ### resource resource related commands **Subcommands:** - `resource push ` - push a local resource spec. This overrides any remote versions. ### resource-type resource type related commands **Subcommands:** - `resource-type list` - list all resource types - `--schema` - Show schema in the output - `resource-type push ` - push a local resource spec. This overrides any remote versions. - `resource-type generate-namespace` - Create a TypeScript definition file with the RT namespace generated from the resource types ### schedule schedule related commands **Subcommands:** - `schedule push ` - push a local schedule spec. This overrides any remote versions. ### script script related commands **Options:** - `--show-archived` - Enable archived scripts in output **Subcommands:** - `script push ` - push a local script spec. This overrides any remote versions. Use the script file (.ts, .js, .py, .sh - `script show ` - show a scripts content - `script run ` - run a script by path - `-d --data ` - Inputs specified as a JSON string or a file using @ or stdin using @-. - `-s --silent` - Do not output anything other then the final output. Useful for scripting. - `script preview ` - preview a local script without deploying it. Supports both regular and codebase scripts. - `-d --data ` - Inputs specified as a JSON string or a file using @ or stdin using @-. - `-s --silent` - Do not output anything other than the final output. Useful for scripting. - `script bootstrap ` - create a new script - `--summary ` - script summary - `--description ` - script description - `script generate-metadata [script:file]` - re-generate the metadata file updating the lock and the script schema (for flows, use `wmill flow generate-locks` - `--yes` - Skip confirmation prompt - `--dry-run` - Perform a dry run without making changes - `--lock-only` - re-generate only the lock - `--schema-only` - re-generate only script schema - `-i --includes ` - 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 ` - Comma separated patterns to specify which file to NOT take into account. ### sync sync local with a remote workspaces or the opposite (push or pull) **Subcommands:** - `sync pull` - Pull any remote changes and apply them locally. - `--yes` - Pull without needing confirmation - `--dry-run` - Show changes that would be pulled without actually pushing - `--plain-secrets` - Pull secrets as plain text - `--json` - Use JSON instead of YAML - `--skip-variables` - Skip syncing variables (including secrets) - `--skip-secrets` - Skip syncing only secrets variables - `--skip-resources` - Skip syncing resources - `--skip-resource-types` - Skip syncing resource types - `--skip-scripts` - Skip syncing scripts - `--skip-flows` - Skip syncing flows - `--skip-apps` - Skip syncing apps - `--skip-folders` - Skip syncing folders - `--skip-workspace-dependencies` - Skip syncing workspace dependencies - `--skip-scripts-metadata` - Skip syncing scripts metadata, focus solely on logic - `--include-schedules` - Include syncing schedules - `--include-triggers` - Include syncing triggers - `--include-users` - Include syncing users - `--include-groups` - Include syncing groups - `--include-settings` - Include syncing workspace settings - `--include-key` - Include workspace encryption key - `--skip-branch-validation` - Skip git branch validation and prompts - `--json-output` - Output results in JSON format - `-i --includes ` - 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). Overrides wmill.yaml includes - `-e --excludes ` - Comma separated patterns to specify which file to NOT take into account. Overrides wmill.yaml excludes - `--extra-includes ` - 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). Useful to still take wmill.yaml into account and act as a second pattern to satisfy - `--repository ` - Specify repository path (e.g., u\/user\/repo) when multiple repositories exist - `--promotion ` - Use promotionOverrides from the specified branch instead of regular overrides - `--branch ` - Override the current git branch (works even outside a git repository) - `sync push` - Push any local changes and apply them remotely. - `--yes` - Push without needing confirmation - `--dry-run` - Show changes that would be pushed without actually pushing - `--plain-secrets` - Push secrets as plain text - `--json` - Use JSON instead of YAML - `--skip-variables` - Skip syncing variables (including secrets) - `--skip-secrets` - Skip syncing only secrets variables - `--skip-resources` - Skip syncing resources - `--skip-resource-types` - Skip syncing resource types - `--skip-scripts` - Skip syncing scripts - `--skip-flows` - Skip syncing flows - `--skip-apps` - Skip syncing apps - `--skip-folders` - Skip syncing folders - `--skip-workspace-dependencies` - Skip syncing workspace dependencies - `--skip-scripts-metadata` - Skip syncing scripts metadata, focus solely on logic - `--include-schedules` - Include syncing schedules - `--include-triggers` - Include syncing triggers - `--include-users` - Include syncing users - `--include-groups` - Include syncing groups - `--include-settings` - Include syncing workspace settings - `--include-key` - Include workspace encryption key - `--skip-branch-validation` - Skip git branch validation and prompts - `--json-output` - Output results in JSON format - `-i --includes ` - 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 ` - Comma separated patterns to specify which file to NOT take into account. - `--extra-includes ` - 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). Useful to still take wmill.yaml into account and act as a second pattern to satisfy - `--message ` - Include a message that will be added to all scripts\/flows\/apps updated during this push - `--parallel ` - Number of changes to process in parallel - `--repository ` - Specify repository path (e.g., u\/user\/repo) when multiple repositories exist - `--branch ` - Override the current git branch (works even outside a git repository) ### trigger trigger related commands **Subcommands:** - `trigger push ` - push a local trigger spec. This overrides any remote versions. ### user user related commands **Subcommands:** - `user add [password:string]` - Create a user - `--superadmin` - Specify to make the new user superadmin. - `--company ` - Specify to set the company of the new user. - `--name ` - Specify to set the name of the new user. - `user remove ` - Delete a user - `user create-token` - `--email ` - Specify credentials to use for authentication. This will not be stored. It will only be used to exchange for a token with the API server, which will not be stored either. - `--password ` - Specify credentials to use for authentication. This will not be stored. It will only be used to exchange for a token with the API server, which will not be stored either. ### variable variable related commands **Subcommands:** - `variable push ` - Push a local variable spec. This overrides any remote versions. - `--plain-secrets` - Push secrets as plain text - `variable add ` - Create a new variable on the remote. This will update the variable if it already exists. - `--plain-secrets` - Push secrets as plain text - `--public` - Legacy option, use --plain-secrets instead ### version Show version information ### worker-groups display worker groups, pull and push worker groups configs **Subcommands:** - `worker-groups pull` - Pull worker groups (similar to `wmill instance pull --skip-users --skip-settings --skip-groups`) - `--instance` - Name of the instance to push to, override the active instance - `--base-url` - Base url to be passed to the instance settings instead of the local one - `--yes` - Pull without needing confirmation - `worker-groups push` - Push instance settings, users, configs, group and overwrite remote - `--instance [instance]` - Name of the instance to push to, override the active instance - `--base-url [baseUrl]` - If used with --token, will be used as the base url for the instance - `--yes` - Push without needing confirmation ### workers List all workers grouped by worker groups **Options:** - `--instance [instance]` - Name of the instance to push to, override the active instance - `--base-url [baseUrl]` - If used with --token, will be used as the base url for the instance ### workspace workspace related commands **Alias:** `profile` **Subcommands:** - `workspace switch ` - Switch to another workspace - `workspace add [workspace_name:string] [workspace_id:string] [remote:string]` - Add a workspace - `-c --create` - Create the workspace if it does not exist - `--create-workspace-name ` - Specify the workspace name. Ignored if --create is not specified or the workspace already exists. Will default to the workspace id. - `--create-username ` - Specify your own username in the newly created workspace. Ignored if --create is not specified, the workspace already exists or automatic username creation is enabled on the instance. - `workspace remove ` - Remove a workspace - `workspace whoami` - Show the currently active user - `workspace list` - List workspaces on the remote server that you have access to - `workspace bind` - Bind the current Git branch to the active workspace - `--branch ` - Specify branch (defaults to current) - `workspace unbind` - Remove workspace binding from the current Git branch - `--branch ` - Specify branch (defaults to current) - `workspace fork [workspace_name:string] [workspace_id:string]` - Create a forked workspace - `--create-workspace-name ` - Specify the workspace name. Ignored if --create is not specified or the workspace already exists. Will default to the workspace id. - `workspace delete-fork ` - Delete a forked workspace and git branch - `-y --yes` - Skip confirmation prompt