kalugin66/windmill
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
d514b1be5114583917a706e0f2bc33cf62caee65
windmill/system_prompts/auto-generated/cli/cli-commands.md
centdix af200de3c4 feat(ai): standardize and improve system prompts (#7346) 
* init

* test in frontend

* copy files

* use in cli

* better

* add desc to sdks

* better

* fix ts parsing

* add docs to ts client

* add docs to python client

* use script prompt in frontend

* regen

* use in flow

* rm

* use in cli, create AGENTS.md instead of cursor rules

* remove apply

* better

* better

* simplify cli

* more docs

* cleaning

* update readme

* generate cli file

* better folder names

* fix ts

* fix multiline
2025-12-12 17:26:19 +00:00

364 lines
16 KiB
Markdown
Raw Blame History

# Windmill CLI Commands
The Windmill CLI (`wmill`) provides commands for managing scripts, flows, apps, and other resources.
Current version: 1.591.2
## 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
**Subcommands:**
- `app push <file_path:string> <remote_path:string>` - push a local app
- `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
- `--language <language:string>` - Programming language (python3, typescript, go, php). If not specified, will be inferred from file extension.
- `--name <name:string>` - Name for the dependencies. If not specified, creates workspace default dependencies.
### dev
Launch a dev server that will spawn a webserver with HMR
**Options:**
- `--includes <pattern...:string>` - Filter paths givena glob pattern or path
### flow
flow related commands
**Options:**
- `--show-archived` - Enable archived scripts in output
**Subcommands:**
- `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 generate-locks [flow:file]` - re-generate the lock files of all inline scripts of all updated flows
- `--yes` - Skip confirmation prompt
- `-e --excludes <patterns:file[]>` - Comma separated patterns to specify which file to NOT take into account.
- `flow bootstrap <flow_path:string>` - create a new empty flow
- `--summary <summary:string>` - script summary
- `--description <description:string>` - script description
### folder
folder related commands
**Subcommands:**
- `folder push <file_path:string> <remote_path:string>` - 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
- `--replace` - Replace existing settings (non-interactive mode)
- `--diff` - Show differences without applying changes
- `--json-output` - Output in JSON format
- `--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
- `--diff` - Show what would be pushed without applying changes
- `--json-output` - Output in JSON format
- `--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
### jobs
Pull completed and queued jobs from workspace
**Arguments:** `[workspace:string]`
**Options:**
- `-c, --completed-output <file:string>` - Completed jobs output file (default: completed_jobs.json)
- `-q, --queued-output <file:string>` - Queued jobs output file (default: queued_jobs.json)
- `--skip-worker-check` - Skip checking for active workers before export
### 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 <file_path:string> <remote_path:string>` - 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 <file_path:string> <name:string>` - 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 <file_path:string> <remote_path:string>` - 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 <path:file>` - push a local script spec. This overrides any remote versions. Use the script file (.ts, .js, .py, .sh)
- `script show <path:file>` - show a scripts content
- `script run <path:file>` - run a script by path
- `-d --data <data:file>` - 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.
- `script bootstrap <path:file> <language:string>` - create a new script
- `--summary <summary:string>` - script summary
- `--description <description:string>` - 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
- `-e --excludes <patterns:file[]>` - 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
- `-e --excludes <patterns:file[]>` - Comma separated patterns to specify which file to NOT take into account. Overrides wmill.yaml excludes
- `--repository <repo:string>` - Specify repository path (e.g., u/user/repo) when multiple repositories exist
- `--promotion <branch:string>` - Use promotionOverrides from the specified branch instead of regular overrides
- `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
- `-e --excludes <patterns:file[]>` - Comma separated patterns to specify which file to NOT take into account.
- `--message <message:string>` - Include a message that will be added to all scripts/flows/apps updated during this push
- `--parallel <number>` - Number of changes to process in parallel
- `--repository <repo:string>` - Specify repository path (e.g., u/user/repo) when multiple repositories exist
### trigger
trigger related commands
**Subcommands:**
- `trigger push <file_path:string> <remote_path:string>` - push a local trigger spec. This overrides any remote versions.
### user
user related commands
**Subcommands:**
- `user add <email:string> [password:string]` - Create a user
- `--superadmin` - Specify to make the new user superadmin.
- `--company <company:string>` - Specify to set the company of the new user.
- `--name <name:string>` - Specify to set the name of the new user.
- `user remove <email:string>` - Delete a user
- `user create-token`
### variable
variable related commands
**Subcommands:**
- `variable push <file_path:string> <remote_path:string>` - Push a local variable spec. This overrides any remote versions.
- `--plain-secrets` - Push secrets as plain text
- `variable add <value:string> <remote_path:string>` - 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 <workspace_name:string:workspace>` - 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 <workspace_name:string>` - Specify the workspace name. Ignored if --create is not specified or the workspace already exists. Will default to the workspace id.
- `workspace remove <workspace_name:string>` - Remove a workspace
- `workspace whoami` - Show the currently active user
- `workspace bind` - Bind the current Git branch to the active workspace
- `--branch <branch:string>` - Specify branch (defaults to current)
- `workspace unbind` - Remove workspace binding from the current Git branch
- `--branch <branch:string>` - Specify branch (defaults to current)
- `workspace fork [workspace_name:string] [workspace_id:string]` - Create a forked workspace
- `--create-workspace-name <workspace_name:string>` - Specify the workspace name. Ignored if --create is not specified or the workspace already exists. Will default to the workspace id.
- `workspace delete-fork <fork_name:string>` - Delete a forked workspace and git branch
- `-y --yes` - Skip confirmation prompt
Reference in New Issue View Git Blame Copy Permalink