windmill-cli 1.591.3 → 1.592.0

package/esm/gen/core/OpenAPI.js

@@ -32,7 +32,7 @@ export const OpenAPI = {
     PASSWORD: undefined,
     TOKEN: getEnv("WM_TOKEN"),
     USERNAME: undefined,
-    VERSION: '1.591.3',
+    VERSION: '1.592.0',
     WITH_CREDENTIALS: true,
     interceptors: {
         request: new Interceptors(),

package/esm/src/commands/app/app_metadata.js

@@ -8,7 +8,7 @@ import { generateHash, getHeaders, writeIfChanged } from "../../utils/utils.js";
 import { exts } from "../script/script.js";
 import { FSFSElement, yamlOptions } from "../sync/sync.js";
 import { loadRunnablesFromBackend, writeRunnableToBackend, } from "./raw_apps.js";
-import { replaceInlineScripts } from "./apps.js";
+import { replaceInlineScripts } from "./app.js";
 import { newPathAssigner, newRawAppPathAssigner, } from "../../../windmill-utils-internal/src/path-utils/path-assigner.js";
 import { mergeConfigWithConfigFile } from "../../core/conf.js";
 import { resolveWorkspace } from "../../core/context.js";

package/esm/src/commands/app/dev.js

@@ -13,7 +13,7 @@ import * as wmill from "../../../gen/services.gen.js";
 import { resolveWorkspace } from "../../core/context.js";
 import { requireLogin } from "../../core/auth.js";
 import { GLOBAL_CONFIG_OPT } from "../../core/conf.js";
-import { replaceInlineScripts } from "./apps.js";
+import { replaceInlineScripts } from "./app.js";
 import { APP_BACKEND_FOLDER, inferRunnableSchemaFromFile, } from "./app_metadata.js";
 import { loadRunnablesFromBackend } from "./raw_apps.js";
 const DEFAULT_PORT = 4000;

package/esm/src/commands/app/raw_apps.js

@@ -6,7 +6,7 @@ import { colors, log, SEP, windmillUtils, yamlParseFile, yamlStringify, } from "
 import * as wmill from "../../../gen/services.gen.js";
 import path from "node:path";
 import { isSuperset } from "../../types.js";
-import { replaceInlineScripts, repopulateFields } from "./apps.js";
+import { replaceInlineScripts, repopulateFields } from "./app.js";
 import { createBundle, detectFrameworks } from "./bundle.js";
 import { APP_BACKEND_FOLDER } from "./app_metadata.js";
 import { writeIfChanged } from "../../utils/utils.js";

package/esm/src/commands/gitsync-settings/gitsync-settings.js

@@ -1,2 +1,28 @@
-export { pullGitSyncSettings, pushGitSyncSettings } from "./index.js";
-export { default } from "./index.js";
+import { Command } from "../../../deps.js";
+import { pullGitSyncSettings } from "./pull.js";
+import { pushGitSyncSettings } from "./push.js";
+const command = new Command()
+    .description("Manage git-sync settings between local wmill.yaml and Windmill backend")
+    .command("pull")
+    .description("Pull git-sync settings from Windmill backend to local wmill.yaml")
+    .option("--repository <repo:string>", "Specify repository path (e.g., u/user/repo)")
+    .option("--default", "Write settings to top-level defaults instead of overrides")
+    .option("--replace", "Replace existing settings (non-interactive mode)")
+    .option("--override", "Add branch-specific override (non-interactive mode)")
+    .option("--diff", "Show differences without applying changes")
+    .option("--json-output", "Output in JSON format")
+    .option("--with-backend-settings <json:string>", "Use provided JSON settings instead of querying backend (for testing)")
+    .option("--yes", "Skip interactive prompts and use default behavior")
+    .option("--promotion <branch:string>", "Use promotionOverrides from the specified branch instead of regular overrides")
+    .action(pullGitSyncSettings)
+    .command("push")
+    .description("Push git-sync settings from local wmill.yaml to Windmill backend")
+    .option("--repository <repo:string>", "Specify repository path (e.g., u/user/repo)")
+    .option("--diff", "Show what would be pushed without applying changes")
+    .option("--json-output", "Output in JSON format")
+    .option("--with-backend-settings <json:string>", "Use provided JSON settings instead of querying backend (for testing)")
+    .option("--yes", "Skip interactive prompts and use default behavior")
+    .option("--promotion <branch:string>", "Use promotionOverrides from the specified branch instead of regular overrides")
+    .action(pushGitSyncSettings);
+export { pullGitSyncSettings, pushGitSyncSettings };
+export default command;

package/esm/src/commands/init/init.js

@@ -5,6 +5,7 @@ import { SCRIPT_GUIDANCE } from "../../guidance/script_guidance.js";
 import { FLOW_GUIDANCE } from "../../guidance/flow_guidance.js";
 import { getActiveWorkspaceOrFallback } from "../workspace/workspace.js";
 import { generateRTNamespace } from "../resource-type/resource-type.js";
+import { CLI_COMMANDS } from "../../guidance/prompts.js";
 /**
  * Bootstrap a windmill project with a wmill.yaml file
  */
@@ -168,20 +169,10 @@ async function initAction(opts) {
     try {
         const scriptGuidanceContent = SCRIPT_GUIDANCE;
         const flowGuidanceContent = FLOW_GUIDANCE;
-        // Create .cursor/rules directory
-        await dntShim.Deno.mkdir(".cursor/rules", { recursive: true });
-        // Create windmill.mdc file
-        if (!(await dntShim.Deno.stat(".cursor/rules/script.mdc").catch(() => null))) {
-            await dntShim.Deno.writeTextFile(".cursor/rules/script.mdc", scriptGuidanceContent);
-            log.info(colors.green("Created .cursor/rules/script.mdc"));
-        }
-        if (!(await dntShim.Deno.stat(".cursor/rules/flow.mdc").catch(() => null))) {
-            await dntShim.Deno.writeTextFile(".cursor/rules/flow.mdc", flowGuidanceContent);
-            log.info(colors.green("Created .cursor/rules/flow.mdc"));
-        }
-        // Create CLAUDE.md file
-        if (!(await dntShim.Deno.stat("CLAUDE.md").catch(() => null))) {
-            await dntShim.Deno.writeTextFile("CLAUDE.md", `
+        const cliCommandsContent = CLI_COMMANDS;
+        // Create AGENTS.md file
+        if (!(await dntShim.Deno.stat("AGENTS.md").catch(() => null))) {
+            await dntShim.Deno.writeTextFile("AGENTS.md", `
 You are a helpful assistant that can help with Windmill scripts and flows creation.
 
 ## Script Guidance
@@ -189,7 +180,15 @@ ${scriptGuidanceContent}
 
 ## Flow Guidance
 ${flowGuidanceContent}
-                    `);
+
+## CLI Commands
+${cliCommandsContent}
+`);
+            log.info(colors.green("Created AGENTS.md"));
+        }
+        // Create CLAUDE.md file, referencing AGENTS.md
+        if (!(await dntShim.Deno.stat("CLAUDE.md").catch(() => null))) {
+            await dntShim.Deno.writeTextFile("CLAUDE.md", "Instructions are in @AGENTS.md");
             log.info(colors.green("Created CLAUDE.md"));
         }
     }

package/esm/src/commands/sync/sync.js

@@ -18,7 +18,7 @@ import { pushResource } from "../resource/resource.js";
 import { newPathAssigner, newRawAppPathAssigner, } from "../../../windmill-utils-internal/src/path-utils/path-assigner.js";
 import { extractInlineScripts as extractInlineScriptsForFlows } from "../../../windmill-utils-internal/src/inline-scripts/extractor.js";
 import { generateFlowLockInternal } from "../flow/flow_metadata.js";
-import { isExecutionModeAnonymous } from "../app/apps.js";
+import { isExecutionModeAnonymous } from "../app/app.js";
 import { APP_BACKEND_FOLDER, generateAppLocksInternal, } from "../app/app_metadata.js";
 // Merge CLI options with effective settings, preserving CLI flags as overrides
 function mergeCliWithEffectiveOptions(cliOpts, effectiveOpts) {

package/esm/src/core/settings.js

@@ -5,7 +5,7 @@ import * as wmill from "../../gen/services.gen.js";
 import { compareInstanceObjects } from "../commands/instance/instance.js";
 import { isSuperset } from "../types.js";
 import { deepEqual } from "../utils/utils.js";
-import { removeWorkerPrefix } from "../commands/worker-groups/worker_groups.js";
+import { removeWorkerPrefix } from "../commands/worker-groups/worker-groups.js";
 import { decrypt, encrypt } from "../utils/local_encryption.js";
 const INSTANCE_SETTINGS_PATH = "instance_settings.yaml";
 let instanceSettingsPath = INSTANCE_SETTINGS_PATH;

package/esm/src/guidance/flow_guidance.js

@@ -1,434 +1,15 @@
-export const FLOW_GUIDANCE = `
----
-alwaysApply: true
----
-
-# System Prompt: OpenFlow Workflow Generator
-
-You are an expert at creating OpenFlow YAML specifications for Windmill workflows.
+// CLI Flow Guidance - Uses centralized prompts from system_prompts/
+import * as prompts from "./prompts.js";
+// CLI-specific introduction
+const CLI_INTRO = `You are an expert at creating OpenFlow YAML specifications for Windmill workflows.
 OpenFlow is an open standard for defining workflows as directed acyclic graphs where each node represents a computation step.
-When asked to create a flow, ask the user in which folder he wants to put it if not specified. Then create a new folder in the specified folder, that ends with \`.flow\`. It should contain a \`.yaml\` file that contains the flow definition. 
+When asked to create a flow, ask the user in which folder he wants to put it if not specified. Then create a new folder in the specified folder, that ends with \`.flow\`. It should contain a \`.yaml\` file that contains the flow definition.
 For rawscript type module in the flow, the content key should start with "!inline" followed by the path of the script containing the code. It should be put in the same folder as the flow.
 For script type module, path should be the path of the script in the whole repository (not constrained to the flow folder).
-You do not need to create .lock and .yaml files manually. Instead, you should run \`wmill flow generate-locks --yes\` to create them.
-After writing the flow, you can ask the user if he wants to push the flow with \`wmill sync push\`. Both should be run at the root of the repository.
-
-## OpenFlow Structure
-
-Every OpenFlow workflow must follow this root structure:
-
-\`\`\`yaml
-summary: "Brief one-line description"
-description: "Optional detailed description"  
-value:
-  modules: []  # Array of workflow steps
-  # Optional properties:
-  failure_module: {}  # Error handler
-  preprocessor_module: {}  # Runs before first step
-  same_worker: false  # Force same worker execution
-  concurrent_limit: 0  # Limit concurrent executions
-  concurrency_key: "string"  # Custom concurrency grouping
-  concurrency_time_window_s: 0
-  custom_debounce_key: "key"
-  debounce_delay_s: 0
-  skip_expr: "javascript_expression"  # Skip workflow condition
-  cache_ttl: 0  # Cache results duration
-  priority: 0  # Execution priority
-  early_return: "javascript_expression"  # Early termination condition
-schema:  # JSON Schema for workflow inputs
-  type: object
-  properties: {}
-  required: []
-\`\`\`
-
-## Module Types
-
-### 1. RawScript (Inline Code)
-\`\`\`yaml
-id: unique_step_id
-value:
-  type: rawscript
-  content: '!inline inline_script_1.inline_script.ts'
-  language: bun|deno|python3|go|bash|powershell|postgresql|mysql|bigquery|snowflake|mssql|oracledb|graphql|nativets|php
-  input_transforms:
-    param1:
-      type: javascript|static
-      expr: "flow_input.name"  # or for static: value: "fixed_value"
-  # Optional properties:
-  path: "optional/path"
-  lock: "dependency_lock_content"
-  tag: "version_tag"
-  concurrent_limit: 0
-  concurrency_time_window_s: 0
-  custom_concurrency_key: "key"
-  custom_debounce_key: "key"
-  debounce_delay_s: 0
-  is_trigger: false
-  assets: []
-\`\`\`
-
-### 2. PathScript (Reference to Existing Script)
-\`\`\`yaml
-id: step_id
-value:
-  type: script
-  path: "u/user/script_name" # or "f/folder/script_name" or "hub/script_path"
-  input_transforms:
-    param_name:
-      type: javascript
-      expr: "results.previous_step"
-  # Optional:
-  hash: "specific_version_hash"
-  tag_override: "version_tag"
-  is_trigger: false
-\`\`\`
-
-### 3. PathFlow (Sub-workflow)
-\`\`\`yaml
-id: step_id
-value:
-  type: flow
-  path: "f/folder/flow_name"
-  input_transforms:
-    param_name:
-      type: static
-      value: "fixed_value"
-\`\`\`
-
-### 4. ForLoop
-\`\`\`yaml
-id: loop_step
-value:
-  type: forloopflow
-  iterator:
-    type: javascript
-    expr: "flow_input.items"  # Must evaluate to array
-  skip_failures: true|false
-  parallel: true|false  # Run iterations in parallel
-  parallelism: 4  # Max parallel iterations (if parallel: true)
-  modules:
-    - id: loop_body_step
-      value:
-        type: rawscript
-        content: |
-          export async function main(iter: any) {
-            // iter.value contains current item
-            // iter.index contains current index
-            return iter.value;
-          }
-        language: bun
-        input_transforms:
-          iter:
-            type: javascript
-            expr: "flow_input.iter"
-\`\`\`
-
-### 5. WhileLoop
-\`\`\`yaml
-id: while_step
-value:
-  type: whileloopflow
-  skip_failures: false
-  parallel: false
-  parallelism: 1
-  modules:
-    - id: condition_check
-      value:
-        type: rawscript
-        content: |
-          export async function main() {
-            return Math.random() > 0.5; // Continue condition
-          }
-        language: bun
-        input_transforms: {}
-\`\`\`
-
-### 6. Conditional Branch (BranchOne)
-\`\`\`yaml
-id: branch_step
-value:
-  type: branchone
-  branches:
-    - summary: "Condition 1"
-      expr: "results.previous_step > 10"
-      modules:
-        - id: branch1_step
-          value:
-            type: rawscript
-            content: "export async function main() { return 'branch1'; }"
-            language: bun
-            input_transforms: {}
-    - summary: "Condition 2" 
-      expr: "results.previous_step <= 10"
-      modules:
-        - id: branch2_step
-          value:
-            type: rawscript
-            content: "export async function main() { return 'branch2'; }"
-            language: bun
-            input_transforms: {}
-  default:  # Runs if no branch condition matches
-    - id: default_step
-      value:
-        type: rawscript
-        content: "export async function main() { return 'default'; }"
-        language: bun
-        input_transforms: {}
-\`\`\`
-
-### 7. Parallel Branches (BranchAll)
-\`\`\`yaml
-id: parallel_step
-value:
-  type: branchall
-  parallel: true  # Run branches in parallel
-  branches:
-    - summary: "Branch A"
-      skip_failure: false  # Continue if this branch fails
-      modules:
-        - id: branch_a_step
-          value:
-            type: rawscript
-            content: "export async function main() { return 'A'; }"
-            language: bun
-            input_transforms: {}
-    - summary: "Branch B"
-      skip_failure: true
-      modules:
-        - id: branch_b_step
-          value:
-            type: rawscript
-            content: "export async function main() { return 'B'; }"
-            language: bun
-            input_transforms: {}
-\`\`\`
-
-### 8. Identity (Pass-through)
-\`\`\`yaml
-id: identity_step
-value:
-  type: identity
-  flow: false  # Set to true if this represents a sub-flow
-\`\`\`
-
-## Input Transforms & Data Flow
-
-### JavaScript Expressions
-Reference data using these variables in \`expr\` fields:
-- \`flow_input.property_name\` - Access workflow inputs
-- \`results.step_id\` - Access outputs from previous steps  
-- \`results.step_id.property\` - Access specific properties
-- \`flow_input.iter.value\` - Current iteration value (in loops)
-- \`flow_input.iter.index\` - Current iteration index (in loops)
-
-### Static Values
-\`\`\`yaml
-input_transforms:
-  param_name:
-    type: static
-    value: "fixed_string"  # Can be string, number, boolean, object, array
-\`\`\`
-
-### Resource References
-\`\`\`yaml
-input_transforms:
-  database:
-    type: static
-    value: "$res:f/folder/my_database"  # Reference to stored resource
-\`\`\`
-
-## Advanced Module Properties
-
-### Error Handling & Control Flow
-\`\`\`yaml
-id: step_id
-value: # ... module definition
-# Control flow options:
-stop_after_if:
-  expr: "results.step_id.should_stop"
-  skip_if_stopped: true
-  error_message: "Custom stop message"
-stop_after_all_iters_if:  # For loops only
-  expr: "results.step_id.should_stop_loop"
-  skip_if_stopped: false
-skip_if:
-  expr: "results.step_id.should_skip"
-sleep:
-  type: javascript
-  expr: "flow_input.delay_seconds"
-continue_on_error: false  # Continue workflow if this step fails
-delete_after_use: false  # Clean up results after use
-
-# Execution control:
-cache_ttl: 3600  # Cache results for 1 hour
-timeout: 300  # Step timeout in seconds
-priority: 0  # Higher numbers = higher priority
-mock:
-  enabled: false
-  return_value: "mocked_result"
-
-# Suspend/Approval:
-suspend:
-  required_events: 1  # Number of resume events needed
-  timeout: 86400  # Timeout in seconds
-  resume_form:
-    schema:
-      type: object
-      properties:
-        approved:
-          type: boolean
-  user_auth_required: true
-  user_groups_required:
-    type: static
-    value: ["admin"]
-  self_approval_disabled: false
-  hide_cancel: false
-  continue_on_disapprove_timeout: false
-
-# Retry configuration:
-retry:
-  constant:
-    attempts: 3
-    seconds: 5
-  # OR exponential backoff:
-  # exponential:
-  #   attempts: 3
-  #   multiplier: 2
-  #   seconds: 1
-  #   random_factor: 10  # 0-100% jitter
-\`\`\`
-
-## Special Modules
-
-### Failure Handler (Error Handler)
-\`\`\`yaml
-value:
-  failure_module:
-    id: failure
-    value:
-      type: rawscript
-      content: |
-        export async function main(error: any) {
-          // error.message, error.step_id, error.name, error.stack
-          console.log("Flow failed:", error.message);
-          return error;
-        }
-      language: bun
-      input_transforms: {}
-\`\`\`
-
-### Preprocessor 
-\`\`\`yaml
-value:
-  preprocessor_module:
-    id: preprocessor  
-    value:
-      type: rawscript
-      content: |
-        export async function main() {
-          console.log("Flow starting...");
-          return "preprocessed";
-        }
-      language: bun
-      input_transforms: {}
-\`\`\`
-
-## Schema Definition
-\`\`\`yaml
-schema:
-  $schema: "https://json-schema.org/draft/2020-12/schema"
-  type: object
-  properties:
-    name:
-      type: string
-      description: "User name"
-      default: ""
-    email:
-      type: string
-      format: email
-    count:
-      type: integer
-      minimum: 1
-      maximum: 100
-    database:
-      type: object
-      format: "resource-postgresql"  # Resource type reference
-    items:
-      type: array
-      items:
-        type: string
-  required: ["name", "email"]
-  order: ["name", "email", "count"]  # UI field order
-\`\`\`
-
-## Best Practices
-
-1. **Step IDs**: Use descriptive, unique identifiers (alphanumeric + underscores)
-2. **Data Flow**: Chain steps using \`results.step_id\` references
-3. **Error Handling**: Add failure_module for critical workflows
-4. **Languages**: Use \`bun\` for TypeScript (fastest), \`python3\` for Python
-5. **Resources**: Store credentials/configs as resources, reference with \`$res:path\`
-6. **Loops**: Prefer \`parallel: true\` for independent iterations
-7. **Branching**: Use \`branchone\` for if/else logic, \`branchall\` for parallel processing
-8. **Schemas**: Always define input schemas for better UX and validation
-
-## Example Complete Workflow
-\`\`\`yaml
-summary: "Process user data"
-description: "Validates user input, processes data, and sends notifications"
-value:
-  modules:
-    - id: validate_input
-      value:
-        type: rawscript
-        content: '!inline inline_script_0.inline_script.ts'
-        # script at path inline_script_0.inline_script.ts will contain
-        #   export async function main(email: string, name: string) {
-        #     if (!email.includes('@')) throw new Error('Invalid email');
-        #     return { email, name, valid: true };
-        #   }
-        language: bun
-        input_transforms:
-          email:
-            type: javascript
-            expr: "flow_input.email"
-          name:
-            type: javascript  
-            expr: "flow_input.name"
-    - id: process_data
-      value:
-        type: script
-        path: "f/shared/data_processor"
-        input_transforms:
-          user_data:
-            type: javascript
-            expr: "results.validate_input"
-    - id: send_notification
-      value:
-        type: rawscript
-        content: '!inline inline_script_1.inline_script.ts'
-        # script at path inline_script_1.inline_script.ts will contain
-        #   export async function main(processed_data: any) {
-        #     console.log("Sending notification for:", processed_data.name);
-        #     return "notification_sent";
-        #   }
-        language: bun
-        input_transforms:
-          processed_data:
-            type: javascript
-            expr: "results.process_data"
-schema:
-  type: object
-  properties:
-    email:
-      type: string
-      format: email
-      description: "User email address"
-    name:
-      type: string
-      description: "User full name"
-  required: ["email", "name"]
-\`\`\`
+You do not need to create .lock and .yaml files manually. Instead, you should run \`wmill flow generate-locks --yes\` to create them.`;
+// Assemble complete flow guidance
+export const FLOW_GUIDANCE = `
+${CLI_INTRO}
 
-When generating OpenFlow YAML, ensure proper indentation, valid YAML syntax, and logical step dependencies. Always include meaningful summaries and proper input transforms to connect workflow steps.
+${prompts.FLOW_PROMPT}
 `;